redfish

Download

Download redfish

One Docker Compose stack: the app, the job worker and the database.

  1. Get the files

    Clone the repository and copy the example environment file.

    $ git clone https://github.com/selfhostr/redfish.git
    $ cd redfish
    $ cp .env.example .env  # fill it in
  2. Set the secrets

    Set the encryption key and the base URL in .env. Sending profiles are encrypted with this key.

  3. Start the stack

    This starts the app, the job worker and the database.

    $ docker compose up -d
    $ curl -fsS http://localhost:3000/healthz
  4. Create the first organisation

    Create the first organisation and admin user from the command line.

    $ docker compose exec app redfish org create

Authorized use only. Run redfish only against your own organisation, with its written agreement.

Requirements

  • A Linux host with Docker Engine 26+ and Compose
  • An SMTP server or relay you are allowed to send from
  • A DNS name and an HTTPS reverse proxy for real use

Versions and images

  • Latest releasev0.1.0
  • Imageghcr.io/selfhostr/redfish
  • Platformslinux/amd64, linux/arm64
  • Pin a versionREDFISH_VERSION
  • Updategit pull && docker compose pull && docker compose up -d

Support the project

Every selfhostr project is free and has no company behind it. If one saves you time, a donation pays for the test hardware and for the time it takes.

Sponsor us on GitHub