https://github.com/mkizka/mastodon-railway-template

An unofficial Mastodon template for Railway
https://github.com/mkizka/mastodon-railway-template

activitypub fediverse mastodon railway

Last synced: 3 months ago
JSON representation

An unofficial Mastodon template for Railway

• Host: GitHub
• URL: https://github.com/mkizka/mastodon-railway-template
• Owner: mkizka
• License: agpl-3.0
• Created: 2024-01-03T06:15:05.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-08-19T11:06:18.000Z (4 months ago)
• Last Synced: 2024-09-26T20:43:54.620Z (3 months ago)
• Topics: activitypub, fediverse, mastodon, railway
• Language: Shell
• Homepage: https://railway.app/template/Pa4Fcc?referralCode=mveF9L
• Size: 2.44 MB
• Stars: 5
• Watchers: 1
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[English](./README.md) | [日本語](./README_ja.md)

# mastodon-railway-template

A template for deploying Mastodon on [Railway](https://railway.app).

**Note: This template only works with the Hobby plan or higher.**

![](./images/deploy.gif)

## Usage

### 1. Click on "Deploy on Railway"

[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/Pa4Fcc?referralCode=mveF9L)

### 2. Click "Configure" for each service and set the environment variables

![](images/step2.png)

You must click "Save Config" for all settings. Below are the instructions for configuring each service.

#### Mastodon-Streaming

No need to edit as it syncs with Mastodon's environment variables.

#### Mastodon

| Variable Name | Description | Default |

| --- | --- | --- |

| OWNER_USERNAME | Specify the username for the admin account to be created at startup. | |

| OWNER_EMAIL | Specify the email address for the admin account to be created at startup. It won't be used until the mail server is set up. | |

No other settings need to be edited.

For more details on each setting, refer to the [official documentation](https://docs.joinmastodon.org/admin/config/).

### 3. Click "Deploy" after completing the settings

You can deploy when everything is marked as "Ready to be deployed" as shown in the image below.

![](images/step3.png)

### 4. Set Up a Domain (Optional)

You can set up a domain from the "Settings". You can use a free domain from Railway, or your own custom domain. 

![](images/setup4.png)

After setting the domain, be sure to click "Redeploy".

Note: If you change the domain of Mastodon-Streaming, make sure to change it before changing Mastodon. Then, redeploy both in the order you changed them.

![](images/setup4-2.png)

### 5. A few minutes later, click on the "Mastodon" service and access the URL

The URL can be found under "Deployments" as shown below.

![](images/step5.png)

That's it!

![](images/step5-2.png)

### 6. Sign in to the Owner Account

You can search for the service's execution logs in "Observability" at the top of the project screen.

By searching for "New Password", you can find the password for the Owner account created at the start of Mastodon.

![](images/signin.png)

You can use this password and email address to log in to the admin account from the login screen.

## Troubleshooting

![](images/trouble.png)

You may encounter a message like this.

- Try waiting a bit and then reload

- Redeploy

These actions can sometimes resolve the issue.

## ⚠️⚠️Caution⚠️⚠️

- After starting to use Mastodon, please do not change the domain.

- Uploaded images are saved on a mounted volume with a capacity of 5GB. It is advisable to set up S3 or similar from the start if needed.

- Railway charges based on usage, so please avoid increasing follows excessively. [You can also set usage limits in the settings.](https://docs.railway.app/reference/usage-limits)