Skip to content

Commit 92a8ca6

Browse files
authored
Add atlas migration step to self-hosted binary docs (#1389)
1 parent 8342c4e commit 92a8ca6

File tree

1 file changed

+26
-3
lines changed

1 file changed

+26
-3
lines changed

docs/self-host/deploy-binary.mdx

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,31 @@ Digger has 2 main components: the CLI that runs within your CI and an orchestrat
77
This guide describes self-hosting the orchestrator backend as a binary aka "roll your own". Self-hosting may come handy when using the cloud-based version of it is not an option (for example due to compliance requirements). More guides (docker, EC2, etc) are coming soon.
88

99
<Note>
10-
This guide is about self-hosting Digger Community Edition which is free and open source (Apache 2.0 license) ([repo on GitHub](https://github.com/diggerhq/digger)). You do not need a license or an account on Digger Cloud to self-host Digger CE. If you require enterprise-grade features like Github Enterprise Server support, SSO / SAML, multi-team / multi-org - [Talk to us](https://calendly.com/diggerdev/digger-open-source-terraform-cloud-alternativ-clone)
10+
This guide is about self-hosting Digger Community Edition which is free and
11+
open source (Apache 2.0 license) ([repo on
12+
GitHub](https://github.com/diggerhq/digger)). You do not need a license or an
13+
account on Digger Cloud to self-host Digger CE. If you require
14+
enterprise-grade features like Github Enterprise Server support, SSO / SAML,
15+
multi-team / multi-org - [Talk to
16+
us](https://calendly.com/diggerdev/digger-open-source-terraform-cloud-alternativ-clone)
1117
</Note>
1218

1319
# Prerequisites
20+
21+
- Cloned repository of Digger
22+
- AtlasGo [CLI](https://atlasgo.io/getting-started)
1423
- Postgres database (e.g. RDS)
1524
- Rights to install GitHub apps in your organisation
1625

1726
# Download Digger API binary
1827

19-
Get it from [releases](https://github.com/diggerhq/digger/releases/). Note that it's a separate binary, not to be confused the CLI agent that runs in the CI job.
28+
Get it from [releases](https://github.com/diggerhq/digger/releases/). Note that it's a separate binary, not to be confused the CLI agent that runs in the CI job.
29+
30+
# Clone the Digger Repository
31+
32+
```
33+
git clone https://github.com/diggerhq/digger.git
34+
```
2035

2136
# Set initial environment variables
2237

@@ -34,9 +49,16 @@ ALLOW_DIRTY=false # set to true if the database has already a schema configured
3449
# Start the service
3550

3651
```
52+
cd digger/backend
53+
wget https://github.com/diggerhq/digger/releases/download/v<DIGGER_VERSION>/digger-api-<OS>-<CPU_ARCH> -C ./diggerapi
54+
chmod +x ./diggerapi
55+
atlas migrate apply --url $DATABASE_URL --allow-dirty
3756
./diggerapi
3857
```
39-
You should now see initial database migrations and tables being created. Go to your_digger_hostname:3000/projects; you should see the dashboard. The setup is not complete yet!
58+
59+
Note: depending on the OS security settings you may need to allow the binary to run.
60+
61+
Go to your_digger_hostname:3000/projects; you should see the dashboard. The setup is not complete yet!
4062

4163
# Create GitHub app
4264

@@ -59,6 +81,7 @@ GITHUB_WEBHOOK_SECRET=
5981
On the exchange-code page (see above) click the installation link at the top and select the repositories.
6082

6183
From here on it's the same steps as in the [Quickstart](https://docs.digger.dev/getting-started/github-actions-+-aws):
84+
6285
- Create digger.yml
6386
- Create workflow file
6487
- Create secrets

0 commit comments

Comments
 (0)