When you first create an Epic Stack repo, it should take you through a series of questions to get your app setup and deployed. However, we'll document the steps here in case things don't go well for you or you decide to do it manually later. Here they are!
Prior to your first deployment, you'll need to do a few things:
Note: Try
flyctl
instead offly
if the commands below won't work.
Sign up and log in to Fly:
fly auth signup
Note: If you have more than one Fly account, ensure that you are signed into the same account in the Fly CLI as you are in the browser. In your terminal, run
fly auth whoami
and ensure the email matches the Fly account signed into the browser.
Create two apps on Fly, one for staging and one for production:
fly apps create [YOUR_APP_NAME]
fly apps create [YOUR_APP_NAME]-staging
Note: Make sure this name matches the
app
set in yourfly.toml
file. Otherwise, you will not be able to deploy.
Initialize Git.
git init
Create a new GitHub Repository, and then add it as the remote for your project. Do not push your app yet!
git remote add origin <ORIGIN_URL>
Add a FLY_API_TOKEN
to your GitHub repo. To do this, go to your user
settings on Fly and create a new
token, then add it to
your repo secrets
with the name FLY_API_TOKEN
.
Add a SESSION_SECRET
, INTERNAL_COMMAND_TOKEN
, and HONEYPOT_SECRET
to
your fly app secrets, to do this you can run the following commands:
fly secrets set SESSION_SECRET=$(openssl rand -hex 32) INTERNAL_COMMAND_TOKEN=$(openssl rand -hex 32) HONEYPOT_SECRET=$(openssl rand -hex 32) --app [YOUR_APP_NAME]
fly secrets set SESSION_SECRET=$(openssl rand -hex 32) INTERNAL_COMMAND_TOKEN=$(openssl rand -hex 32) HONEYPOT_SECRET=$(openssl rand -hex 32) --app [YOUR_APP_NAME]-staging
Note: If you don't have openssl installed, you can also use 1Password to generate a random secret, just replace
$(openssl rand -hex 32)
with the generated secret.
Create production database:
Create a persistent volume for the sqlite database for both your staging and
production environments. Run the following (feel free to change the GB size
based on your needs and the region of your choice
(https://fly.io/docs/reference/regions/
). If you do change the region, make
sure you change the primary_region
in fly.toml as well):
fly volumes create data --region sjc --size 1 --app [YOUR_APP_NAME]
fly volumes create data --region sjc --size 1 --app [YOUR_APP_NAME]-staging
Attach Consul:
Consul is a fly-managed service that manages your primary instance for data replication (learn more about configuring consul).
fly consul attach --app [YOUR_APP_NAME]
fly consul attach --app [YOUR_APP_NAME]-staging
Commit!
The Epic Stack comes with a GitHub Action that handles automatically deploying your app to production and staging environments.
Now that everything is set up you can commit and push your changes to your
repo. Every commit to your main
branch will trigger a deployment to your
production environment, and every commit to your dev
branch will trigger a
deployment to your staging environment.
Find instructions for this optional step in the email docs.
Find instructions for this optional step in the error tracking docs.
Find instructions for this optional step in the database docs.
Find instructions for this optional step in the database docs.
If you'd like to deploy locally you definitely can. You need to (temporarily)
move the Dockerfile
and the .dockerignore
to the root of the project first.
Then you can run the deploy command:
mv ./other/Dockerfile Dockerfile
mv ./other/.dockerignore .dockerignore
fly deploy
Once it's done, move the files back:
mv Dockerfile ./other/Dockerfile
mv .dockerignore ./other/.dockerignore
You can keep the Dockerfile
and .dockerignore
in the root if you prefer,
just make sure to remove the move step from the .github/workflows/deploy.yml
.
Edit this page on