mirror of https://github.com/alexbelgium/hassio-addons.git synced 2026-08-21 12:23:32 +02:00

Files

Alexandre 0ead28a7bf feat: add Portainer Business Edition add-on (#873 ) (#2916 )

* feat(portainer_be): add Portainer Business Edition add-on

Adds a new `portainer_be` add-on based on the existing Portainer (CE)
add-on, requested in #873.

Business Edition has no public GitHub release tarball like CE, so the
binary and web assets are pulled from the official multi-arch
`portainer/portainer-ee` image via a multi-stage build and placed under
/opt/portainer, mirroring CE's layout exactly. All runtime scripts,
nginx/ingress config, options schema, SSL and password handling are
unchanged from CE, so behaviour is identical apart from the edition.

Users obtain a free (up to 3 nodes) Business Edition license key by
registering with Portainer and enter it in the web UI on first launch.

- config.yaml: slug portainer_be, BE image name, BE description/name
- Dockerfile: multi-stage COPY from portainer/portainer-ee (no CE tarball)
- updater.json: dockerhub source tracking portainer/portainer-ee
- apparmor.txt: unique profile name (portainer_be_addon)
- CHANGELOG/README/DOCS: BE-specific, documents the license-key step

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

* fix(portainer_be): address PR review feedback

- nginx finish: move shebang to byte 0 (leading blank line prevented S6 from
  recognising the interpreter, so the finish hook could fail to tear down the
  supervision tree) [Codex P2]
- ingress: tighten CSP to `frame-ancestors 'self'` to match the adjacent
  X-Frame-Options SAMEORIGIN; HA ingress embeds same-origin so the panel keeps
  working [CodeRabbit]
- README: correct login note (password is the configured option value, never
  printed to logs); drop MD012 consecutive blank lines [CodeRabbit]
- DOCS: fix "environement" -> "environment" typo [CodeRabbit]

Skipped: nginx SSL "idempotency" finding — /etc/nginx lives in the read-only
image layer and cont-init re-renders from the pristine template on every
container start, so in-place sed edits never accumulate or need restoring.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

* revert(portainer_be): keep CSP frame-ancestors * for ingress compatibility

Reverts the frame-ancestors 'self' change from the previous commit. The
wildcard is required for the Home Assistant ingress iframe to embed the
Portainer UI; tightening it breaks the ingress panel. Matches the CE add-on.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>

2026-07-27 22:08:17 +02:00

2.8 KiB

Raw Permalink Blame History

Portainer can be used to execute custom commands in a docker container. It is a lightweight management UI which allows you to easily manage a Docker host(s) or Docker swarm clusters.

This is the Business Edition variant, shipping the portainer/portainer-ee build. Business Edition is free for up to 3 nodes with a license key obtained by registering at https://www.portainer.io/take-3. Enter that key in the web UI on first launch; without one it runs a time-limited trial. All add-on options and behaviour are otherwise identical to the Community Edition add-on.

Quick start

Add my repository using this link
Install the Portainer Business Edition addon from my repo
On first launch, open the web UI and enter your Business Edition license key
In the configuration panel of the addon, you can change the password
In the main page of the addon, disable "Protection mode", then start the addon
Login (default name is admin, default password is homeassistant)
Click on Primary in the environment (at the center of the page)
Click on Containers in the left menu bar
Increase the number of items per page to see all your addons
Click on the symbol >_ next to the name of your selected addon to open the console page
Either change the username, or more usually just click connect
Type your commands, you have full access to the terminal of this specific container (this does not affect other parts of your HA system)

Impact on your system

There is no impact of installing, or running portainer
Installing manually a custom container will modify your HA status to an unsupported/unhealthy state. You will be blocked from upgrading Home Assistant and upgrading any Add-ons you may have. Stopping this custom container will reset the normal status

Tips and tricks

Reset database

Just change the password in your addon options and the database will be reset

Timeout of 60s

The addon includes a very long timeout. However, if you use another layer of proxy such as the addon nginx proxy manager, it will default to a timeout of 60s. You'll have to adapt the proxy layer to increase timeout. More details here : https://github.com/portainer/portainer/issues/2953#issuecomment-1235795256

Further reference

Here is a full guide on using it : https://codeopolis.com/posts/beginners-guide-to-portainer/
Old page on the HA community forum about portainer : https://community.home-assistant.io/t/home-assistant-community-add-on-portainer

2.8 KiB Raw Permalink Blame History