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

An unofficial Misskey template for Railway
https://github.com/mkizka/misskey-railway-template

activitypub fediverse misskey railway

Last synced: 3 days ago
JSON representation

An unofficial Misskey template for Railway

• Host: GitHub
• URL: https://github.com/mkizka/misskey-railway-template
• Owner: mkizka
• License: agpl-3.0
• Created: 2024-01-06T04:21:42.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-09-22T06:09:39.000Z (6 days ago)
• Last Synced: 2024-09-24T22:28:37.453Z (3 days ago)
• Topics: activitypub, fediverse, misskey, railway
• Language: JavaScript
• Homepage: https://railway.app/template/8bBGvg?referralCode=mveF9L
• Size: 12.8 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

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

# misskey-railway-template

This is a template for deploying Misskey on [Railway](https://railway.app).

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

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

## How to Use

### 1. Click on 'Deploy on Railway'

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

### 2. Set Environment Variables

![](images/setup1.png)

Set the environment variables as needed. If there is nothing you want to change, you don't need to do anything.

For those who want to change settings

Misskey uses a yml file for configuration, but this template allows the use of environment variables with a custom Docker image.

In this Docker image, a yml file is generated at container startup based on the environment variables prefixed with `MISSKEY`.

Example:

```

MISSKEY__DB__USER=db-user

MISSKEY__DB__PASS=db-pass

```

↓

```yml

db:

  user: db-user

  pass: db-pass

```

For detailed rules of the conversion, refer to [read-env's README](https://github.com/yatki/read-env), and for more information on each setting of Misskey, refer to [Misskey's .config/example.yml](https://github.com/misskey-dev/misskey/blob/9eae82de1d4f9157602451e26e734c8f4ae94bea/.config/example.yml).

### 3. Click 'Deploy'

Deployment starts.

### 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".

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

### 5. A Few Minutes Later, Click on the 'Misskey' Service and Access the URL

The URL will be displayed in the 'Deployments' section as shown below.

![](images/setup2.png)

That's it!

![](images/setup3.png)

## 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 Misskey, please do not change the domain.

- Uploaded images are stored in the mounted volume. The volume capacity is 5GB, so it is recommended to set up S3 or similar from the start if needed.

- Railway charges based on usage, so please do not increase your followers excessively. [You can also set limits on usage from the settings.](https://docs.railway.app/reference/usage-limits)

## Icon

The icon is copied from [misskey-dev/assets](https://github.com/misskey-dev/assets/blob/81499387376c00cf7d287a179d15ba2988b5c7eb/public/icon.png).