Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add install docs for Railway.app #272

Closed
wants to merge 10 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs-sidebar.js
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ const sidebars = {
type: 'category',
label: 'In the Cloud',
collapsible: false,
items: ['install/pikapods', 'install/fly'],
items: ['install/pikapods', 'install/fly', 'install/railway'],
},
],
},
Expand Down
26 changes: 26 additions & 0 deletions docs/install/railway.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
title: 'Railway'
---

Deploying Actual on Railway is a cheap ($5/month), no-code solution that can be done completely through a dashboard.

## Setup

### Creating an account

If you don't already have a Railway account, visit [railway.app](https://railway.app/) and click `Log in`. Either sign in with GitHub or enter the email address you'd like to create an account for and follow the prompts.


### Installation

From your [Railway dashboard](https://railway.app/dashboard), click `New project` and select `Empty project`.

Click `Add a service`, then select `Docker image`. Enter Actual server's docker image, `actualbudget/actual-server:latest`. Your Actual server will immediately start deploying.

Click `New`, then `volume`. Follow the prompts. There should only be one available service to attach the volume to, and enter `/data` as the mount point.

Click on your service. By default it will have a random name like `future-rock`. In the `variables` tab, create a new variable called `PORT`. Give it a value of `443` for HTTPS (Railway will handle the cert for you).

Then in the `settings` tab, click `Generate Domain` if you'd like Railway to create a subdomain for you, otherwise click `Custom Domain` and follow the prompts to add a CNAME record to your domain.

That's it! Your Actual server will be running on whatever domain you chose, ready for first-time setup.
Loading