docs: update .env_template and README for clarity

This commit is contained in:
ZhymabekRoman 2025-04-24 08:34:40 +05:00
parent d747ea8455
commit a537760d97
3 changed files with 7 additions and 8 deletions

View file

@ -2,7 +2,7 @@
HOST_ADDRESS = "http://localhost:6752"
# TIMEOUT: Timeout in seconds for the requests
TIMEOUT=3
TIMEOUT=15
# ADMIN_SECRET_KEY: Secret key that will be used to get access for some internal admin API endpoints
ADMIN_SECRET_KEY="test"
@ -16,4 +16,4 @@ ADMIN_SECRET_KEY="test"
PGADMIN_DEFAULT_EMAIL=root@root.com
PGADMIN_DEFAULT_PASSWORD=root
.... and more values to change you can find in ./web/server/config.py and docker-compose rules folder
# .... and more values to change you can find in ./web/server/config.py and docker-compose rules folder

View file

@ -59,7 +59,7 @@ To configure your Freedium instance, follow these steps:
sudo docker network create caddy_net
```
4. Change your hosts file:
4. (Optional) Change your hosts file:
```
sudo nano /etc/hosts
@ -86,7 +86,7 @@ To configure your Freedium instance, follow these steps:
sudo docker compose --profile local -f ./docker-compose/docker-compose.yml down
```
And now you can access local instance of Freedium by opening browser and type `https://freedium.local`. There is would be a warning about insecure connection, because we use self-signed TLS certificate. Ignore it.
And now you can access local instance of Freedium by opening browser and type `https://freedium.local` or `http://localhost:6752` if you ignored 4th step. There is would be a warning about insecure connection, because we use self-signed TLS certificate. Ignore it.
### Production run:

View file

@ -7,6 +7,8 @@ x-expose: &expose
ports:
- "80:80"
- "443:443"
- "6752:6752"
- "6753:6753"
x-freedium_web: &freedium_web
env_file: ../.env
@ -65,15 +67,12 @@ services:
ipv4_address: 177.28.0.5
caddy_freedium:
<<: *caddy_freedium
<<: [ *caddy_freedium, *expose ]
container_name: caddy_freedium
networks:
freedium_net:
caddy_freedium_net:
caddy_net:
ports:
- "6752:6752"
- "6753:6753"
profiles:
- prod
- min