Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions docs/user_guide/administration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,47 +11,47 @@ This section provides guides for a variety of administrative tasks and system ma

- {doc}`user_access`: Learn how to manage user accounts, assign roles, and configure access rights to control what users can see and do within OpenSPP.

- {doc}`service_points`: This guide explains how to set up and manage service points, which are the locations where beneficiaries can access services and benefits.

- {doc}`custom_fields`: A step-by-step guide on how to add new data fields to registrant profiles without needing to write any code.

- {doc}`indicator_fields`: Learn how to create dynamic data fields that automatically calculate values based on other information in the registry.

- {doc}`import_areas`: This document provides instructions on how to prepare and import geographical area data into OpenSPP.

- {doc}`service_points`: This guide explains how to set up and manage service points, which are the locations where beneficiaries can access services and benefits.

- {doc}`inventory_configuration`: Learn how to configure the necessary inventory settings to support in-kind and basket entitlements.

- {doc}`email_gateway`: A guide to configuring both outgoing and incoming email servers to enable automated communication and data entry.

- {doc}`hardware_integration`: This document provides an overview of how to integrate hardware devices, such as document scanners, with OpenSPP.

- {doc}`database_management`: This document explains how to manage your OpenSPP database, including how to reset the database, and how to back up your data before making major changes.

- {doc}`monitoring_maintenance`: This document provides basic instructions for monitoring your OpenSPP system, viewing logs, managing services, and performing updates.

- {doc}`security_tuning`: This guide provides essential recommendations for securing your OpenSPP instance and tuning its performance for production environments.

- {doc}`troubleshooting`: This guide provides solutions to common problems encountered while running OpenSPP.
- {doc}`monitoring_maintenance`: This document provides basic instructions for monitoring your OpenSPP system, viewing logs, managing services, and performing updates.

- {doc}`uninstalling`: This guide provides detailed instructions for uninstalling OpenSPP from your system.

- {doc}`hardware_integration`: This document provides an overview of how to integrate hardware devices, such as document scanners, with OpenSPP.

- {doc}`troubleshooting`: This guide provides solutions to common problems encountered while running OpenSPP.


```{toctree}
:maxdepth: 2
:caption: Contents
:hidden:

user_access
service_points
custom_fields
indicator_fields
import_areas
service_points
inventory_configuration
email_gateway
hardware_integration
database_management
monitoring_maintenance
security_tuning
troubleshooting
monitoring_maintenance
uninstalling
hardware_integration
troubleshooting
```
2 changes: 1 addition & 1 deletion docs/user_guide/administration/security_tuning.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ reviewer: migration-script
migration-notes: "Added during 2025 documentation reorganization"
---

# Security Recommendations and Performance Tuning
# Security and Performance Tuning

This guide provides essential recommendations for securing your OpenSPP instance and tuning its performance for production environments. It covers database security, firewall setup, SSL/TLS configuration with Nginx, and implementing regular backups. Additionally, it offers tips on performance tuning, including adjusting worker processes, memory limits, and PostgreSQL settings to handle high-load scenarios.

Expand Down
49 changes: 16 additions & 33 deletions docs/user_guide/administration/uninstalling.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,79 +25,62 @@ Follow these steps to completely remove OpenSPP and all its components from your

**Stop and Disable (Remove) OpenSPP service**
```bash
sudo systemctl stop openspp && sudo systemctl disable openspp
sudo systemctl stop openspp
sudo systemctl disable openspp
```

### Step 2: Remove OpenSPP Package

**Remove OpenSPP package**
**Remove OpenSPP package and configuration files**
```bash
sudo apt-get remove --purge openspp-17-daily
```

**Remove configuration files**
```bash
sudo rm -rf /etc/openspp && sudo rm -rf /var/lib/openspp && sudo rm -rf /var/log/openspp && sudo rm -f /usr/bin/openspp-server && sudo rm -f /usr/bin/openspp-shell
sudo rm -rf /etc/openspp
sudo rm -rf /var/lib/openspp
sudo rm -rf /var/log/openspp
sudo rm -f /usr/bin/openspp-server
sudo rm -f /usr/bin/openspp-shell
```

### Step 3: Remove PostgreSQL Database (Optional)

**Warning**: This will permanently delete all OpenSPP data.


**Drop the OpenSPP database**
**Drop the OpenSPP database and remove the user**
```bash
sudo -u postgres dropdb name_of_your_db
```

**Remove the OpenSPP PostgreSQL user**
```bash
sudo -u postgres dropuser openspp
```

### Step 4: Remove Repository Configuration

**Remove APT repository configuration**
**Remove APT repository configuration and GPG Key**
```bash
sudo rm -f /etc/apt/sources.list.d/openspp.list
```

**Remove GPG key (if added)**
```bash
sudo apt-key del "OpenSPP Repository"
```

**Update package list**
```bash
sudo apt-get update
Comment on lines 59 to 61
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

critical

The apt-key command is deprecated and its use will fail on the documented target platforms of Debian 12 and Ubuntu 24.04. This makes the uninstallation instructions incorrect and will prevent users from successfully removing the repository configuration.

To fix this, the GPG key management should be updated to follow modern best practices, which involves storing the key in /usr/share/keyrings. This would require a corresponding change in the installation guide.

Assuming the installation guide is updated to save the key at /usr/share/keyrings/openspp-archive-keyring.gpg, the uninstallation commands should be updated to remove that file directly instead of using apt-key.

Suggested change
sudo rm -f /etc/apt/sources.list.d/openspp.list
```
**Remove GPG key (if added)**
```bash
sudo apt-key del "OpenSPP Repository"
```
**Update package list**
```bash
sudo apt-get update
sudo rm -f /etc/apt/sources.list.d/openspp.list
sudo rm -f /usr/share/keyrings/openspp-archive-keyring.gpg
sudo apt-get update

```

### Step 5: Clean Up Dependencies (Optional)

If you want to remove PostgreSQL as well:

**Remove PostgreSQL**
**Remove PostgreSQL and its data and configuration**
```bash
sudo apt-get remove --purge postgresql postgresql-client postgresql-common
```

**Remove PostgreSQL data and configuration**
```bash
sudo rm -rf /var/lib/postgresql && sudo rm -rf /etc/postgresql
sudo rm -rf /var/lib/postgresql
sudo rm -rf /etc/postgresql
```

## Partial Uninstallation

If you want to keep the database but remove the application:


**Stop and disable OpenSPP service**
```bash
sudo systemctl stop openspp && sudo systemctl disable openspp
```

**Remove package but keep configuration**
**Stop, Disable(remove) service, and remove package**
```bash
sudo systemctl stop openspp
sudo systemctl disable openspp
sudo apt-get remove openspp-17-daily
```

Expand Down