From 2409c1c3c7af02bcfd0e7c02aeebd1e4cf020fbd Mon Sep 17 00:00:00 2001 From: amalshaji Date: Sun, 24 Mar 2024 22:03:22 +0530 Subject: [PATCH] update env docs --- .env.template | 16 ++++++++++++++++ docs/src/content/docs/server-setup/index.md | 15 ++++++++------- 2 files changed, 24 insertions(+), 7 deletions(-) create mode 100644 .env.template diff --git a/.env.template b/.env.template new file mode 100644 index 00000000..b454f3b0 --- /dev/null +++ b/.env.template @@ -0,0 +1,16 @@ +PORTR_ADMIN_GITHUB_CLIENT_ID= +PORTR_ADMIN_GITHUB_CLIENT_SECRET= + +PORTR_DOMAIN=example.com +PORTR_DB_URL=postgres://postgres:postgres@localhost:5432/postgres + +PORTR_SERVER_URL=example.com +PORTR_SSH_URL=example.com:2222 + +CLOUDFLARE_API_TOKEN= + +POSTGRES_USER=postgres +POSTGRES_PASSWORD=postgres +POSTGRES_DB=postgres + +PORTR_ADMIN_ENCRYPTION_KEY= diff --git a/docs/src/content/docs/server-setup/index.md b/docs/src/content/docs/server-setup/index.md index a1def445..95b79a21 100644 --- a/docs/src/content/docs/server-setup/index.md +++ b/docs/src/content/docs/server-setup/index.md @@ -33,21 +33,22 @@ The compose file has 4 services Once you copy the compose file, create a `.env` with the following keys. ```text -GITHUB_APP_CLIENT_ID= -GITHUB_APP_CLIENT_SECRET= +PORTR_ADMIN_GITHUB_CLIENT_ID= +PORTR_ADMIN_GITHUB_CLIENT_SECRET= -DOMAIN=example.com -DB_URL=postgres://postgres:postgres@localhost:5432/postgres +PORTR_DOMAIN=example.com +PORTR_DB_URL=postgres://postgres:postgres@localhost:5432/postgres -ENCRYPTION_KEY= +PORTR_SERVER_URL=example.com +PORTR_SSH_URL=example.com:2222 -SERVER_URL=example.com -SSH_URL=example.com:2222 CLOUDFLARE_API_TOKEN= POSTGRES_USER=postgres POSTGRES_PASSWORD=postgres POSTGRES_DB=postgres + +PORTR_ADMIN_ENCRYPTION_KEY= ``` Generate a random encryption key using the following command