From 1816ba550585ff9e7d4cb1103f8cf5731d071cc0 Mon Sep 17 00:00:00 2001 From: Luke Bunselmeyer Date: Mon, 8 May 2023 08:56:04 -0400 Subject: [PATCH] Added deployment details to readme --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 318ab39..1444f8d 100644 --- a/README.md +++ b/README.md @@ -96,3 +96,20 @@ Run all checks ```shell npm run validate ``` + +## Deployment + +This project uses Github actions to deploy changes pushed to the `main` branch to fly.io. + +The deployment pipeline is defined in [.github/workflows/deploy.yml](.github/workflows/deploy.yml) +and [fly.toml](fly.toml). Authentication to fly.io is enabled by +a `FLY_API_TOKEN` [repository secret](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository). + +The following commands were used to initialize the fly application. + +```shell +fly apps create awesome-radio-1ae3 +fly secrets set SESSION_SECRET=$(openssl rand -hex 32) --app awesome-radio-1ae3 +fly volumes create data --size 1 --app awesome-radio-1ae3 +fly scale memory 512 --app awesome-radio-1ae3 +```