Skip to content

Commit 3c67e54

Browse files
committed
update docs
1 parent 1c5bc40 commit 3c67e54

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

docs/self-hosting/installation/index.md

+10-5
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Before you begin, make sure you have Docker installed on your server. See the [o
1414
If you use Ubuntu, you can install Docker with the commands below:
1515

1616
<details>
17-
<summary>Click to see docker installation code</summary>
17+
<summary>Click to see Ubuntu docker installation commands</summary>
1818

1919
```shell
2020
# Add Docker's official GPG key:
@@ -53,7 +53,11 @@ Next, open the docker-compose.yml file. On Linux, you can use vim:
5353
vi docker-compose.yml
5454
```
5555

56-
The downloaded `docker-compose.yml` file should contain the template below with default environment variables:
56+
The downloaded `docker-compose.yml` file should contain the template below with default environment variables.
57+
58+
:::info
59+
`APP_URL` is optional, but useful for correct email links.
60+
:::
5761

5862
```yaml title="docmost/docker-compose.yml"
5963
version: "3"
@@ -101,15 +105,16 @@ volumes:
101105
102106
You are to replace the default environment variables in the `docker-compose.yml` file.
103107

104-
The `APP_URL` should be replaced with your chosen domain. E.g. `APP_URL: 'https://example.com'` or `APP_URL: 'https://docmost.example.com'`.
108+
The `APP_URL` should be replaced with your chosen domain. E.g. `https://example.com` or `https://docmost.example.com`.
105109

106-
The `APP_SECRET` value should be replaced with a long random secret key. You can generate the secret with `openssl rand -hex 32`.
110+
The `APP_SECRET` value must be replaced with a long random secret key.
111+
You can generate the secret with `openssl rand -hex 32`. If you leave the default value, the app will fail to start.
107112

108113
Replace `STRONG_DB_PASSWORD` in the `POSTGRES_PASSWORD` environment variable with a secure password.
109114

110115
Update the `DATABASE_URL` default `STRONG_DB_PASSWORD` value with your chosen Postgres password.
111116

112-
To configure Emails or File storage driver, see the [Configuration](./self-hosting/configuration) doc.
117+
To configure Emails or File storage driver, see the [Configuration](./self-hosting/configuration) doc.
113118
The default File storage driver is `local storage`. You don't have to do anything unless you wish to use S3 storage.
114119

115120
### Start the Services

0 commit comments

Comments
 (0)