Document OpenSPP Installation Process with Step-by-Step Guide for Non-Docker Environments

[jeremi]

Document OpenSPP Installation Process with Step-by-Step Guide for Non-Docker Environments

Description

OpenSPP already has basic installation documentation using Docker at https://docs.openspp.org/getting_started/installation_guide.html. However, we need comprehensive, user-friendly installation documentation for non-Docker environments. We need clear, step-by-step installation guides that cover various non-containerized deployment scenarios to provide users with more flexibility in their installation options.

Objective

Create detailed documentation that:

1. Walks users through the complete installation process without using Docker
2. Covers different installation scenarios (development, production) for non-containerized environments
3. Addresses common installation issues and troubleshooting
4. Includes system requirements and prerequisites

Tasks

• Document prerequisites and system requirements for native installation
• Create step-by-step installation instructions for non-Docker development environments
• Document non-Docker production deployment best practices
• Include database setup and configuration
• Document addon module installation
• Create a troubleshooting section for common installation issues
• Add screenshots where helpful
• Ensure new documentation follows the structure of the existing docs in the OpenSPP documentation repository (https://github.com/openspp/documentation)

Expected Outputs

• Markdown documentation files in the repository
• Screenshots of key steps
• Troubleshooting section
• List of system requirements

Good First Tasks for the Sprint

• Verify existing installation steps and identify gaps
• Document system requirements for native installation
• Create screenshots of the installation process
• Test installation on a fresh system following the draft documentation
• Compare with Odoo native installation approaches and adapt as needed

Resources

• OpenSPP Modules Repository
• Odoo Installation Documentation
• Current Docker Installation Guide
• OpenSPP Documentation Repository

Labels

documentation, good-first-issue, installation, beginner-friendly

Priority

High

Size

Small (Completable in a day)

[Sandeep9182-hue]

📋 Summary of the Task

The task aims to create a step-by-step installation guide for OpenSPP in non-Docker (native) environments, covering both development and production setups. The goal is to give users a flexible installation alternative beyond the current Docker-based setup.

---

🧠 Key Insights from the Description

🔗 Context:

• OpenSPP currently provides a Docker-based installation guide.

• There is no official native installation documentation, which limits users who don't or can't use Docker.

🧭 Purpose:

• Empower developers, testers, and deployers with a Docker-free option.

• Provide detailed, clear, and easy-to-follow steps for all types of users.

---

🎯 Objective Breakdown

Objective | What It Means -- | -- Walk through complete installation | Native setup from scratch (Python, PostgreSQL, dependencies, config, running server). Support development & production setups | Development = flexible, fast startup; Production = stable, secure, systemd-managed deployment. Include troubleshooting | Common issues during install must be covered with solutions. List requirements | RAM, CPU, OS, PostgreSQL, Python, etc., with clear guidance.

---

🏷 Labels & Classification

• Labels: documentation, good-first-issue, installation, beginner-friendly

• Priority: 🔴 High (important for user accessibility)

• Size: 🟢 Small (can be done in 1 working day if the system is ready)

---

📌 Recommendations

• Use a clean VM or container to test the native install.

• Take screenshots as you go — it will save time later.

• Split the guide into dev and prod if needed, or clearly section them.

• Follow Odoo's pattern where applicable, since OpenSPP builds on top of it.

• Push to the docs/ folder in the OpenSPP repo when ready for PR.

[22AmitDeo]

I have addressed this issue by creating detailed documentation for the native (non-Docker) installation of OpenSPP. The PR can be found here: https://github.com/OpenSPP/documentation/pull/12 It includes:

• System requirements and prerequisites
• Step-by-step setup for development and production
• Database and module configuration
• Troubleshooting section

Looking forward to feedback!

[celinenilla]

Hi,

Thank you for wanting to contribute to the OpenSPP Documentation. I just wanted to let you know that this page has been revised in our new documentation release, and I will therefore close this ticket.