Bot Updating Documentation

pull/248/head
LinuxServer-CI 2024-09-18 21:30:35 +00:00
rodzic 7217e820bf
commit c94be94756
Nie znaleziono w bazie danych klucza dla tego podpisu
1 zmienionych plików z 14 dodań i 1 usunięć

Wyświetl plik

@ -37,7 +37,7 @@ The architectures supported by this image are:
Web UI is accessible at http://SERVERIP:PORT. An external postgres database is required.
Default login is demo@demo.demo with a password of demo. Once you've created your own user account be sure to login to it and delete the demo account.
Once you've run your first time setup you can safely remove the DEFAULT_ environment variables. They will overwrite any changes made to the default user in the web UI (passwords, display names, etc.) on startup if left in place.
### Migration from Official Image
@ -68,6 +68,10 @@ services:
- TZ=Etc/UTC
- BASE_URL=https://planka.example.com
- DATABASE_URL=postgresql://user:password@planka-db:5432/planka
- DEFAULT_ADMIN_EMAIL=demo@demo.demo
- DEFAULT_ADMIN_USERNAME=demo
- DEFAULT_ADMIN_PASSWORD=demo
- "DEFAULT_ADMIN_NAME=Demo User"
- SECRET_KEY=notasecretkey
- TRUST_PROXY=0
volumes:
@ -87,6 +91,10 @@ docker run -d \
-e TZ=Etc/UTC \
-e BASE_URL=https://planka.example.com \
-e DATABASE_URL=postgresql://user:password@planka-db:5432/planka \
-e DEFAULT_ADMIN_EMAIL=demo@demo.demo \
-e DEFAULT_ADMIN_USERNAME=demo \
-e DEFAULT_ADMIN_PASSWORD=demo \
-e DEFAULT_ADMIN_NAME="Demo User" \
-e SECRET_KEY=notasecretkey \
-e TRUST_PROXY=0 \
-p 1337:1337 \
@ -114,6 +122,10 @@ Containers are configured using parameters passed at runtime (such as those abov
| `TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
| `BASE_URL=https://planka.example.com` | The URL you will use to access planka including protocol, and port if not 80/443. |
| `DATABASE_URL=postgresql://user:password@planka-db:5432/planka` | Postgres database URL. Special characters must be [url encoded](https://en.wikipedia.org/wiki/Percent-encoding). |
| `DEFAULT_ADMIN_EMAIL=demo@demo.demo` | Email address for default user. |
| `DEFAULT_ADMIN_USERNAME=demo` | Username for default user. |
| `DEFAULT_ADMIN_PASSWORD=demo` | Password for default user. |
| `DEFAULT_ADMIN_NAME=Demo User` | Display name for default user. |
| `SECRET_KEY=notasecretkey` | Session encryption key, recommended 32-64 character alphanumeric. |
| `TRUST_PROXY=0` | Set to `1` to trust upstream proxies if reverse proxying. |
@ -291,4 +303,5 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64
## Versions
* **18.09.24:** - Update default user docs.
* **12.09.24:** - Initial Release.