@@ -68,34 +68,16 @@ cp deploy.env .env
6868```
6969
7070- Kindly read through the comments for each option
71- - Modify the values in ` .env ` according to your needs
71+ - Modify the values in ` .env ` according to your needs. Minimally, you will have to update $FQDN
72+ to match your host server's domain, unless you are deploying on localhost.
7273
73- For authentication details, refer to the [ Authentication] ( ./AUTHENTICATION.md ) documentation. You will need to update
74- the
75- redirect URI to match your host server's public IP or hostname, such
76- as ` http://<your-host-server-public-ip-or-hostname>/gotrue/callback ` .
77- If using localhost, then just keep the default value.
74+ If you would like to use one of the identity providers to log in, refer to the [ Authentication] ( ./AUTHENTICATION.md ) documentation.
7875
79- ``` bash
80- GOTRUE_EXTERNAL_GOOGLE_ENABLED=true
81- GOTRUE_EXTERNAL_GOOGLE_CLIENT_ID=
82- GOTRUE_EXTERNAL_GOOGLE_SECRET=
83- GOTRUE_EXTERNAL_GOOGLE_REDIRECT_URI=http://your-host/gotrue/callback
84-
85- # GitHub OAuth2
86- GOTRUE_EXTERNAL_GITHUB_ENABLED=true
87- GOTRUE_EXTERNAL_GITHUB_CLIENT_ID=your-github-client-id
88- GOTRUE_EXTERNAL_GITHUB_SECRET=your-github-secret
89- GOTRUE_EXTERNAL_GITHUB_REDIRECT_URI=http://your-host/gotrue/callback
90-
91- # Discord OAuth2
92- GOTRUE_EXTERNAL_DISCORD_ENABLED=true
93- GOTRUE_EXTERNAL_DISCORD_CLIENT_ID=your-discord-client-id
94- GOTRUE_EXTERNAL_DISCORD_SECRET=your-discord-secret
95- GOTRUE_EXTERNAL_DISCORD_REDIRECT_URI=http://your-host/gotrue/callback
96- ```
76+ If you would like to use magic link to log in, you will need to set up env variables related to SMTP.
9777
98- ### 3. Running the services
78+ If neither of the above are configured, then the only was to sign in is via the admin portal (the home page), using the admin email
79+ and password. After logging in as an admin, you can add users and set their passwords. The new user will be able to login to the admin
80+ portal using this credential.
9981
10082#### Start and run AppFlowy-Cloud
10183
@@ -121,9 +103,6 @@ admin/debug tasks.
121103- ` portainer ` /` portainer_init ` (Web UI to provide some monitoring and ease of container management)
122104- ` tunnel ` (Cloudflare tunnel to provide a secure way to connect AppFlowy to Cloudflare without a publicly routable IP
123105 address)
124- - ` admin_frontend ` (admin portal to manage accounts and add authentication methods. We recommend to keep this)
125- If you wish to deploy those, edit the file accordingly and do:
126-
127106```
128107docker compose --file docker-compose-extras.yml up -d
129108```
@@ -224,12 +203,6 @@ by setting the `GOTRUE_DISABLE_SIGNUP` environment variable to `true`.
224203The default configuration assumes that TLS is used for SMTP, typically on port 465. If you are using STARTTLS, such as when
225204using port 587, please change ` APPFLOWY_MAILER_SMTP_TLS_KIND ` to ` opportunistic ` .
226205
227- ### Can I sign in using only using email and password?
228-
229- The AppFlowy clients currently do not support email and password sign in. However, you can login to the admin portal using the admin
230- email and password. In the admin section, you can then add users and set their passwords. Subseqently, users can login to the portal
231- using their email and password, and launch the AppFlowy client via the portal.
232-
233206### What functionality will I lose if the SMTP server is not set up?
234207
235208Sign in via magic link will not be possible. Inviting users to workspace and accepting invitation will have to be
0 commit comments