No website yet

` to fill with your markup; `wizard` is the onboarding wizard's Alpine component instance. | | `title` | No | Label shown in the wizard's step tabs. Falls back to `key`. | | `enabled(opts)` | No | Return `false` to hide the step for a given user. `opts` mirrors the same feature flags the built-in steps use (`opts.php`, `opts.mysql`, etc.) - use it if you want your step gated on an existing feature. | | `init(wizard)` | No | Called once, when the wizard opens, before the user reaches your step - use it to prefetch current state (e.g. whether a service is already running). Can be async. | | `submit(wizard)` | No | Called when the user clicks **Continue** on your step. Return `false` (or reject) to keep the user on the step with `wizard.error` set to a message; return `true` to advance. Can be async. If omitted, the step always advances. | Your step appears right before the final "Finish" screen, after Security. ## Where to add the code Edit (or create) the custom JS override file: ```bash nano /etc/openpanel/openpanel/custom_code/custom.js ``` This file is always loaded by the OpenPanel interface, so anything you put there runs on every page - not just onboarding. If the file didn't already exist, restart the `openpanel` container once so it picks up the new override: ```bash cd /root && podman-compose up -d openpanel ``` Further edits to an existing `custom.js` take effect immediately on page reload - no restart needed. ## Example: add a Redis step Redis already has a full page in OpenPanel (`/cache/redis`) with a same-origin JSON API the panel's own pages use (`GET`/`POST /cache/redis?output=json`), but it isn't one of the wizard's built-in steps. Here's a complete step that lets users enable or disable it during onboarding: ```js // Adds a "Redis" step to the account-setup onboarding wizard. window.OPOnboardingSteps = window.OPOnboardingSteps || []; window.OPOnboardingSteps.push({ key: 'redis', title: 'Redis', // Prefill from the current container state before the wizard shows it. async init(wizard) { const { ok, data } = await wizard.getJSON('/cache/redis?output=json'); this._choice = ok && data.container_state === 'running' ? 'enabled' : 'disabled'; }, render(host, wizard) { const choice = this._choice || 'disabled'; host.innerHTML = `

Enable Redis as an in-memory cache for your applications.

Enabled Disabled

