Files
relibre/README.md
2025-10-18 00:43:36 -04:00

78 lines
1.9 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Relibre
**Music release one-page generator**
Relibre is a simple, free, and open-source landing-page generator—an alternative to HyperFollow—that produces a **single self-contained HTML file** you can host anywhere.
**Try the generator →** [`https://`](https://relibre.site)
---
## What you get
- A clean, responsive, single-file HTML page for a release
- No trackers, no analytics
- Host it anywhere (Neocities, object storage, GitHub/Gitea Pages, your own server, IPFS, etc.)
- Optional native desktop app (only Arch Linux and Flatpak supported for now)
---
## Quick start (static site)
Open locally:
```bash
# simple Python server
python3 -m http.server 8080
# → http://localhost:8080
```
---
## Launch / self-host with Docker or Podman
Relibre ships multiple compose variants so you can choose your reverse proxy. All of them:
- build an internal `web` container that serves the static files
- expose a `proxy` on **localhost:8080** (HAProxy, Caddy, Apache httpd, or Nginx)
**Files:**
- `docker-compose.yml.haproxy`
- `docker-compose.yml.caddy`
- `docker-compose.yml.apache`
- `docker-compose.yml.nginx`
- `proxy/`
- `Dockerfile`
```bash
---
## Native desktop build (Go webview app)
Builds a single executable that opens Relibre inside the OS webview. The app runs a tiny localhost server and can save the generated HTML directly to your **Downloads** folder.
### Prereqs
**Arch:**
sudo pacman -S --needed base-devel go webkit2gtk gtk3 pkgconf
### Build
make deps
make build
./relibre-app
```
---
## Arch Linux (AUR) packaging
- **`relibre`** builds from source
---
## Flatpak / Flathub
Relibre works well as a Flatpak using the GNOME runtime (WebKitGTK included).
Build & run locally:
```bash
flatpak install -y org.gnome.Platform//46 org.gnome.Sdk//46
flatpak-builder --user --install --force-clean build-dir com.circlewithadot.Relibre.yml
flatpak run com.circlewithadot.Relibre