diff --git a/deploy.env b/deploy.env index 760dec14..c7b38f2a 100644 --- a/deploy.env +++ b/deploy.env @@ -1,4 +1,4 @@ -# This file is used to set the environment variables for local development +# This file is a template for docker compose deployment # Copy this file to .env and change the values as needed # authentication key, change this and keep the key safe and secret @@ -24,29 +24,23 @@ GOTRUE_ADMIN_PASSWORD=password # clicking on email verification link will redirect to this host # change this to your own domain where you host the docker-compose or gotrue -API_EXTERNAL_URL=http:// - -# url to the postgres database -DATABASE_URL=postgres://postgres:password@localhost:5433/postgres -# uncomment this to enable build without database -# .sqlx files must be pregenerated -SQLX_OFFLINE=false +API_EXTERNAL_URL=http://your-host # Google OAuth2 GOTRUE_EXTERNAL_GOOGLE_ENABLED=true GOTRUE_EXTERNAL_GOOGLE_CLIENT_ID= GOTRUE_EXTERNAL_GOOGLE_SECRET= -GOTRUE_EXTERNAL_GOOGLE_REDIRECT_URI=http:///callback +GOTRUE_EXTERNAL_GOOGLE_REDIRECT_URI=http://your-host/callback # GitHub OAuth2 GOTRUE_EXTERNAL_GITHUB_ENABLED=false GOTRUE_EXTERNAL_GITHUB_CLIENT_ID= GOTRUE_EXTERNAL_GITHUB_SECRET= -GOTRUE_EXTERNAL_GITHUB_REDIRECT_URI=http:///callback +GOTRUE_EXTERNAL_GITHUB_REDIRECT_URI=http://your-host/callback # Discord OAuth2 GOTRUE_EXTERNAL_DISCORD_ENABLED=false GOTRUE_EXTERNAL_DISCORD_CLIENT_ID= GOTRUE_EXTERNAL_DISCORD_SECRET= -GOTRUE_EXTERNAL_DISCORD_REDIRECT_URI=http:///callback +GOTRUE_EXTERNAL_DISCORD_REDIRECT_URI=http://your-host/callback # File Storage USE_MINIO=true # MINIO_URL=http://localhost:9000 # change this if you are using a different address for minio diff --git a/doc/DEPLOYMENT.md b/doc/DEPLOYMENT.md index 781dc476..d8916504 100644 --- a/doc/DEPLOYMENT.md +++ b/doc/DEPLOYMENT.md @@ -77,16 +77,12 @@ GOTRUE_ADMIN_PASSWORD=password # which is the same as the public IP/hostname of your host server # when an email confirmation link is click, this is the host that user's devices # will try to connect to -API_EXTERNAL_URL=http:// - -# 2 fields below are only relevant for development, can ignore -DATABASE_URL=postgres://postgres:password@localhost:5433/postgres -SQLX_OFFLINE=false +API_EXTERNAL_URL=http://your-host # File Storage # This affects where the files will be uploaded. -# By default, Minio will be deployed as file storage server # and it will use the host server's disk storage. -# You can also AWS S3 by setting USE_MINIO as false +# By default, Minio will be deployed as file storage server which will use the host's disk storage. +# You can also AWS S3 by setting USE_MINIO as false and configure the AWS related fields. USE_MINIO=true # determine if minio-server is used # MINIO_URL=http://localhost:9000 # change this to use minio from a different host (e.g. maybe you self host Minio somewhere) AWS_ACCESS_KEY_ID=minioadmin @@ -103,19 +99,19 @@ If using localhost, then just keep the default value. GOTRUE_EXTERNAL_GOOGLE_ENABLED=true GOTRUE_EXTERNAL_GOOGLE_CLIENT_ID= GOTRUE_EXTERNAL_GOOGLE_SECRET= -GOTRUE_EXTERNAL_GOOGLE_REDIRECT_URI=http:///gotrue/callback +GOTRUE_EXTERNAL_GOOGLE_REDIRECT_URI=http://your-host/gotrue/callback # GitHub OAuth2 GOTRUE_EXTERNAL_GITHUB_ENABLED=true GOTRUE_EXTERNAL_GITHUB_CLIENT_ID=your-github-client-id GOTRUE_EXTERNAL_GITHUB_SECRET=your-github-secret -GOTRUE_EXTERNAL_GITHUB_REDIRECT_URI=http:///gotrue/callback +GOTRUE_EXTERNAL_GITHUB_REDIRECT_URI=http://your-host/gotrue/callback # Discord OAuth2 GOTRUE_EXTERNAL_DISCORD_ENABLED=true GOTRUE_EXTERNAL_DISCORD_CLIENT_ID=your-discord-client-id GOTRUE_EXTERNAL_DISCORD_SECRET=your-discord-secret -GOTRUE_EXTERNAL_DISCORD_REDIRECT_URI=http:///gotrue/callback +GOTRUE_EXTERNAL_DISCORD_REDIRECT_URI=http://your-host/gotrue/callback ``` ### 3. Running the services