-
Notifications
You must be signed in to change notification settings - Fork 4
split module installation and rewrite getting started index page #97
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| --- | ||
| myst: | ||
| html_meta: | ||
| "title": "OpenSPP Module Installation Guide" | ||
| "description": "Step-by-step guide for installing and configuring OpenSPP modules including SP-MIS, Social Registry, and Farmer Registry" | ||
| "keywords": "OpenSPP, modules, installation, Odoo, SP-MIS, Social Registry, Farmer Registry" | ||
| --- | ||
|
|
||
| # Farmer Registry installation | ||
|
|
||
| **OpenSPP Farmer Registry Base / spp_base_farmer_registry** | ||
|
|
||
| The {doc}`OpenSPP Farmer Registry <../overview/products/farmer_registry>` configuration enables convergence between social protection and agricultural development programs. This setup is designed for organizations supporting smallholder farmers, managing agricultural subsidies, or implementing climate-smart agriculture initiatives. | ||
|
|
||
| **What's included:** | ||
| - Farmer and farm household registration | ||
| - Land parcel mapping with GIS integration | ||
| - Crop and livestock tracking | ||
| - Agricultural input distribution management | ||
| - Seasonal cycle management | ||
| - Integration with agricultural extension services | ||
|
|
||
| **Installation steps:** | ||
|
|
||
| 1. Navigate to the **Apps** menu. | ||
| 2. In the Apps menu, search for {doc}`spp_base_farmer_registry </reference/modules/spp_base_farmer_registry>` or "OpenSPP Farmer Registry Base" | ||
|
|
||
|  | ||
|
|
||
| 3. Click the **Activate** button to install the module and its dependencies. | ||
|
|
||
|  | ||
|
|
||
| 4. Restart OpenSPP after installing the module: | ||
| ```bash | ||
| sudo systemctl restart openspp | ||
| ``` | ||
|
|
||
| **Note**: The `queue_job` module, which is essential for asynchronous background tasks, is automatically installed as a dependency of the main OpenSPP modules. It is also pre-configured as a `server_wide_module`, ensuring that background workers can process jobs correctly after a service restart. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -11,33 +11,46 @@ myst: | |
| Welcome to OpenSPP! This guide will help you get your social protection platform up and running quickly. | ||
|
|
||
| ## Quick start path | ||
| Start here if you're setting up OpenSPP for the first time: | ||
|
|
||
| :::::{grid} 2 | ||
| :gutter: 3 | ||
|
|
||
| ::::{grid-item-card} New installation | ||
| Start here if you're setting up OpenSPP for the first time: | ||
| ::::{grid-item-card} I want to use the OpenSPP products | ||
|
|
||
| 1. {doc}`Install OpenSPP on Debian/Ubuntu (30 minutes) <installation_deb>` | ||
|
|
||
| <br> | ||
|
|
||
| 1. **{doc}`Installation guide <installation_deb>`** | ||
| Install OpenSPP on Debian/Ubuntu (30 minutes) | ||
| 2. Install {doc}`SP-MIS <spmis_installation>`, {doc}`Social Registry <social_installation>`, or {doc}`Farmer Registry <farmer_installation>` from the available modules. | ||
|
|
||
| 2. **{doc}`Module installation <module_installation>`** | ||
| Choose {doc}`SP-MIS <../overview/products/sp_mis>`, {doc}`Social Registry <../overview/products/social_registry>`, or {doc}`Farmer Registry <../overview/products/farmer_registry>` | ||
| <br> | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
|
|
||
| 3. **Initial setup** | ||
| Configure your first program and import data | ||
| 3. Get your system ready for use: | ||
| - Create your first program - {doc}`Creating a Program <../user_guide/program_management/create_program>` | ||
| - Import beneficiary data - {doc}`Registry Management <../user_guide/registry_management/index>` | ||
| - Configure user access - {doc}`Administration <../user_guide/administration/index>` | ||
|
|
||
| :::: | ||
|
|
||
| ::::{grid-item-card} Learn the system | ||
| Explore OpenSPP's capabilities: | ||
| ::::{grid-item-card} I want to select my modules freely | ||
|
|
||
| 1. {doc}`Install OpenSPP on Debian/Ubuntu (30 minutes) <installation_deb>` | ||
|
|
||
| <br> | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
|
|
||
| 2. Choose modules to install. Read more about {doc}`module installation <module_installation>` and {doc}`available modules <../reference/modules/index>` | ||
|
|
||
| <br> | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
|
|
||
| - **{doc}`Features <../overview/features/index>`** - Understand key features | ||
| - **{doc}`Products <../overview/products/index>`** - Choose the right product configuration | ||
| - **{doc}`User guide <../user_guide/index>`** - Learn day-to-day operations | ||
| 3. Get your system ready for use: | ||
| - Create your first program - {doc}`Creating a Program <../user_guide/program_management/create_program>` | ||
| - Import beneficiary data - {doc}`Registry Management <../user_guide/registry_management/index>` | ||
| - Configure user access - {doc}`Administration <../user_guide/administration/index>` | ||
| :::: | ||
| ::::: | ||
|
|
||
| ## Choose your configuration | ||
| ## OpenSPP configurations | ||
|
|
||
| OpenSPP offers three primary configurations based on your needs: | ||
|
|
||
|
|
@@ -59,28 +72,6 @@ OpenSPP offers three primary configurations based on your needs: | |
| - • Farm mapping<br>• Crop tracking<br>• Input distribution<br>• Seasonal cycles | ||
| ``` | ||
|
|
||
| ## Steps | ||
|
|
||
| ### 1. System installation | ||
| **Time required:** 30-45 minutes | ||
|
|
||
| Install OpenSPP using our Debian packages: | ||
| - {doc}`Installation Guide <installation_deb>` - Production deployment on Ubuntu/Debian | ||
|
|
||
| ### 2. Module configuration | ||
| **Time required:** 15-30 minutes | ||
|
|
||
| After installation, configure your system: | ||
| - {doc}`Module Installation <module_installation>` - Install base modules and extensions | ||
|
|
||
| ### 3. Initial setup | ||
| **Time required:** 1-2 hours | ||
|
|
||
| Get your system ready for use: | ||
| - Create your first program - {doc}`Creating a Program <../user_guide/program_management/create_program>` | ||
| - Import beneficiary data - {doc}`Registry Management <../user_guide/registry_management/index>` | ||
| - Configure user access - {doc}`Administration <../user_guide/administration/index>` | ||
|
|
||
| ## Where to go next | ||
|
|
||
| Based on your role: | ||
|
|
@@ -121,6 +112,7 @@ Based on your role: | |
| - **[GitHub Discussions](https://github.com/orgs/OpenSPP/discussions)** - Ask questions and get help from the community | ||
| - **[Report Issues](https://github.com/OpenSPP/openspp-modules/issues)** - Report bugs or request features | ||
| - **{doc}`OpenSPP Glossary <../reference/glossary>`** - Look up terms (available in multiple languages) | ||
| - **[OpenSPP Discord server](https://discord.gg/bgrwxhEQty)** - Join the OpenSPP Discord server and meet the rest of the community | ||
|
|
||
| ```{toctree} | ||
| --- | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,124 +10,46 @@ myst: | |
|
|
||
| OpenSPP's modular architecture allows organizations to deploy only the features they need. Built on Odoo 17, the platform extends functionality through specialized modules that can be mixed and matched to create tailored social protection solutions. This guide covers installing OpenSPP modules for different use cases. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| Before installing OpenSPP modules, ensure you have: | ||
|
|
||
| - **Odoo 17 instance** running and accessible | ||
| - **OpenSPP modules** source code from the [OpenSPP repository](https://github.com/OpenSPP/openspp-modules/tree/17.0/) | ||
| - **Addons path** configured to include the `openspp-modules` directory | ||
| - **Administrator access** to your Odoo instance | ||
| - **Developer mode** knowledge (required for module installation) | ||
|
|
||
| :::{tip} | ||
| For development setup instructions, see the {doc}`Development Setup Guide <../developer_guide/setup>`. | ||
| :::{important} | ||
| Before installing OpenSPP modules, ensure you have an **Odoo 17 instance** running and accessible. If not, follow the {doc}`Installation guide <installation_deb>` in order to install it. | ||
| ::: | ||
|
|
||
| ## General installation process | ||
|
|
||
| Installing an Odoo module, including those for OpenSPP, follows a standard procedure: | ||
| ## Installing OpenSPP base modules | ||
|
|
||
| 1. **Place Modules in Addons Path**: Ensure the `openspp-modules` directory is included in your Odoo configuration's `addons_path`. | ||
| 2. **Update apps list**: | ||
| - Log in to your Odoo instance with administrator privileges. | ||
| - Activate the developer mode. | ||
| - Navigate to the **Apps** menu. | ||
| - Click on **Update Apps List** and confirm the update. | ||
| 3. **Install the module**: | ||
| - In the **Apps** menu, clear the default "Apps" filter from the search bar. | ||
| - Search for the desired module by its technical name or title. | ||
| - Click the **Activate** button on the module's card to begin the installation. | ||
|
|
||
|  | ||
|
|
||
| ## Installation setups | ||
|
|
||
| OpenSPP can be configured in different ways depending on your project's needs. Below are the installation guides for three primary setups. | ||
| OpenSPP comes with three configured base modules depending on your needs. The steps on how to install these can be found in {doc}`Installation of OpenSPP Social Registry <social_installation>`, {doc}`Installation of OpenSPP SP-MIS <spmis_installation>` and {doc}`Installation of OpenSPP Farmer Registry <farmer_installation>`. | ||
|
|
||
| :::{important} | ||
| The **SP-MIS** ({doc}`spp_base </reference/modules/spp_base>`), and **Farmer Registry** ({doc}`spp_farmer_registry_base </reference/modules/spp_farmer_registry_base>`) modules are mutually exclusive. You can only have one of them installed in a single Odoo database. Attempting to install multiple base modules will result in an error. | ||
| The **SP-MIS** ({doc}`spp_base_spmis </reference/modules/spp_base_spmis>`), **Farmer Registry** ({doc}`spp_base_farmer_registry </reference/modules/spp_base_farmer_registry>`) and **Social Registry** ({doc}`spp_base_social_registry </reference/modules/spp_base_social_registry>`) modules are mutually exclusive. You can only have one of them installed in a single Odoo database. Attempting to install multiple base modules will result in an error. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
| ::: | ||
|
|
||
| ### 1. SP-MIS installation (spp_base) | ||
|
|
||
| The Social Protection Management Information System ({doc}`SP-MIS <../overview/products/sp_mis>`) configuration provides comprehensive functionality for managing social protection programs. This setup is ideal for organizations running cash transfers, social assistance programs, or humanitarian interventions. | ||
|
|
||
| **What's included:** | ||
| - Registry management for individuals and groups | ||
| - Program cycles and beneficiary enrollment | ||
| - Eligibility determination and targeting | ||
| - Entitlement calculation and management | ||
| - Payment processing integration | ||
|
|
||
| **Installation steps:** | ||
|
|
||
| 1. Follow the General Installation Process to update your Apps list | ||
| 2. In the Apps menu, search for {doc}`spp_base </reference/modules/spp_base>` or "OpenSPP Base" | ||
|
|
||
|  | ||
|
|
||
| 3. Click the **Activate** button to install the module. This will also install all its dependencies, providing a complete SP-MIS foundation. | ||
|
|
||
|  | ||
|
|
||
| Once installed, you will see the "Registry" application in your Odoo dashboard, which is the main entry point for the OpenSPP system. | ||
|
|
||
|  | ||
|
|
||
| ### 2. Social Registry installation (spp_registry_base) | ||
|
|
||
| The {doc}`Social Registry <../overview/products/social_registry>` configuration provides a centralized repository for beneficiary data that can be shared across multiple social protection programs. This setup is ideal for governments and organizations coordinating multiple interventions and requiring a single source of truth for beneficiary information. | ||
|
|
||
| **What's included:** | ||
| - Unified beneficiary database across programs | ||
| - Advanced deduplication and data quality management | ||
| - Dynamic registration and needs assessment | ||
| - Inter-program data sharing and coordination | ||
| - Household composition and relationship tracking | ||
| - Socioeconomic data collection and analysis | ||
| - Data privacy and access control mechanisms | ||
|
|
||
| **Installation steps:** | ||
|
|
||
| 1. Follow the General Installation Process to update your Apps list | ||
| 2. In the Apps menu, search for {doc}`spp_registry_base </reference/modules/spp_registry_base>` or "OpenSPP Social Registry" | ||
| 3. Click the **Activate** button to install the module and its dependencies | ||
|
|
||
| Once installed, the Social Registry becomes the central hub for managing beneficiary data that can be accessed by various social protection programs. | ||
|
|
||
| ### 3. Farmer Registry installation (spp_farmer_registry_base) | ||
| ## Installing additional modules | ||
|
|
||
| The {doc}`Farmer Registry <../overview/products/farmer_registry>` configuration enables convergence between social protection and agricultural development programs. This setup is designed for organizations supporting smallholder farmers, managing agricultural subsidies, or implementing climate-smart agriculture initiatives. | ||
| After setting up your base system you can extend the functionality with additional modules. OpenSPP offers 60+ specialized modules covering various aspects of social protection delivery. | ||
|
|
||
| **What's included:** | ||
| - Farmer and farm household registration | ||
| - Land parcel mapping with GIS integration | ||
| - Crop and livestock tracking | ||
| - Agricultural input distribution management | ||
| - Seasonal cycle management | ||
| - Integration with agricultural extension services | ||
| :::{note} | ||
| Additional modules automatically detect and respect your base configuration (SP-MIS or Farmer Registry). Some modules are specific to one configuration, while others work with both. | ||
| ::: | ||
|
|
||
| **Installation steps:** | ||
| ## General installation process | ||
|
|
||
| 1. Follow the general installation process to update your Apps list | ||
| 2. In the Apps menu, search for {doc}`spp_farmer_registry_base </reference/modules/spp_farmer_registry_base>` or "OpenSPP Farmer Registry Base" | ||
| Installing an Odoo module, including those for OpenSPP, follows a standard procedure: | ||
|
|
||
|  | ||
| 1. Navigate to the **Apps** menu. | ||
|
|
||
| 3. Click the **Activate** button to install the module and its dependencies. | ||
| 2. Search for the desired module by its technical name or title. If the module does not show up, clear the default "Apps" filter from the search bar. | ||
|
|
||
|  | ||
| 3. Click the **Activate** button on the module's card to begin the installation. | ||
|
|
||
| ## Installing additional modules | ||
|  | ||
|
|
||
| After setting up your base system (either SP-MIS or Farmer Registry), you can extend functionality with additional modules. OpenSPP offers 60+ specialized modules covering various aspects of social protection delivery. | ||
| 4. Restart OpenSPP after installing the modules: | ||
| ```bash | ||
| sudo systemctl restart openspp | ||
| ``` | ||
|
|
||
| :::{note} | ||
| Additional modules automatically detect and respect your base configuration (SP-MIS or Farmer Registry). Some modules are specific to one configuration, while others work with both. | ||
| ::: | ||
| **Note**: The `queue_job` module, which is essential for asynchronous background tasks, is automatically installed as a dependency of the main OpenSPP modules. It is also pre-configured as a `server_wide_module`, ensuring that background workers can process jobs correctly after a service restart. | ||
|
|
||
| ### Common extension modules | ||
| ## Common extension modules | ||
|
|
||
| **Data management:** | ||
| - **Change request** ({doc}`spp_change_request </reference/modules/spp_change_request>`) - Workflow for reviewing and approving data modifications | ||
|
|
@@ -144,41 +66,11 @@ Additional modules automatically detect and respect your base configuration (SP- | |
| - **OpenID Connect** ({doc}`spp_oauth </reference/modules/spp_oauth>`) - Single sign-on and authentication | ||
| - **DCI API Server** ({doc}`spp_dci_api_server </reference/modules/spp_dci_api_server>`) - Data Collection Interface API | ||
|
|
||
| ### Example: Installing change request module | ||
|
|
||
| Let's walk through installing the {doc}`Change Request </reference/modules/spp_change_request>` module as an example: | ||
|
|
||
| **Steps:** | ||
|
|
||
| 1. Navigate to the **Apps** menu | ||
| 2. Search for {doc}`spp_change_request </reference/modules/spp_change_request>` or "OpenSPP Change Request" | ||
|
|
||
|  | ||
|
|
||
| 3. Click the **Activate** button. | ||
|
|
||
|  | ||
|
|
||
| ### Example: Installing cash entitlement module | ||
|
|
||
| The **OpenSPP Entitlement: Cash** ({doc}`spp_entitlement_cash </reference/modules/spp_entitlement_cash>`) module adds functionality to manage cash-based entitlements for registrants. | ||
|
|
||
| **Steps:** | ||
|
|
||
| 1. Navigate to the **Apps** menu. | ||
| 2. Search for {doc}`spp_entitlement_cash </reference/modules/spp_entitlement_cash>` or "OpenSPP Entitlement: Cash". | ||
|
|
||
|  | ||
|
|
||
| 3. Click the **Activate** button. | ||
|
|
||
|  | ||
|
|
||
| ## Module dependencies | ||
|
|
||
| OpenSPP modules often have dependencies that are automatically installed. Understanding these relationships helps with troubleshooting: | ||
|
|
||
| - **Core dependencies** are always installed (e.g., {doc}`spp_base </reference/modules/spp_base>` installs registry modules) | ||
| - **Core dependencies** are always installed (e.g., {doc}`spp_base_spmis </reference/modules/spp_base_spmis>` installs registry modules) | ||
| - **Optional dependencies** can be manually selected based on your needs | ||
| - **Conflicting modules** will show warnings during installation attempts | ||
|
|
||
|
|
@@ -214,3 +106,15 @@ After installing your modules: | |
| 4. **Test workflows** - Verify the installed features work as expected | ||
|
|
||
| For detailed configuration guides for specific modules, see the {doc}`../user_guide/index` and {doc}`../reference/modules/index`. | ||
|
|
||
| ```{toctree} | ||
| --- | ||
| caption: Getting Started | ||
| maxdepth: 2 | ||
| hidden: true | ||
| --- | ||
|
|
||
| spmis_installation | ||
| social_installation | ||
| farmer_installation | ||
| ``` | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| --- | ||
| myst: | ||
| html_meta: | ||
| "title": "OpenSPP Module Installation Guide" | ||
| "description": "Step-by-step guide for installing and configuring OpenSPP modules including SP-MIS, Social Registry, and Farmer Registry" | ||
| "keywords": "OpenSPP, modules, installation, Odoo, SP-MIS, Social Registry, Farmer Registry" | ||
| --- | ||
|
|
||
| # Social Registry installation | ||
|
|
||
| **OpenSPP Social Registry Base / spp_base_social_registry** | ||
|
|
||
| The {doc}`OpenSPP Social Registry <../overview/products/social_registry>` configuration provides a centralized repository for beneficiary data that can be shared across multiple social protection programs. This setup is ideal for governments and organizations coordinating multiple interventions and requiring a single source of truth for beneficiary information. | ||
|
|
||
| **What's included:** | ||
| - Unified beneficiary database across programs | ||
| - Advanced deduplication and data quality management | ||
| - Dynamic registration and needs assessment | ||
| - Inter-program data sharing and coordination | ||
| - Household composition and relationship tracking | ||
| - Socioeconomic data collection and analysis | ||
| - Data privacy and access control mechanisms | ||
|
|
||
| **Installation steps:** | ||
|
|
||
| 1. Navigate to the **Apps** menu. | ||
| 2. In the Apps menu, search for {doc}`spp_base_social_registry </reference/modules/spp_base_social_registry>` or "OpenSPP Social Registry Base" | ||
| 3. Click the **Activate** button to install the module and its dependencies | ||
| 4. Restart OpenSPP after installing the module: | ||
| ```bash | ||
| sudo systemctl restart openspp | ||
| ``` | ||
|
|
||
| **Note**: The `queue_job` module, which is essential for asynchronous background tasks, is automatically installed as a dependency of the main OpenSPP modules. It is also pre-configured as a `server_wide_module`, ensuring that background workers can process jobs correctly after a service restart. | ||
|
|
||
| Once installed, the Social Registry becomes the central hub for managing beneficiary data that can be accessed by various social protection programs. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Using
<br>tags for vertical spacing is generally discouraged in Markdown files as it mixes HTML presentation with content. Relying on Markdown's native paragraph spacing (blank lines) is preferred for readability and maintainability.