github/endurain
1
1
Fork 0
mirror of https://github.com/joaovitoriasilva/endurain.git synced 2026-01-11 08:47:55 -05:00
Code Issues 45 Packages Projects Releases Wiki Activity

Fix for docs

Browse Source
This commit is contained in:
João Vitória Silva
2025-06-23 13:52:31 +01:00
parent 1960c3153a
commit 1a5f5cca86
3 changed files with 8 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
.env.example
View File

@@ -1,6 +1,6 @@
# This is an environment variable for endurains docker-compose.yml.example
# This is an environment variable file for Endurain's docker-compose.yml.example
# These are just the variable you have to set to be up and running.
# There is many more variable you could set. Check them out here: https://docs.endurain.com/getting-started/#supported-environment-variables
# There is many more variable you could set. Check them out here: https://docs.endurain.com/getting-started/advanced-started/#supported-environment-variables
DB_PASSWORD=changeme
POSTGRES_PASSWORD=changeme

4
docs/getting-started/advanced-started.md
View File

@@ -1,3 +1,7 @@
## Default Credentials
- **Username:** admin
- **Password:** admin
## Docker Deployment

4
docs/getting-started/getting-started.md
View File

@@ -76,7 +76,7 @@ Environment variable | How to set it |
| FERNET_KEY |Run `python -c "from cryptography.fernet import Fernet; print(Fernet.generate_key().decode())"` on a terminal to get a secret or go to [https://fernetkeygen.com](https://fernetkeygen.com). Example output is `7NfMMRSCWcoNDSjqBX8WoYH9nTFk1VdQOdZY13po53Y=` |
| GEOCODES_MAPS_API | <a href="https://geocode.maps.co/">Geocode maps</a> offers a free plan consisting of 1 Request/Second. Registration necessary. |
| TZ | Timezone definition. Insert your timezone. List of available time zones [here](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). Format `Europe/Lisbon` expected |
| ENDURAIN_HOST | https://endurain.yourdomain.com) |
| ENDURAIN_HOST | https://endurain.yourdomain.com |
| BEHIND_PROXY | Change to true if behind reverse proxy |
| POSTGRES_DB | Postgres name for the database. |
| POSTGRES_USER | Postgres user for the database. |
@@ -104,7 +104,7 @@ If you do not get any errors, continue to next step.
### Visit the site
* Visit the site insecurly on http://<IP-OF-YOUR-SERVER>:8080
* Visit the site insecurly on http://`IP-OF-YOUR-SERVER`:8080
* We still can not login to the site, because the `ENDURAIN_HOST` doesn't match our local URL.
## Configure Caddy as reverse proxy and get SSL cert from letsencrypt