phoenix/readme.md

43 lines
1.8 KiB
Markdown

# Phoenix
![Screenshot](screenshot.webp)
Self-hosted start page without the extra stuff.
## Features
- No javascript
- Relatively low resource consumption (around 7 MiB of RAM)
- Authorization support
## Configuration
Service settings can be set through environment variables.
| 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` |
| P_DEFAULTUSERNAME | Data for the first user. | |
| P_DEFAULTPASSWORD | Data for the first user. | |
## Docker-compose example
```yml
services:
phoenix:
image: ghcr.io/ordinary-dev/phoenix
volumes:
- phoenix:/var/lib/phoenix
ports:
- 80:8080
environment:
P_SECRETKEY: "your-random-string"
P_DEFAULTUSERNAME: "admin"
P_DEFAULTPASSWORD: "super-password"
restart: unless-stopped
volumes:
phoenix:
```