Skip to content

Commit a1c43f5

Browse files
committed
docs: clarify environment variable usage in README.md
1 parent aa70379 commit a1c43f5

1 file changed

Lines changed: 2 additions & 4 deletions

File tree

README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -63,9 +63,7 @@ will be prompted to provide the required values, which will be saved locally.
6363
When hosting on remote services or using Docker, environment variables are recommended. The following variables must be
6464
set:
6565

66-
- `LINKORA_SERVER_USE_ENV_VAL`: Set this to `true` to indicate the server is running on a remote service. This must
67-
always
68-
be `true` when using environment variables.
66+
- `LINKORA_SERVER_USE_ENV_VAL`: Set this to `true` to enable the use of environment variables. This must always be `true` when using environment variables.
6967
- `LINKORA_DATABASE_URL`: The database URL (without username or password).
7068
- `LINKORA_DATABASE_USER`: The username for your database.
7169
- `LINKORA_DATABASE_PASSWORD`: The password for your database.
@@ -104,7 +102,7 @@ This ensures the server runs as expected and avoids potential issues.
104102

105103
##### 3.1.2 Using Docker:
106104

107-
When running Docker on your local machine, pass the required environment variables using the `-e` flag:
105+
You can set these variables directly in the Docker Desktop GUI before running the image or pass them using the `-e` flag:
108106

109107
```
110108
docker run -e LINKORA_SERVER_USE_ENV_VAL="true" -e LINKORA_DATABASE_URL="mysql://your-db-url" -e LINKORA_DATABASE_USER="your-db-user" -e LINKORA_DATABASE_PASSWORD="your-db-password" -e LINKORA_SERVER_AUTH_TOKEN="your-auth-token" linkora-server

0 commit comments

Comments
 (0)