otterwiki icon indicating copy to clipboard operation
otterwiki copied to clipboard

Proxmox LXC setup script

Open adeotek opened this issue 3 months ago • 2 comments

This pull request introduces a solution for deploying OtterWiki in Proxmox LXC containers. It adds a new setup script (setup-otterwiki-lxc.sh) and a README.md to guide users through installation, configuration, and management. The changes are focused on making OtterWiki deployment in Proxmox straightforward, customizable, and production-ready.

Automated LXC Deployment for OtterWiki

  • Added a fully automated setup script (setup-otterwiki-lxc.sh) that creates, configures, and provisions an Ubuntu 24.04 LXC container for OtterWiki, including system dependencies, Python environment, and service setup.
  • The script supports advanced options such as static IP assignment, SSH key authentication, custom resource allocation, and optional cloning of a user-specified wiki repository.

Documentation and Usage Guidance

  • Introduced a detailed README.md covering features, requirements, quick start instructions, command-line options, post-installation steps, troubleshooting, security considerations, and customization tips for the setup script.

Service and Data Management

  • The setup script configures OtterWiki to run under uWSGI with a systemd service, ensuring reliable startup and management, and sets up persistent data directories for wiki content and configuration.
  • Documentation includes instructions for service management, container operations, and optional repository synchronization via cron job, supporting both automated and manual workflows.

adeotek avatar Aug 30 '25 13:08 adeotek

Hey @adeotek, thanks for submitting this PR.

I would like to test it before I merge, please be patient with me getting the environment ready.

Also we might want to add a section to otterwiki.com that covers deploying An Otter Wiki in a LXC container on proxmox.

redimp avatar Aug 31 '25 12:08 redimp

Hi @redimp, no worries, I assumed this will take time. I was also about to propose (after this gets validated) to update the documentation on otterwiki.com. Please let me know if you find any issues or have any improvements proposals.

Thanks.

adeotek avatar Aug 31 '25 13:08 adeotek