2023-04-06 10:36:11 +05:00
|
|
|
# Phoenix
|
|
|
|
|
2023-04-09 12:22:50 +05:00
|
|
|
![Screenshot](screenshot.webp)
|
|
|
|
|
2023-04-06 10:36:11 +05:00
|
|
|
Self-hosted start page without the extra stuff.
|
|
|
|
|
|
|
|
## Features
|
|
|
|
- No javascript
|
2023-04-09 19:51:20 +05:00
|
|
|
- Relatively low resource consumption (around 7 MiB of RAM)
|
|
|
|
- Authorization support
|
2023-08-27 19:26:16 +05:00
|
|
|
- SSO via Trusted Header Auth (_Reverse Proxy_)
|
2023-04-09 12:05:50 +05:00
|
|
|
|
|
|
|
## Configuration
|
|
|
|
Service settings can be set through environment variables.
|
2023-07-22 21:32:11 +05:00
|
|
|
|
|
|
|
| Variable | Description | Default |
|
|
|
|
| --- | --- | --- |
|
|
|
|
| P_DBPATH | Path to the sqlite database. | Docker: `/var/lib/phoenix/db.sqlite3` |
|
|
|
|
| P_SECRETKEY | A long and random secret string used for authorization. | |
|
|
|
|
| P_LOGLEVEL | Log level settings: `debug`, `info`, `warning`, `error`, `fatal` | `warning` |
|
|
|
|
| P_ENABLEGINLOGGER | Enable gin's logging middleware. Can create a lot of logs. | `false` |
|
|
|
|
| P_PRODUCTION | Is this instance running in production mode? | `true` |
|
2023-08-27 19:26:16 +05:00
|
|
|
| P_HEADERAUTH | Enable Trusted Header Auth (SSO) | `false` |
|
2023-07-22 21:32:11 +05:00
|
|
|
| P_DEFAULTUSERNAME | Data for the first user. | |
|
|
|
|
| P_DEFAULTPASSWORD | Data for the first user. | |
|
2023-04-09 19:32:35 +05:00
|
|
|
|
|
|
|
## Docker-compose example
|
|
|
|
```yml
|
|
|
|
services:
|
|
|
|
phoenix:
|
|
|
|
image: ghcr.io/ordinary-dev/phoenix
|
|
|
|
volumes:
|
|
|
|
- phoenix:/var/lib/phoenix
|
|
|
|
ports:
|
2023-04-09 19:38:43 +05:00
|
|
|
- 80:8080
|
2023-07-22 21:32:11 +05:00
|
|
|
environment:
|
|
|
|
P_SECRETKEY: "your-random-string"
|
|
|
|
P_DEFAULTUSERNAME: "admin"
|
|
|
|
P_DEFAULTPASSWORD: "super-password"
|
2023-04-09 19:32:35 +05:00
|
|
|
restart: unless-stopped
|
|
|
|
|
|
|
|
volumes:
|
|
|
|
phoenix:
|
|
|
|
```
|