Quick Start: Deploying to Fly.io
Support for Fly.io is in a preliminary phase.
django-simple-deploy should only be used on test projects at this point.
Deployment to Fly.io can be fully automated, but the configuration-only approach is recommended. This allows you to review the changes that are made to your project before committing them and making the initial push. The fully automated approach configures your project, commits these changes, and pushes the project to Fly.io's servers.
Deployment to Fly.io requires three things:
- You must be using Git to track your project.
- You need to be tracking your dependencies with a
requirements.txtfile, or be using Poetry or Pipenv.
- The Fly.io CLI must be installed on your system.
django-simple-deploy and add
INSTALLED_APPS in settings.py:
Now create a new Fly.io app using the CLI, and run
simple_deploy to configure your app:
flyctl commands are used on the Fly.io docs interchangeably. They are standardizing on
fly, so that's what we'll be using here.
simple_deploy will ask you if it's found the correct app to deploy to. It will then create a database and link it to the app you just created. After that, it will configure your project for deployment. At this point, you should review the changes that were made to your project. Running
git status will show you which files were modified, and which files were created for a successful deployment.
If you want to continue with the deployment process, commit these changes and run the
deploy command; the initial migration is done automatically. When deployment is complete, use the
open command to see the deployed version of your project:
You can find a record of the deployment process in
simple_deploy_logs. It contains most of the output you saw when running
If you want, you can automate this entire process. This involves just three steps:
You should see a bunch of output as Fly.io resources are created for you, your project is configured for deployment, and
simple_deploy pushes your project to Fly.io's servers. When everything's complete, your project should open in a new browser tab.
Pushing further changes
After the initial deployment, you're almost certainly going to make further changes to your project. When you've updated your project and it works locally, you can commit these changes and push your project again, without using
Running management commands
To run management commands such as
migrate against the deployed project, use the
ssh command to log into a console on the remote server:
If deployment doesn't work, feel free to open an issue. Please share the OS you're using locally, and the specific error message or unexpected behavior you saw. If the project you're deploying is hosted in a public repository, please share that as well.
Please remember that
django-simple-deploy is in a preliminary state. That said, I'd love to know the specific issues people are running into so we can reach a 1.0 state in a reasonable time frame.