https://github.com/ordinary-dev/phoenix

Self-hosted start page without the extra stuff
https://github.com/ordinary-dev/phoenix

docker golang homepage no-javascript self-hosted startpage

Last synced: about 1 month ago
JSON representation

Self-hosted start page without the extra stuff

• Host: GitHub
• URL: https://github.com/ordinary-dev/phoenix
• Owner: ordinary-dev
• License: mit
• Created: 2023-03-26T08:01:35.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2024-11-18T09:48:34.000Z (about 1 month ago)
• Last Synced: 2024-11-18T10:57:04.872Z (about 1 month ago)
• Topics: docker, golang, homepage, no-javascript, self-hosted, startpage
• Language: Go
• Homepage:
• Size: 1.11 MB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: readme.md
  • License: license.txt
  • Security: security.md

Awesome Lists containing this project

README

        
# Phoenix

[![Go Report Card](https://goreportcard.com/badge/github.com/ordinary-dev/phoenix)](https://goreportcard.com/report/github.com/ordinary-dev/phoenix)

![Screenshot](screenshot.webp)

Self-hosted start page without the extra stuff.

## 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` |

| SECRET_KEY         | A long and random secret string used for authorization.          |                                       |

| 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.                                         |                                       |

| 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

```yml

services:

  phoenix:

    image: ghcr.io/ordinary-dev/phoenix

    volumes:

      - phoenix:/var/lib/phoenix

    ports:

      - 80:8080

    environment:

      SECRET_KEY: "your-random-string"

      DEFAULT_USERNAME: "admin"

      DEFAULT_PASSWORD: "super-password"

    restart: unless-stopped

volumes:

  phoenix:

```

## Icons

You can use the free version of [Font Awesome](https://fontawesome.com/search).

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