OrbitPage documentation
Guides for the open-source, self-hosted application. Start here to install OrbitPage, edit your page, or work on the code. Managed-service documentation is at orbitpage.com.
Guides for the open-source, self-hosted application. Start here to install OrbitPage, edit your page, or work on the code. Managed-service documentation is at orbitpage.com.
Install and configure
See Administration for installation and maintenance guides.
| Task | Guide |
|---|---|
| Run locally from source | Run from source |
| Install with Docker, Linux, or Proxmox | Deployment |
| Set environment variables and public URLs | Configuration |
| Solve startup, login, proxy, or indexing problems | Troubleshooting |
Use OrbitPage
See Dashboard guides for section instructions and previews.
| Task | Guide |
|---|---|
| Find dashboard sections, URLs, and save controls | Dashboard |
| Edit profiles, blocks, menus, pages, and themes | Content and design |
| Share a page or print a QR code | Publishing and QR |
| Configure search metadata and discovery files | SEO and indexing |
| View analytics and configure consent | Analytics and privacy |
| Understand SMTP, choose a provider and configure email | SMTP email setup |
| Configure SMTP and send campaigns | Newsletters |
| Configure Shop, Stripe, delivery, signed customer access and SMTP | Shop |
| Configure AI and review suggested edits | AI assistant |
| Export, restore, use version history, or clean media | Backups and demo mode |
| Manage users, passwords, TOTP, and API tokens | Account and team |
| Check instance status or find frequently asked questions | INFO and FAQ |
Integrations
| Task | Guide |
|---|---|
| Add service links, video/audio players, scheduling and forms | External modules |
| Configure iubenda, CookieYes, Cookiebot, OneTrust or a custom CMP | Consent management |
See the Integrations index for SMTP, AI and automation guides.
Maintain an installation
| Task | Guide |
|---|---|
| Update the application | Deployment → Updates |
| Back up, restore, roll back, or uninstall | Maintenance |
| Recover the administrator account | Administrator recovery |
| Review protections and deployment settings | Security |
| Report a vulnerability | Security policy |
Understand and develop
See Development for the technical guides.
| Topic | Document |
|---|---|
| Product goal and required behavior | Product requirements |
| Technical stack, files, data, and builds | Application |
| Runtime flows and OSS/hosted separation | Architecture |
| UI components, styles, accessibility, and brand assets | Design system |
| Local development and tests | Development |
| API authentication and automation | API |
| CI, release publication, and mirror settings | GitHub automation |
| Installer and repository checks | Scripts |
| Contribution workflow | Contributing |
| Repository instructions for agents | AGENTS.md |