Repository navigation
Dashboard
The dashboard is where you add apps and look after them. It runs on your server at the dashboard domain, behind its password or Cloudflare Access.
- The sidebar has the dashboard's pages: Overview, Usage, Logs, Server, Domains, Backups, Users and Settings. At the top is your instance and its version; at the bottom, who is signed in (the Cloudflare Access email and its picture, or "Admin" for the password) and Log out.
- The switcher, at the top left, picks what the pages are about: All apps, or one app. Every page has both. With an app picked, the sidebar's links stay on that app, and picking another keeps you on the same page.
-
The address says the same:
/usageis every app,/blog/usageis the appblog. - Add app, at the top right, adds an app.
- On a phone, the sidebar opens from the menu button.
All apps (/): the server's memory and disk, whether backups are up to date, and a row per
app. Each row shows the app's status, its last deploy (or the one that failed, and which
version still runs), 24 hourly bars of uptime, its memory against its limit, and visitors over
7 days, or requests for an app without pages. Apps that need a look come first.
One app (/blog): Redeploy, Edit and Visit; anything wrong first (a failed deploy or
backup); then the deployment (status, version, when it was deployed, its addresses and limits),
its health (uptime, response time, CPU, memory) and its usage over 7 days.
Visitors, page views and requests over the last 7 days, each with its change from the week before. For all apps, one chart and a row per app; for one app, its new accounts too, then where its visits come from: pages and hosts, referrers, countries, devices and browsers, operating systems, custom events and app versions. Counted without cookies or anything that identifies a visitor.
For all apps, every app's latest lines merged by time. For one app, its last 200 lines. Reload the page for newer ones.
For all apps, the server itself: CPU, memory, disk, load and uptime. For one app, its container over the last day: CPU and memory against its limits, response time and uptime.
Every address an app answers on: its subdomain of the apps domain, and its own domain with whether it is live yet. If you manage that domain's DNS yourself, the records to add are listed here. Change an app's domain from its Edit page.
When backups are set up, every app's last backup: when, its size, and whether it failed or is overdue. Back up now backs one up at once. On an app's page, Restore puts its database back as it was at one of the backups in the bucket, after backing up the data now. See Backups and restoring for setting them up and restoring.
Every app shares one user pool. For all apps: how many users and guests, accounts active today and over 7 and 30 days, new accounts per day, app versions, then the users themselves. For one app, the same for the users who have used it. Delete removes a user from the pool, and so from every app, with what each app kept for them.
For all apps, how this instance is set up: its domains, edge, DNS, Access, backups, analytics mode and user pool. These come from the server's configuration and change with a deploy.
Redirects are domains that send every visitor elsewhere, such as an old domain (ADR 0052). Each has:
-
From: the domain. A root domain such as
example.comredirects itswww.too. It can't be an app's domain, the dashboard's, or one the apps domain keeps. -
To: an
https://address. -
Keep the path:
/blog/post?page=2goes to the same path at the new address. Off, every path goes to the address itself. -
Path rules (optional): one per line, a path and an address, such as
/docs https://example.com/docs. That path and everything under it go to that address, before the rule above.
Every redirect is permanent (301). Saving a domain that is listed already replaces it; Remove deletes it. Point the domain's A and AAAA records at the server; its certificate comes with the first visit.
Privacy and legal holds who runs the apps: your name, postal address, email for requests, supervisory authority and hosting provider. Apps get them, with what the instance does with personal data, as their legal facts (see the contract). Saving deploys every app again so they get them; static sites get them at once, without a deploy. Below are the facts, a download of them (your record of processing), and what you still do yourself; see also When personal data leaks.
For one app: its settings, its deploy hook (see Deploy from CI), and Remove.
- Add app asks for a name, the image and tag, an optional custom domain, the port, memory and CPU limits, environment variables and whether visitors must sign in first. Getting started explains each.
-
Static site, chosen when you add it, is an image with only files in
/site. It asks for the name, image and tag, domain and memory, and what unknown paths get: the site's404.htmlor, for a single-page app, itsindex.html. See Static sites. An app can't become a static site later, or the other way round. - Edit changes them and deploys. Redeploy pulls the same tag again, for an image that was pushed again under it.
- A deploy waits until the new version is healthy before it takes traffic. If it fails, you see why, and the version before keeps running.
- Remove stops the app and removes its settings and site. Its data is kept unless you choose to delete it too.
Published from docs/. Edit the files there; changes here are overwritten.