Because the app is modeled with the Twelve-Factor app architecture, all configs are stored in the environment.
When executing mix command, you should always make sure that the required system env are present.
You can use source, nv or a custom l33t bash script.
Every following steps assume you have this kind of system.
- Create your .env and .env.test config file.
- Install dependencies with
mix deps.get. - Create and migrate your database with
mix ecto.setup - Start Phoenix endpoint with
mix phx.server
The application needs the following environment variables:
PORT=
CANONICAL_HOST=
# Secret key. You can use `mix phx.gen.secret` to get one or use any secret string you want
SECRET_KEY_BASE=
SESSION_KEY=
# Url of the database
DATABASE_URL=
# Pool size of the DB connections. You may use 20 connections as a starting point.
DATABASE_POOL_SIZE=
It also supports these optional environment variables:
FORCE_SSL=
BASIC_AUTH_USERNAME=
BASIC_AUTH_PASSWORD=
Use: mix credo --strict