dsd-railway 0.1.3

A plugin for django-simple-deploy, supporting deployments to Railway.

dsd-railway

A plugin for deploying Django projects to Railway, using django-simple-deploy.

For full documentation, see the documentation for django-simple-deploy.

Current status

This plugin is in a pre-1.0 development phase. It has limited functionality at the moment, but should evolve quickly.

Configuration-only deployment

• Install the Railway CLI
• Choose a name for your deployed project, and use it everywhere you see <project-name> Run the following commands:

$ railway login # May need to use `railway login --browserless`
$ pip install dsd-railway
# Add `django_simple_deploy` to `INSTALLED_APPS`
$ python manage.py deploy --deployed-project-name <project-name>
$ git status
# Review changes
$ git add .
$ git commit -m "Configured for deployment to Railway."

• Run the following. (You'll see a bunch of errors after railway up. Those errors will go away after creating the database. This is Railway's recommended approach!)

$ railway init --name <project-name>
$ railway up
$ railway add --database postgres
$ railway variables \
    --set 'PGDATABASE=${{Postgres.PGDATABASE}}' \
    --set 'PGUSER=${{Postgres.PGUSER}}' \
    --set 'PGPASSWORD=${{Postgres.PGPASSWORD}}' \
    --set 'PGHOST=${{Postgres.PGHOST}}' \
    --set 'PGPORT=${{Postgres.PGPORT}}' \
    --service <project-name>
$ railway domain --port 8080 --service <project-name>

After this last command, you should see the URL for your project. You may need to wait a few minutes for the deployment to finish.

If your deployment does not seem to work, you can try redeploying it:

$ railway redeploy --service <project-name>

Fully automated deployment

• Install the Railway CLI
• Log in, using railway login. You may need to run railway login --browserless.
• Install dsd-railway: pip install dsd-railway
• Add django_simple_deploy to INSTALLED_APPS
• Run python manage.py deploy --automate-all.

Your deployed project should appear in a new browser tab.

Destroying a project

This is mostly for developers, but if you're trying this out and want to destroy a project the following should work:

$ export RAILWAY_API_TOKEN=<account-token>
$ python developer_resources/destroy_project.py <project-id>

Be careful running this command, as it is an immediately destructive action. If you want to be more cautious, you can delete the project in your Railway dashboard. Railway schedules the project for deletion in the next 48 hours, giving you some possibility of restoring the project if you need to.

If you don't know the ID of your project, you can run railway status --json. The ID will the first item in the JSON output.