diff --git a/deploy.env b/deploy.env index 44b86ab8..b4ce4d7d 100644 --- a/deploy.env +++ b/deploy.env @@ -9,6 +9,7 @@ APPFLOWY_DATABASE_URL=postgres://postgres:password@postgres:5432/postgres # authentication key, change this and keep the key safe and secret # self defined key, you can use any string GOTRUE_JWT_SECRET=hello456 +# Expiration time in seconds for the JWT token GOTRUE_JWT_EXP=7200 # User sign up will automatically be confirmed if this is set to true. @@ -17,19 +18,24 @@ GOTRUE_JWT_EXP=7200 # If you set this to false, you need to either set up SMTP GOTRUE_MAILER_AUTOCONFIRM=true -# if you enable mail confirmation, you need to set the SMTP configuration below +# If you intend to use mail confirmation, you need to set the SMTP configuration below +# You would then need to set GOTRUE_MAILER_AUTOCONFIRM=false +# Check for logs in gotrue service if there are any issues with email confirmation GOTRUE_SMTP_HOST=smtp.gmail.com GOTRUE_SMTP_PORT=465 GOTRUE_SMTP_USER=email_sender@some_company.com GOTRUE_SMTP_PASS=email_sender_password GOTRUE_SMTP_ADMIN_EMAIL=comp_admin@some_company.com -# gotrue admin +# This user will be created when AppFlowy Cloud starts successfully +# You can use this user to login to the admin panel GOTRUE_ADMIN_EMAIL=admin@example.com 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 +# User will be redirected to this after Email or OAuth login +# Change this to your own domain where you host the docker-compose or gotrue +# If you are using a different domain, you need to change the redirect_uri in the OAuth2 configuration +# Make sure that this domain is accessible to the user API_EXTERNAL_URL=http://your-host # In docker environment, `postgres` is the hostname of the postgres service @@ -54,6 +60,8 @@ GOTRUE_EXTERNAL_DISCORD_SECRET= GOTRUE_EXTERNAL_DISCORD_REDIRECT_URI=http://your-host/gotrue/callback # File Storage +# This is where storage like images, files, etc. will be stored +# By default, Minio is used as the default file storage which uses host's file system APPFLOWY_S3_USE_MINIO=true APPFLOWY_S3_MINIO_URL=http://minio:9000 # change this if you are using a different address for minio APPFLOWY_S3_ACCESS_KEY=minioadmin @@ -61,9 +69,13 @@ APPFLOWY_S3_SECRET_KEY=minioadmin APPFLOWY_S3_BUCKET=appflowy #APPFLOWY_S3_REGION=us-east-1 +# Log level for the appflowy-cloud service RUST_LOG=info # PgAdmin +# Optional module to manage the postgres database +# You can access the pgadmin at http://your-host/pgadmin +# Refer to the APPFLOWY_DATABASE_URL for password when connecting to the database PGADMIN_DEFAULT_EMAIL=admin@example.com PGADMIN_DEFAULT_PASSWORD=password diff --git a/doc/DEPLOYMENT.md b/doc/DEPLOYMENT.md index b7ed5a3f..e63a9e60 100644 --- a/doc/DEPLOYMENT.md +++ b/doc/DEPLOYMENT.md @@ -51,51 +51,8 @@ cd AppFlowy-Cloud ```bash cp deploy.env .env ``` -- There will be values in the `.env` that needs to be change according to your needs -- Kindly read the following comments for each set of settings -```bash -# This is the secret key for authentication, please change this and keep the key safe -GOTRUE_JWT_SECRET=hello456 - -# This determine if the user will be user automatically be confirmed(verified) when they sign up -# If this is enabled, it requires a clicking a confirmation link in the email after a user signs up. -# If you do not have SMTP service set up, or any other OAuth2 method, you should set this to true, -# or else no user will be able to be authenticated -GOTRUE_MAILER_AUTOCONFIRM=true - -# If you require mail confirmation, you need to set the SMTP configuration below -# and set `GOTRUE_MAILER_AUTOCONFIRM` to be false -GOTRUE_SMTP_HOST=smtp.gmail.com -GOTRUE_SMTP_PORT=465 -GOTRUE_SMTP_USER=user1@example.com -# this is typically an app password that you would need to generate: https://myaccount.google.com/apppasswords -GOTRUE_SMTP_PASS=somesecretkey -# You can leave this field same as GOTRUE_SMTP_USER -GOTRUE_SMTP_ADMIN_EMAIL=user1@example.com - -# This is the email account that is the admin account -# which has the highest privilege level, typically use to -# manage other users, such as user creation, deletion, password change, etc -GOTRUE_ADMIN_EMAIL=admin@example.com -GOTRUE_ADMIN_PASSWORD=password - -# This is the address of the authentication server -# 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://your-host - -# File Storage -# This affects where the files will be uploaded. -# 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 -AWS_SECRET_ACCESS_KEY=minioadmin -AWS_S3_BUCKET=appflowy -AWS_REGION=us-east-1 # This option only applicable for AWS S3 -``` +- Kindly read through the comments for each option +- Modify the values in `.env` according to your needs For authentication details, refer to the [Authentication](./AUTHENTICATION.md) documentation. You will need to update the redirect URI to match your host server's public IP or hostname, such as `http:///gotrue/callback`.