Skip to content

Modernize installer and add Docker Compose deployment - #2

Draft
shzxm wants to merge 9 commits into
mainfrom
feature/modern-installer-docker-compose
Draft

shzxm wants to merge 9 commits into
mainfrom
feature/modern-installer-docker-compose

Conversation

@shzxm

@shzxm shzxm commented Nov 11, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Modernize the 2021 installer: isolated Python virtual environment and a dedicated systemd service, without modifying the OS Python installation.
  • Add Dockerfile + Docker Compose with persistent EFB configuration/SQLite data, non-root UID/GID mapping, interactive efb-wizard, log/status/update/backup management.
  • Protect existing installations (legacy units, profiles, token, sessions and databases); avoid destructive uninstall or automatic migration.
  • Handle Debian 13 / Ubuntu 24.04+ libmagic1t64 rename and document Python/plugin compatibility caveats.
  • Add Bash smoke tests and GitHub Actions build + pip dependency validation.

Testing

  • MBP: bash -n install.sh, bash tests/smoke.sh and YAML structural checks pass.
  • Tests mock Compose configure/up/update/backup and verify backup contents.
  • Actual image build and dependency check must pass in GitHub Actions before merge.

Notes

Docker defaults to Python 3.12 because upstream legacy modules may break on Python 3.13+. The repo does not deploy to production hosts.

@shzxm

shzxm commented Nov 11, 2026

Copy link
Copy Markdown
Collaborator Author

Follow-up based on read-only inspection of three live EFB profiles across two Ubuntu 26.04 ARM64 hosts: all three had 4 configured module entry points present; observed per-profile systemd/venv differences, high SQLite-related FD counts, and optional link-preview/instant-view middleware. This revision adds isolated profile deployments, compatible Docker UID mapping, optional middleware requirements, preflight registration validation, read-only FD diagnostics, protected backups, versioned native venv updates and anonymized operational guidance. MBP smoke tests pass; a temporary Linux checkout passed real Docker Compose config validation without touching live services. Full Docker image build for this revision remains queued in GitHub Actions and is not yet verified.

@shzxm

shzxm commented Nov 11, 2026

Copy link
Copy Markdown
Collaborator Author

README has now been fully rewritten, not appended: commit 352ed6b replaces the old 155-line document with a 1,287-line / 56,104-byte Chinese installation and operations manual. It has 22 linked sections covering Docker/native fresh deployment, profiles, environment and UID/GID, systemd, dependency compatibility, optional middleware, backups and recovery, migration, versioned venv rollback, real three-instance anonymized lessons, Telegram limits, SQLite/FD diagnostics, troubleshooting and acceptance criteria. Local validation: all 22 internal links resolve, code fences balanced, no private identifiers, Bash syntax and smoke tests pass. Sensitive backup/restore examples deliberately keep data outside the Git working tree. New GitHub Actions runs remain queued; no claim that CI has passed for this commit.

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.

1 participant