Skip to content

README.md

Latest commit

 

History

History
63 lines (47 loc) · 2.54 KB

README.md

File metadata and controls

63 lines (47 loc) · 2.54 KB
Raw

Heimdall for Cloudron

Cloudron app package for linuxserver/Heimdall, the PHP/Laravel-based application dashboard. Pinned to upstream v2.6.1.

What is this?

Heimdall lists your selfhosted services as a tile grid on a single landing page. It speaks no Cloudron-isms upstream; this package wraps the Laravel app behind Apache + mod_php on Cloudron's standard port 3000, with a SQLite database and persistent storage under /app/data.

Prerequisites

  • A running Cloudron instance (Free or Pro tier — Heimdall counts as one app).
  • Cloudron CLI: npm install -g cloudron, cloudron login my.<your-domain>.
  • docker login ghcr.io -u <github-user> with a PAT that has write:packages.

Build & deploy

make rebuild

That chains cloudron build (builds locally, pushes to your registry), followed by cloudron update. First-time prerequisites:

  • The image repository in ~/.cloudron.json set to e.g. ghcr.io/<github-user>/io.staude.heimdall.cloudronapp. The Cloudron CLI prompts for it on the first build and caches it afterwards.
  • If the GHCR package stays private, register the same registry login in the Cloudron WebUI under System → App Packages → Docker Registries so the server can pull.

The Makefile pins DOCKER_DEFAULT_PLATFORM=linux/amd64 so Apple Silicon hosts produce a Cloudron-compatible single-platform image.

Updates

make update ships the current local image to your Cloudron without rebuilding; make rebuild does both. Cloudron snapshots /app/data before swapping containers.

Files

File Purpose
CloudronManifest.json App metadata, port, healthcheck, addons
Dockerfile Builds Apache + PHP 8.3 + Heimdall on cloudron/base:5.0.0
apache2.conf VHost on :3000 with Heimdall's public/ as DocumentRoot
start.sh Cloudron entry point: preps /app/data, runs migrations, starts Apache
DESCRIPTION.md Long description shown in the Cloudron App Store
POSTINSTALL.md First-run instructions shown after install
CHANGELOG Per-version package changelog
Makefile install / update / rebuild / build / push / logs / exec / uninstall

Authentication

Heimdall has its own multi-user login (with optional 2FA, set in the Heimdall Settings page). This package does not wire it up to Cloudron's user directory — Cloudron-side ProxyAuth is intentionally disabled so that Heimdall remains reachable from outside the Cloudron SSO bubble. Set up Heimdall users from inside the app on first start.