Guides
Task-focused instructions for things youβll do after your Hub is running. If youβre still setting up, start with Getting Started.
Exposing apps beyond your LAN
| Guide | Use when |
|---|---|
| Expose your apps | You want the general picture of your options |
| Cloudflare tunnels | You want public URLs without port forwarding |
| DNS challenge with Cloudflare | You need wildcard TLS certificates |
| Linking a domain | You own a domain and want the dashboard on it |
| Local SSL certificate | You want HTTPS on your LAN only |
Customizing apps and the Hub
| Guide | Use when |
|---|---|
| Customize app config | You need extra volumes or env vars on an installed app |
| Customize compose and Traefik | You need to override the Hubβs own compose stack |
| Creating a dynamic compose file | Youβre authoring an app for the store |
| Create your own app store | You want a private or team catalog |
Keeping it running
| Guide | Use when |
|---|---|
| Move your Hub to a new machine | Youβre changing hardware |
| Backup & Restore | You want to snapshot a single app |
| Auto backup with cron | You want scheduled backups |
| Auto update with cron | You want unattended updates |
| Uninstalling | Youβre removing Hub or resetting an environment |
Several guides in this section predate the current cihub CLI and describe
file paths from an earlier release. Where a guide and the
Reference section disagree, the Reference section is
authoritative.
Last updated on