Skip to content

Commit 4e7f785

Browse files
committed
Add info for env variables; Add support for local HTTP-setups
1 parent 17df3b1 commit 4e7f785

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

docs/self-hosting/configuration.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,19 @@ The configuration contains placeholders (`your-domain.com`, `your-bucket-name`,
1414
The configuration example below is for a production environment using HTTPS. You can adjust the values to your needs, in any case you will have to change `APP_URL` to the URL of your solidtime instance.
1515

1616
```dotenv
17-
APP_NAME="solidtime"
18-
VITE_APP_NAME="solidtime"
1917
APP_ENV="production"
2018
APP_DEBUG="false"
2119
APP_URL="https://your-domain.com"
2220
APP_FORCE_HTTPS="true"
2321
TRUSTED_PROXIES="0.0.0.0/0,2000:0:0:0:0:0:0:0/3"
2422
```
2523

24+
| Env variable name | Description |
25+
|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
26+
| APP_URL | Base URL (f.e. `https://your-domain.com` for a production setup or something like `http://localhost:8000` for a local HTTP-only setup) |
27+
| APP_FORCE_HTTPS | If enabled, the application will threat all request as if they were HTTPS. This is useful if the app is behind a reverse proxy and the reverse proxy is HTTPS-only but the communication between reverse proxy and app is HTTP. |
28+
| TRUSTED_PROXIES | Comma-seperated list of CIDR IP ranges that are considered trusted. The app will trust headers like the `X-Forwarded-For` requests from those IPs. The example above (`0.0.0.0/0,2000:0:0:0:0:0:0:0/3`) is a wildcard for all IP addresses. This is only safe, if it's not possible to bypass the reverse proxy and the reverse proxy is correctly configured. |
29+
2630
## Authentication
2731

2832
You can run `docker run --rm solidtime/solidtime:main php artisan self-host:generate-keys` to obtain `APP_KEY`, `PASSPORT_PRIVATE_KEY` and `PASSPORT_PUBLIC_KEY`

docs/self-hosting/guides/docker.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ If you don't have a reverse proxy yet, you can use the example with Traefik in t
4242
[The Self-Hosting example repository](https://github.com/solidtime-io/self-hosting-examples/tree/main) contains multiple examples for different setups. You can choose the one that fits your needs the best.
4343

4444
- [Docker + Traefik + Database](https://github.com/solidtime-io/self-hosting-examples/tree/main/0-docker-traefik-with-database)
45-
- [Docker + Database](https://github.com/solidtime-io/self-hosting-examples/tree/main/1-docker-with-database) (+ your own reverse proxy)
45+
- [Docker + Database](https://github.com/solidtime-io/self-hosting-examples/tree/main/1-docker-with-database) (+ your own reverse proxy or HTTP-only for local setups)
4646

4747

4848
**Read the instructions in the README of the example you chose.**

0 commit comments

Comments
 (0)