mkizka / misskey-railway-template Goto Github PK

View Code? Open in Web Editor NEW

2.0 1.0 0.0 13.1 MB

An unofficial Misskey template for Railway

Home Page: https://railway.app/template/8bBGvg?referralCode=mveF9L

License: GNU Affero General Public License v3.0

JavaScript 51.47% Dockerfile 48.53%

activitypub fediverse misskey railway

misskey-railway-template's Introduction

English | 日本語

misskey-railway-template

This is a template for deploying Misskey on Railway.

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

How to Use

1. Click on 'Deploy on Railway'

2. Set Environment Variables

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

↓

db:
  user: db-user
  pass: db-pass

For detailed rules of the conversion, refer to read-env's README, and for more information on each setting of Misskey, refer to Misskey's .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.

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

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.

That's it!

Troubleshooting

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.

Icon

The icon is copied from misskey-dev/assets.

misskey-railway-template's People

Contributors

Stargazers

Watchers

misskey-railway-template's Issues

[bug] Killed after "Starting 1 worker..."

Thanks for creating this template!

After DB setup, it crashes trying to start a worker. This is on a fresh deploy, everything left at default values.

[WARN  tini (7)] Tini is not running as PID 1 and isn't registered as a child subreaper.
Zombie processes will not be re-parented to Tini, so zombie reaping won't work.
To fix the problem, use the -s option or set the environment variable TINI_SUBREAPER to register Tini as a child subreaper, or run Tini as PID 1.
> [email protected] migrateandstart /misskey

...snip

query: INSERT INTO "migrations"("timestamp", "name") VALUES ($1, $2) -- PARAMETERS: [1679651580149,"cleanup1679651580149"]
Migration cleanup1679651580149 has been  executed successfully.
query: ALTER TABLE "meta" ADD "enableChartsForFederatedInstances" boolean NOT NULL DEFAULT true
> [email protected] start /misskey
> pnpm check:connect && cd packages/backend && node ./built/boot/entry.js
> [email protected] check:connect /misskey
> cd packages/backend && pnpm check:connect
> backend@ check:connect /misskey/packages/backend
> node ./check_connect.js
_____ _         _
|     |_|___ ___| |_ ___ _ _
| | | | |_ -|_ -| '_| -_| | |
|_|_|_|_|___|___|_,_|___|_  |
v2023.12.2              |___|
Misskey is an open-source decentralized microblogging platform.
If you like Misskey, please donate to support development. https://www.patreon.com/syuilo
--- railway (PID: 253) ---
INFO *	[core boot]	Welcome to Misskey!
INFO *	[core boot]	Misskey v2023.12.2
INFO *	[core boot env]	NODE_ENV: production
INFO *	[core boot nodejs]	Version v20.10.0 detected.
DONE *	[core boot config]	Loaded
DONE *	[core boot]	Misskey initialized
INFO *	[core nest]	NestFactory: Starting Nest application...
INFO *	[core nest]	InstanceLoader: MainModule dependencies initialized
INFO *	[core nest]	InstanceLoader: QueueModule dependencies initialized
INFO *	[core nest]	InstanceLoader: GlobalModule dependencies initialized
INFO *	[core nest]	InstanceLoader: RepositoryModule dependencies initialized
INFO *	[core nest]	InstanceLoader: DaemonModule dependencies initialized
INFO *	[core nest]	InstanceLoader: ServerModule dependencies initialized
INFO *	[core nest]	InstanceLoader: EndpointsModule dependencies initialized
INFO *	[core nest]	InstanceLoader: CoreModule dependencies initialized
INFO *	[core boot]	Starting 1 worker...
Killed
ELIFECYCLE  Command failed with exit code 137.
ELIFECYCLE  Command failed with exit code 1.

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

This repository currently has no open or pending branches.

Detected dependencies

docker-compose

compose.yaml

postgres 16-alpine

redis 7-alpine

dockerfile

Dockerfile

node 20.17.0-slim

github-actions

.github/workflows/deploy.yml

actions/checkout v4

docker/login-action v3

docker/setup-buildx-action v3

docker/metadata-action v5

docker/build-push-action v6

.github/workflows/pr.yml

actions/checkout v4

npm

package.json

esbuild 0.24.0

js-yaml 4.1.0

read-env 2.0.0

regex

.github/workflows/deploy.yml

misskey/misskey 2024.8.0

compose.yaml

misskey/misskey 2024.8.0

Check this box to trigger a request for Renovate to run again on this repository

Wonderfull template! I only have one small suggestion.
On the Misskey service, you have a MISSKEY__URL variable but opted not to set https://${{RAILWAY_PUBLIC_DOMAIN}} as its default value.
Maybe you thought that variable would only render out to the Railway-provided domain?

If a custom domain is set on the service, that variable will render out to the custom domain, otherwise, it will render out to the railway domain.

So in my opinion you should set that value as the default value.

oh and if you feel like it? give the template an applicable logo.