`; host.querySelectorAll('input[name="onb_redis"]').forEach(input => { input.addEventListener('change', () => { this._choice = input.value; }); }); }, async submit(wizard) { const action = this._choice === 'enabled' ? 'enable' : 'disable'; const { ok, data } = await wizard.formPost('/cache/redis?output=json', { action }); if (!ok) { wizard.error = (data && data.error) || 'Failed to update Redis.'; return false; } return true; } }); ``` A few things worth noting about the example: - `wizard.getJSON(url)` and `wizard.formPost(url, params)` are the same helpers the built-in steps use to talk to OpenPanel's own session-authenticated page routes (not the Bearer-token `/api/*` routes) - they already attach the CSRF token, so you don't need to handle that yourself. - Setting `wizard.error` reuses the wizard's existing error banner, shown above the step content. - `this` inside the step definition refers to the object you pushed onto `window.OPOnboardingSteps`, so it's a convenient place to stash per-step state (like `_choice` above) between `init`, `render`, and `submit`. ## Gating a custom step To only show your step for users who have a specific feature enabled, add an `enabled` function. For example, to only offer the Redis step to users who also have the (built-in) Varnish step: ```js enabled(opts) { return !!opts.varnish; } ``` If you need a condition that isn't one of the wizard's existing `opts` flags, call your own endpoint from `enabled` or `init` and store the result before deciding. ## Testing The wizard only shows automatically until the user finishes or dismisses it. To see your changes without creating a throwaway account, delete the onboarding marker file for a test user and reload the dashboard - see [resetting onboarding for a user](/docs/admin/settings/openpanel/#onboarding). --- // File: articles/dev-experience/autostart-services # Which Services Start Automatically (and How to Auto-Start Others) Services in OpenPanel start only when they are actually needed, to avoid wasting resources. ## Auto-start Services in OpenAdmin Upon installing OpenPanel, only the following services are started: - **OpenAdmin** – For managing the entire server and users. - **Docker** – Needed for all other containerized services and user accounts. - **Database** – MySQL database is created and initialized. This database holds Plans, Websites, Domains, and Users. - **Firewall** – [Sentinel Firewall](https://sentinelfirewall.org/) is installed and started. Other services are installed and started only when required. | Service | Installed | Auto-start | |------------------------|-----------|---------------------------| | OpenAdmin | ✔ | On installation | | Docker | ✔ | On installation | | Database | ✔ | On installation | | Sentinel Firewall | ✔ | On installation | | OpenPanel | ✘ | After adding first user account | | BIND9 | ✘ | After adding first domain name | | Caddy | ✘ | After adding first domain name | | ImunifyAV | ✘ | When enabled by Administrator | | Dovecot & Postfix | ✘ | When enabled by Administrator | | FTP | ✘ | When enabled by Administrator, after first FTP account is created | | phpMyAdmin | ✘ | When enabled by Administrator, after first MySQL database is created by a user | ## Auto-start Services in OpenPanel Similar to OpenAdmin, services in OpenPanel also start only when they are needed. This allows for better resource management. Services that auto-start for each user: | Service | Installed | Auto-start | |--------------------|-----------|---------------------------------------------------| | Apache / Nginx / OpenLitespeed | ✔ | After the user adds the first domain | | | REDIS | ✘ | After the user activates it | | Memcached | ✘ | After the user activates it | | Elasticsearch | ✘ | After the user activates it | | MySQL / MariaDB | ✔ | After the user adds at least 1 database | | Cron | ✔ | After the user adds at least 1 cron job | | PHP versions | ✘ | After the user sets it for at least 1 domain | --- // File: articles/dev-experience/customizing-openadmin-email-templates # Customizing OpenAdmin Email Templates OpenAdmin sends outbound notification emails (new user welcome emails, password/login alerts, admin notifications, and the daily usage report) using HTML templates built into the `admin` binary. Administrators can override any of these templates with their own HTML, without editing any code and without recompiling: OpenAdmin picks up overrides once, at startup. ## Override directory **Directory:** `/etc/openpanel/openadmin/email_templates/` This directory doesn't exist by default. To customize a template, copy the original file below into the directory (creating it if needed) under the exact same name, then edit it as you like: | File name | Used for | Original file | | --- | --- | --- | | `email_new_user.html` | Welcome email sent when a new user account is created | [view on GitHub](https://github.com/stefanpejcic/openadmin/blob/main/internal/webtemplates/email_new_user.html) | | `email_user_notifications.html` | Password-change and new-login alerts sent to a user | [view on GitHub](https://github.com/stefanpejcic/openadmin/blob/main/internal/webtemplates/email_user_notifications.html) | | `email_admin_notifications.html` | Generic admin notification emails | [view on GitHub](https://github.com/stefanpejcic/openadmin/blob/main/internal/webtemplates/email_admin_notifications.html) | | `email_daily_system_report.html` | The daily usage report email (CPU/RAM/disk usage, user/domain/website counts) | [view on GitHub](https://github.com/stefanpejcic/openadmin/blob/main/internal/webtemplates/email_daily_system_report.html) | Each file is a standard Go `html/template` file and can use the same `{{.Field}}` placeholders as the built-in template it replaces (e.g. `{{.Title}}`, `{{.Message}}`, `{{.Hostname}}`). ## Applying changes Overrides are only read once, at `admin` service startup. After adding or editing a file in the override directory, restart the service: ```bash systemctl restart admin ``` ## Fallback behavior - If a file for a given template name isn't present, OpenAdmin uses its built-in default for that email. - If a file is present but fails to parse as a valid template, OpenAdmin logs the error and falls back to the built-in default for that email — a broken override never blocks outbound mail. - You only need to add the files for the templates you want to change; the rest keep using the built-in defaults. --- // File: articles/dev-experience/customizing-openpanel-user-interface # How to White-Label and Rebrand the Control Panel Everything in OpenPanel is modular and can easily be modified or disabled without breaking the rest of the functionalities. To customize OpenPanel, you have the following options: - [Display personalized message per user](#personalized-messages) - [Enable/disable features and pages from the OpenPanel interface](#enabledisable-features) - [Add custom icons in Dashboard page](/docs/articles/dev-experience/add-custom-icons-in-openpanel-dashboard) - [Customize Default, Suspended User and Suspended Domain pages](#customize-templates) - [Localize the interface](#localize-the-interface) - [Set custom branding](#set-custom-branding) - [Set a custom color scheme](#set-a-custom-color-scheme) - [Replace How-to articles with your knowledge base](#replace-how-to-articles-with-your-knowledge-base) - [Add custom CSS or JS code to the interface](#add-custom-css-or-js-code) - [Create a custom module for OpenPanel](#create-openpanel-module) - [Self-hosted temporary links for SiteManager](/docs/articles/dev-experience/selfhosted-temporary-links-api/) - [Self-hosted screenshots for SiteManager](/docs/articles/dev-experience/selfhosted-screenshots-api/) - [Customize robots.txt and security.txt](/docs/articles/security/robots-and-security-txt/) ## Personalized messages Administrators can set a custom message to be displayed for any OpenPanel uer from their **OpenAdmin > Accounts > Users** page. ![custom img](/img/docs-content/9CCgHGG2-2025-06-11-12-26.png) ## Enable/disable features Administrators have the ability to enable or disable each feature (page) in the OpenPanel interface per plan or per-user base. Once enabled, the feature becomes instantly available to all users, appearing in the OpenPanel interface sidebar, search results, and dashboard icons. ## Set pre-installed services OpenPanel uses compose files as the base for each user. Based on the container images in those compose files, different services can be set per plan/user. ## Localize the interface OpenPanel is localization ready and can easily be translated into any language. OpenPanel is shipped with the EN locale, [additional locales can be installed by the Administrator](https://dev.openpanel.com/localization.html#How-to-translate). ## Set custom branding Custom brand name and logo can be set from [OpenAdmin > Settings > OpenPanel](/docs/admin/settings/openpanel/#branding) page. To set a custom name visible in the OpenPanel sidebar and on login pages, enter the desired name in the "Brand name" option. Alternatively, to display a logo instead, provide the URL in the "Logo image" field and save the changes. ## Customize Templates You can customize all templates that are displayed to users, from [OpenAdmin > Domains > Domain Templates](/docs/admin/domains/file_templates/): - [Default Landing Page](/docs/admin/domains/file_templates/#default-page) - [Suspended Website Template](/docs/admin/domains/file_templates/#suspended-website) - [Suspended User Template](/docs/admin/domains/file_templates/#suspended-user) - [Apache VirtualHost Template](/docs/admin/domains/vhost_templates/#apache-virtualhost) - [Nginx VirtualHost Template](/docs/admin/domains/vhost_templates/#nginx-virtualhost) - [OpenResty VirtualHost Template](/docs/admin/domains/vhost_templates/#openresty-virtualhost) ## Create OpenPanel Module To create a custom module (plugin) for OpenPanel follow this guide: [Example Module](https://dev.openpanel.com/modules/#Example-Module) ## Set a custom color scheme To set a custom color-scheme for OpenPanel interface, edit the `/etc/openpanel/openpanel/custom_code/custom.css` file and in it set your preferred color scheme. ```bash nano /etc/openpanel/openpanel/custom_code/custom.css ``` Set the custom css code, save and restart openpanel to apply changes: ```bash cd /root && podman-compose up -d openpanel ``` Example: ![custom_css_code](/img/docs-content/YprhHZhg-2024-06-18-15-04.png) ## Replace How-to articles with your knowledge base [OpenPanel Dashboard page](/docs/panel/dashboard) displays [How-to articles](/docs/panel/dashboard/#how-to-guides) from the OpenPanel Docs, however these can be changed to display your knowledgebase articles instead. Edit the file `/etc/openpanel/openpanel/conf/knowledge_base_articles.json` and in it set your links: ```json { "how_to_topics": [ {"title": "How to install WordPress", "link": "https://openpanel.com/docs/panel/applications/wordpress#install-wordpress"}, {"title": "Publishing a Python Application", "link": "https://openpanel.com/docs/panel/applications/python#create-an-application"}, {"title": "How to edit Nginx / Apache configuration", "link": "https://openpanel.com/docs/panel/webserver/webserver_settings"}, {"title": "How to create a new MySQL database", "link": "https://openpanel.com/docs/panel/mysql/new_db"}, {"title": "How to add a Cronjob", "link": "https://openpanel.com/docs/panel/cronjobs#add-a-cronjob"}, {"title": "How to enable Redis caching", "link": "https://openpanel.com/docs/panel/caching/Redis"} ], "knowledge_base_link": "https://openpanel.com/docs/panel/intro/?source=openpanel_server" } ``` ## Add custom CSS or JS code To add custom CSS code to the OpenPanel interface, edit the file `/etc/openpanel/openpanel/custom_code/custom.css`: ```bash nano /etc/openpanel/openpanel/custom_code/custom.css ``` To add custom JavaScript code to the OpenPanel interface, edit the file `/etc/openpanel/openpanel/custom_code/custom.js`: ```bash nano /etc/openpanel/openpanel/custom_code/custom.js ``` To insert custom code within the `` tag of the OpenPanel interface, modify the content of the file located at `/etc/openpanel/openpanel/custom_code/in_header.html` and include your custom code within it: ```bash nano /etc/openpanel/openpanel/custom_code/in_header.html ``` To insert custom code within the `

Reaaady, set, internet 🎉

Website Suspended

Account Suspended

{item.question}