Find a file
dependabot[bot] adccabf7d6 Bump docker/metadata-action from 5.0.0 to 5.4.0
Bumps [docker/metadata-action](https://github.com/docker/metadata-action) from 5.0.0 to 5.4.0.
- [Release notes](https://github.com/docker/metadata-action/releases)
- [Commits](https://github.com/docker/metadata-action/compare/v5.0.0...v5.4.0)

---
updated-dependencies:
- dependency-name: docker/metadata-action
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-01-02 21:20:25 +05:00
.github Bump docker/metadata-action from 5.0.0 to 5.4.0 2024-01-02 21:20:25 +05:00
assets Simplify favicon 2023-11-02 21:50:36 +05:00
config Add appearance settings 2023-11-02 21:50:36 +05:00
database Add font awesome integration (#39) 2023-09-03 19:08:33 +05:00
templates Add appearance settings 2023-11-02 21:50:36 +05:00
views Add appearance settings 2023-11-02 21:50:36 +05:00
.env Add an option to control the secure parameter for cookies 2023-11-02 21:50:35 +05:00
.gitignore Add support for basic SSO via Trusted Header Auth 2023-08-28 00:26:16 +10:00
Dockerfile Update base docker images 2023-11-02 21:50:36 +05:00
go.mod Bump gorm.io/driver/sqlite from 1.5.3 to 1.5.4 2023-11-01 20:33:34 +05:00
go.sum Bump gorm.io/driver/sqlite from 1.5.3 to 1.5.4 2023-11-01 20:33:34 +05:00
license.txt Create license.txt 2023-04-09 20:03:27 +05:00
main.go Add more settings, update readme and Dockerfile 2023-07-22 21:32:11 +05:00
Makefile Simplify favicon 2023-11-02 21:50:36 +05:00
readme.md Add appearance settings 2023-11-02 21:50:36 +05:00
screenshot.webp Add a screenshot 2023-04-09 12:22:50 +05:00
security.md Create security.md 2023-07-22 22:18:05 +05:00

Phoenix

Go Report Card

Screenshot

Self-hosted start page without the extra stuff.

Features

  • No javascript
  • Relatively low resource consumption (around 7 MiB of RAM)
  • Authorization support
    • SSO via Trusted Header Auth (Reverse Proxy)
  • Font Awesome integration

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_HEADERAUTH Enable Trusted Header Auth (SSO) false
P_DEFAULTUSERNAME Data for the first user.
P_DEFAULTPASSWORD Data for the first user.
P_SECURECOOKIE Controls the "secure" option for a token cookie. true

Appearance settings:

Variable Description Default
P_TITLE Website title Phoenix
P_FONTFAMILY The font used on the site. Inserted directly into css. sans-serif

Docker-compose example

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:

Icons

You can use the free version of Font Awesome.

The name of the icon must be specified in the following form: set name/icon name, for example: brands/github or regular/credit-card.