Skip to content

Self-hosted start page without the extra stuff

License

Notifications You must be signed in to change notification settings

ordinary-dev/phoenix

Repository files navigation

Phoenix

Go Report Card

Self-hosted start page without the extra stuff.

List view: Screenshot (list view)

Tile view: Screenshot (tile view)

Features

  • No javascript
  • Authorization support
    • SSO via Trusted Header Auth (Reverse Proxy)
  • Font Awesome integration
  • Multiple styles
  • Export and import

Configuration

Service settings can be set through environment variables.

Variable Description Default
DB_PATH Path to the sqlite database. Docker: /var/lib/phoenix/db.sqlite3
LOG_LEVEL Log level settings: debug, info, warning, error warning
HEADER_AUTH Enable Trusted Header Auth (SSO) false
DEFAULT_USERNAME Data for the first user.
DEFAULT_PASSWORD Data for the first user.
ENABLE_REGISTRATION Allow registration via web interface? true
SECURE_COOKIE Controls the "secure" option for a token cookie. true

Appearance settings:

Variable Description Default
TITLE Website title Phoenix
FONT_FAMILY 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
    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.