Skip to content

docs: Docker installation guide using official synetics images#1306

Merged
MartinHartkopf merged 1 commit into
mainfrom
docs/docker-install-with-official-images
May 18, 2026
Merged

docs: Docker installation guide using official synetics images#1306
MartinHartkopf merged 1 commit into
mainfrom
docs/docker-install-with-official-images

Conversation

@MartinHartkopf
Copy link
Copy Markdown
Contributor

Summary

  • Adds a new German page docs/de/installation/docker-installation/compose.md describing how to deploy i-doit Pro with the official synetics container images (registry.on.ops.docupike.net/i-doit/app:38, db:38) via Docker Compose, including an optional nginx-based TLS reverse proxy.
  • Extends the existing Docker-installation index to present the two installation paths side by side: the new compose-based deployment with official images, and the existing custom build on Debian/Ubuntu.
  • Registers the new page in the German navigation (config/de/mkdocs.yml).

Why

i-doit now ships official, hardened container images from the synetics tech-ops registry. They are simpler to deploy than the custom Apache/PHP build the existing Docker articles describe, but the entrypoint has a few sharp edges that aren't obvious from the upstream compose.yaml snippet alone:

  • Missing IDOIT_VERSION / IDOIT_SYSTEM_SETTINGS in the .env crashes the app container immediately (set -u in the entrypoint).
  • A tmpfs mount on /var/www/html/temp that appears in some templates collides with the add-on installer's rmdir of that directory.
  • The image initialises i-doit in cloud mode; getting Pro mode requires an explicit idoit:feature-manager --unset-cloud / --noncloudable --enable all step plus toggling $g_is_cloud in config.inc.php.
  • IDOIT_APP_URL is only persisted on the very first container start, so a wrong value (e.g. http://localhost:8080) needs the idoit:set-env-var console command to fix.
  • Behind a TLS reverse proxy, Apache's directory-slash redirect emits absolute http://...:8080/ URLs that the proxy has to rewrite (proxy_redirect).

All of these are documented in dedicated troubleshooting sections so users don't have to rediscover them.

Test plan

Verified end-to-end on a clean Debian 13 (Trixie) VM, two independent runs from a fresh snapshot:

  • docker compose pull && docker compose up -d brings the stack to healthy within ~30 s.
  • curl http(s)://.../health returns {"status":"ready","version":"38"}.
  • HTTP request is redirected (301) to HTTPS by nginx; login page served over HTTPS.
  • Login + logout flow over HTTPS works (no stray localhost:8080 redirect).
  • Admin-Center link works over HTTPS (proxy_redirect rewrite verified).
  • Pro-mode activation steps complete successfully; cloud indicators disappear.
  • Add-on install from the Subscription Center succeeds (no rmdir: Device or resource busy).
  • docker compose restart and docker compose down (without -v) followed by up -d preserve app and db volumes; stack returns to healthy.

Follow-up

An English translation of compose.md and the corresponding config/en/mkdocs.yml update will follow in a separate pull request.

🤖 Generated with Claude Code

New page documenting the Docker Compose deployment of i-doit Pro with
the official container images from registry.on.ops.docupike.net.
Covers prerequisites, Docker install, compose.yaml / .env / nginx /
TLS certificate, first login, mandatory Pro-mode activation,
licensing, update, backup, uninstall and troubleshooting (including
the IDOIT_APP_URL one-shot persistence, the tmpfs/temp add-on
install bug, and Apache directory-slash redirects behind nginx).

The existing index.md is extended to present both installation paths
side by side: the new compose-based one and the existing custom build
on Debian / Ubuntu. The new page is registered in the German nav of
config/de/mkdocs.yml. An English translation will follow in a
separate pull request.

Verified end-to-end on Debian 13 from a clean snapshot: stack starts
healthy, HTTP redirects to HTTPS, login + logout via reverse proxy,
add-on install from the Subscription Center works after the
Pro-mode step, lifecycle (restart, down/up) preserves data.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@MartinHartkopf MartinHartkopf merged commit d4b39d2 into main May 18, 2026
7 checks passed
@MartinHartkopf MartinHartkopf deleted the docs/docker-install-with-official-images branch May 18, 2026 12:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants