Download
Download redfish
One Docker Compose stack: the app, the job worker and the database.
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 inSet the secrets
Set the encryption key and the base URL in
.env. Sending profiles are encrypted with this key.Start the stack
This starts the app, the job worker and the database.
$ docker compose up -d $ curl -fsS http://localhost:3000/healthzCreate 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 release
v0.1.0 - Image
ghcr.io/selfhostr/redfish - Platforms
linux/amd64,linux/arm64 - Pin a version
REDFISH_VERSION - Update
git 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
Check the first and last characters after pasting. We never ask for crypto by message.