Introduction to Deployment
Once we have a working application, we're ready to deploy it. If you're not quite finished with your own application, don't worry. Just follow the Up and Running Guide to create a basic application to work with.
When preparing an application for deployment, there are three main steps:
- Handling of your application secrets
- Compiling your application assets
- Starting your server in production
In this guide, we will learn how to get the production environment running locally. You can use the same techniques in this guide to run your application in production, but depending on your deployment infrastructure, extra steps will be necessary.
As an example of deploying to other infrastructures, we also discuss three different approaches in our guides: using Elixir's releases with
mix release, using Gigalixir, and using Heroku. We've also included links to deploying Phoenix on other platforms under Community Deployment Guides. Finally, the release guide has a sample Dockerfile you can use if you prefer to deploy with container technologies.
Let's explore those steps above one by one.
All Phoenix applications have data that must be kept secure, for example, the username and password for your production database, and the secret Phoenix uses to sign and encrypt important information. The general recommendation is to keep those in environment variables and load them into your application. This is done in
config/releases.exs), which is responsible for loading secrets and configuration from environment variables.
Therefore, you need to make sure the proper relevant variables are set in production:
$ mix phx.gen.secret REALLY_LONG_SECRET $ export SECRET_KEY_BASE=REALLY_LONG_SECRET $ export DATABASE_URL=ecto://USER:PASS@HOST/database
Do not copy those values directly, set
SECRET_KEY_BASE according to the result of
mix phx.gen.secret and
DATABASE_URL according to your database address.
If for some reason you do not want to rely on environment variables, you can hard code the secrets in your
config/releases.exs), but make sure not to check the file into your version control system.
With your secret information properly secured, it is time to configure assets!
Before taking this step, we need to do one bit of preparation. Since we will be readying everything for production, we need to do some setup in that environment by getting our dependencies and compiling.
$ mix deps.get --only prod $ MIX_ENV=prod mix compile
esbuild but everything is encapsulated in a single
mix assets.deploy task defined in your
$ MIX_ENV=prod mix assets.deploy Check your digested files at "priv/static".
And that is it! The Mix task by default builds the assets and then generates digests with a cache manifest file so Phoenix can quickly serve assets in production.
Note: if you run the task above in your local machine, it will generate many digested assets in
priv/static. You can prune them by running
mix phx.digest.clean --all.
Keep in mind that, if you by any chance forget to run the steps above, Phoenix will show an error message:
$ PORT=4001 MIX_ENV=prod mix phx.server 10:50:18.732 [info] Running MyAppWeb.Endpoint with Cowboy on http://example.com 10:50:18.735 [error] Could not find static manifest at "my_app/_build/prod/lib/foo/priv/static/cache_manifest.json". Run "mix phx.digest" after building your static files or remove the configuration from "config/prod.exs".
The error message is quite clear: it says Phoenix could not find a static manifest. Just run the commands above to fix it or, if you are not serving or don't care about assets at all, you can just remove the
cache_static_manifest configuration from
To run Phoenix in production, we need to set the
MIX_ENV environment variables when invoking
$ PORT=4001 MIX_ENV=prod mix phx.server 10:59:19.136 [info] Running MyAppWeb.Endpoint with Cowboy on http://example.com
To run in detached mode so that the Phoenix server does not stop and continues to run even if you close the terminal:
$ PORT=4001 MIX_ENV=prod elixir --erl "-detached" -S mix phx.server
In case you get an error message, please read it carefully, and open up a bug report if it is still not clear how to address it.
You can also run your application inside an interactive shell:
$ PORT=4001 MIX_ENV=prod iex -S mix phx.server 10:59:19.136 [info] Running MyAppWeb.Endpoint with Cowboy on http://example.com
The previous sections give an overview about the main steps required to deploy your Phoenix application. In practice, you will end-up adding steps of your own as well. For example, if you are using a database, you will also want to run
mix ecto.migrate before starting the server to ensure your database is up to date.
Overall, here is a script you can use as a starting point:
# Initial setup $ mix deps.get --only prod $ MIX_ENV=prod mix compile # Compile assets $ MIX_ENV=prod mix assets.deploy # Custom tasks (like DB migrations) $ MIX_ENV=prod mix ecto.migrate # Finally run the server $ PORT=4001 MIX_ENV=prod mix phx.server
And that's it. Next you can use one of our official guides to deploy:
- with Elixir's releases
- to Gigalixir, an Elixir-centric Platform as a Service (PaaS)
- to Fly.io, a PaaS that deploys your servers close to your users with built-in distribution support
- and to Heroku, one of the most popular PaaS.