Documentation
Install, configure and use self-hosted OrbitPage. Browse the open-source wiki, from dashboard guides to administration and development.
35 guides shown
Dashboard
Page editing, content management and account settings
Dashboard
The dashboard is where you edit your public page, manage sharing and newsletters, and change account or installation settings.
Account and team
Manage local accounts under Team and your own security under Account → Security. Available tools depend on your role.
Analytics and privacy
Configure consent under Privacy and reports under Analytics. Built-in analytics uses the local database; GA4 is optional.
Backups, media, and demo mode
Use dashboard exports to move selected content. Back up the complete data directory and host configuration to recover an installation.
Content and design
Edit your page in Page, Content, Menu, Pages, and Theme:
Newsletters
Send newsletters through your own SMTP server. An administrator manages settings, subscribers, and campaigns under Newsletter.
Publishing and QR codes
Saved self-hosted content appears at the public URL. Save each section before opening Public page; an unsaved preview does not change the public page.
Shop
Sell digital downloads and services from your self-hosted OrbitPage installation, using your own Stripe account and SMTP provider. OrbitPage adds no platform fee; Stripe fees apply
Integrations
Payments, bookings, external modules, consent and automation
Consent management
Privacy can use OrbitPage's built-in banner or an external consent-management platform (CMP). Choose one banner. OrbitPage reads the supported provider's visitor choices to control
External modules
Connected-service blocks add links, players and forms to your page. Manage the original content with its provider, then paste its public URL into OrbitPage. No provider API key is
Integrations
Connect external content and services to your self-hosted page.
SMTP email setup
SMTP (Simple Mail Transfer Protocol) lets OrbitPage submit outgoing email to an email provider. It is a sending connection, not a hosted mailbox or inbox. Self-hosted OrbitPage inc
Overview
Practical OrbitPage instructions
Account and team
This guide has moved to Account and team.
AI assistant
Use AI Assistant or Edit with AI to propose profile, content, theme changes, and draft Shop products. Manual editing works without a provider.
Self-hosted API
This guide has moved to Self-hosted API.
Deployment
Installation and update instructions have moved to Deployment.
Docker image address
The migration instructions are now in Deployment → Older Docker Hub images. This link remains for dashboards released with the former guide URL.
Frequently asked questions
Open Shop settings → INFO as the installation administrator. Refresh checks SQLite integrity, data/upload access, free disk space, application build, runtime support, server depend
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.
SEO and indexing
OrbitPage generates search and sharing metadata from saved page data. Configure it in Page and Publish.
Administration
Practical OrbitPage instructions
Configuration
OrbitPage can be configured through environment variables.
Deployment
OrbitPage can be deployed with Docker, the Linux installer, or the Proxmox VE installer.
Backups and maintenance
Use this guide for a complete data backup, restore, rollback, or removal. For installation and update commands, see Deployment. For dashboard exports and local version history, see
Administration
Guides for installing, configuring, and maintaining a self-hosted OrbitPage instance.
Administrator recovery
Use this procedure when the first admin account has lost its password, authenticator, and recovery codes. For a user's normal password or TOTP change, use Account and team.
Security
This guide explains the implemented protections and installation settings. Report vulnerabilities using SECURITY.md.
Troubleshooting
Check status, logs, and the health endpoint for your installation before changing settings. Installation and update commands are in Deployment.
Development
Practical OrbitPage instructions
Self-hosted API
The bundled Express /api serves the dashboard and accepts personal API tokens for scripts. It changes with OrbitPage releases; it has no separate stable API version.
Application
Technical reference for the self-hosted source code. For the system boundaries, see Architecture; for daily coding commands, see Development.
Architecture
This document explains the self-hosted runtime and its separation from the hosted service. Application covers files, dependencies, builds, and commands.
OrbitPage OSS design system
For UI changes, use the dashboard stylesheet, UI components, and theme model.
Development
Use this workflow to change the source code. Application maps the repository and main files; Run from source runs the built application locally.
GitHub automation
The release workflow queries Quality Gate, E2E (browser), and Build and smoke Docker (architecture); keep these job names aligned with the gate and repository protection.
Product requirements
This document defines what the self-hosted OrbitPage application must support. Use it to assess a feature or regression; installation and editing instructions belong in the linked
Development
Technical guides for working on OrbitPage's source code and API.