docs: add manual setup steps required for IAC in github actions

immich-app · Jun 5, 2024 · 657ba75 · 657ba75
1 parent 90b187b
commit 657ba75
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/deployment/manual-setup.md b/deployment/manual-setup.md
@@ -0,0 +1,15 @@
+# Manual Setup Steps
+
+This lists all the steps required to manually setup the IAC deployments in Github Actions.
+
+### Github Secrets
+
+| Secret                      | Secret Type     | Description                                                                 | 
+|-----------------------------|-----------------|-----------------------------------------------------------------------------|
+| TF_APP_INSTALLATION_ID      | Organisation    | The installation ID of the Immich Github App                                |
+| TF_APP_ID                   | Organisation    | The ID of the Immich Github App                                             |
+| TF_APP_PEM_FILE             | Repo (devtools) | The contents of the PEM file for the Github App                             |
+| TF_APP_GITHUB_OWNER         | Organisation    | The Github owner of the repository (immich-app)                             |
+| CLOUDFLARE_API_TOKEN        | Repo (devtools) | The Cloudflare API token scoped to create new API keys                      |
+| CLOUDFLARE_ACCOUNT_ID       | Organisation    | The Cloudflare account ID                                                   |
+| TF_STATE_POSTGRES_CONN_STR  | Organisation    | The connection string for the Postgres database for Terraform state storage |