Skip to content

Commit 3af701e

Browse files
authored
chore(docs): add railway self hosting instructions (#2496)
* add docs for self hosting on Railway * improve clarity * Update self-host-on-railway.mdx
1 parent 5f9dc60 commit 3af701e

File tree

6 files changed

+51
-1
lines changed

6 files changed

+51
-1
lines changed
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
title: "Self Host on Railway"
3+
---
4+
5+
This guide will show you how to set up digger on [Railway](https://railway.com).
6+
7+
This is a specific case of [Deploy as docker image](./deploy-docker).
8+
9+
![](/images/self-host/railway/canvas.png)
10+
11+
1. Use the following template. It will create the Digger + PostgreSQL services and prepopulate many of the necessary environment variables.
12+
13+
[![Deploy on Railway](https://railway.com/button.svg)](https://railway.com/deploy/VByV1N?referralCode=P06La2)
14+
15+
📢 DISCLOSURE: This template was created by [@sidpalas](https://github.com/sidpalas). He will recieve a (small) payment if you use it from the [Railway template kickback program](https://railway.com/open-source-kickback).
16+
17+
2. Set your GitHub organization name (or username, if the repo you plan to use belongs to an individual user).
18+
19+
![](/images/self-host/railway/set-github-org.png)
20+
21+
3. Deploy.
22+
23+
4. Navigate to the pubilc domain for the Digger service (`Settings > Public Networking`).
24+
25+
![](/images/self-host/railway/digger-live.png)
26+
27+
5. Create the GitHub App
28+
29+
Navigate to `your_digger_hostname/github/setup` and sign in with the `HTTP_BASIC_AUTH_USERNAME` and `HTTP_BASIC_AUTH_PASSWORD` values.
30+
31+
These are geneated automatically by Railway when performing the initial deployment and can be retrieved from the `Variables` tab for the Digger service.
32+
33+
![](/images/self-host/railway/github-app-setup.png)
34+
35+
6. After creating the GitHub app, copy the provided values into their corresponding environment variables (overwriting the placeholder `REPLACE_ME_AFTER_GH_APP_CREATION` values):
36+
37+
```bash
38+
GITHUB_APP_ID=
39+
GITHUB_APP_CLIENT_ID=
40+
GITHUB_APP_CLIENT_SECRET=
41+
GITHUB_APP_PRIVATE_KEY_BASE64=
42+
GITHUB_WEBHOOK_SECRET=
43+
```
44+
45+
💡 **Tip:** When copying base64 values (e.g. the app key file), double clicking the text often does NOT select any trailing `=` characters. Make sure to copy them too!
46+
47+
7. Redeploy.
48+
49+
8. Create a PR to verify Digger is working properly.

docs/docs.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,8 @@
129129
"ce/self-host/deploy-docker-compose",
130130
"ce/self-host/deploy-binary",
131131
"ce/self-host/deploy-helm",
132-
"ce/self-host/self-host-on-azure"
132+
"ce/self-host/self-host-on-azure",
133+
"ce/self-host/self-host-on-railway"
133134
]
134135
},
135136
{
220 KB
Loading
7.81 KB
Loading
229 KB
Loading
37.8 KB
Loading

0 commit comments

Comments
 (0)