Skip to content

Commit 1d06fde

Browse files
committed
[IMP] Administration arrangement and uninstalling doc
1 parent 8b0b914 commit 1d06fde

3 files changed

Lines changed: 28 additions & 45 deletions

File tree

docs/user_guide/administration/index.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,47 +11,47 @@ This section provides guides for a variety of administrative tasks and system ma
1111

1212
- {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.
1313

14-
- {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.
15-
1614
- {doc}`custom_fields`: A step-by-step guide on how to add new data fields to registrant profiles without needing to write any code.
1715

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

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

20+
- {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.
21+
2222
- {doc}`inventory_configuration`: Learn how to configure the necessary inventory settings to support in-kind and basket entitlements.
2323

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

26-
- {doc}`hardware_integration`: This document provides an overview of how to integrate hardware devices, such as document scanners, with OpenSPP.
27-
2826
- {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.
2927

30-
- {doc}`monitoring_maintenance`: This document provides basic instructions for monitoring your OpenSPP system, viewing logs, managing services, and performing updates.
31-
3228
- {doc}`security_tuning`: This guide provides essential recommendations for securing your OpenSPP instance and tuning its performance for production environments.
3329

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

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

34+
- {doc}`hardware_integration`: This document provides an overview of how to integrate hardware devices, such as document scanners, with OpenSPP.
35+
36+
- {doc}`troubleshooting`: This guide provides solutions to common problems encountered while running OpenSPP.
37+
3838

3939
```{toctree}
4040
:maxdepth: 2
4141
:caption: Contents
4242
:hidden:
4343
4444
user_access
45-
service_points
4645
custom_fields
4746
indicator_fields
4847
import_areas
48+
service_points
4949
inventory_configuration
5050
email_gateway
51-
hardware_integration
5251
database_management
53-
monitoring_maintenance
5452
security_tuning
55-
troubleshooting
53+
monitoring_maintenance
5654
uninstalling
55+
hardware_integration
56+
troubleshooting
5757
```

docs/user_guide/administration/security_tuning.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ reviewer: migration-script
55
migration-notes: "Added during 2025 documentation reorganization"
66
---
77

8-
# Security Recommendations and Performance Tuning
8+
# Security and Performance Tuning
99

1010
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.
1111

docs/user_guide/administration/uninstalling.md

Lines changed: 16 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -25,79 +25,62 @@ Follow these steps to completely remove OpenSPP and all its components from your
2525

2626
**Stop and Disable (Remove) OpenSPP service**
2727
```bash
28-
sudo systemctl stop openspp && sudo systemctl disable openspp
28+
sudo systemctl stop openspp
29+
sudo systemctl disable openspp
2930
```
3031

3132
### Step 2: Remove OpenSPP Package
3233

33-
**Remove OpenSPP package**
34+
**Remove OpenSPP package and configuration files**
3435
```bash
3536
sudo apt-get remove --purge openspp-17-daily
36-
```
37-
38-
**Remove configuration files**
39-
```bash
40-
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
37+
sudo rm -rf /etc/openspp
38+
sudo rm -rf /var/lib/openspp
39+
sudo rm -rf /var/log/openspp
40+
sudo rm -f /usr/bin/openspp-server
41+
sudo rm -f /usr/bin/openspp-shell
4142
```
4243

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

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

4748

48-
**Drop the OpenSPP database**
49+
**Drop the OpenSPP database and remove the user**
4950
```bash
5051
sudo -u postgres dropdb name_of_your_db
51-
```
52-
53-
**Remove the OpenSPP PostgreSQL user**
54-
```bash
5552
sudo -u postgres dropuser openspp
5653
```
5754

5855
### Step 4: Remove Repository Configuration
5956

60-
**Remove APT repository configuration**
57+
**Remove APT repository configuration and GPG Key**
6158
```bash
6259
sudo rm -f /etc/apt/sources.list.d/openspp.list
63-
```
64-
65-
**Remove GPG key (if added)**
66-
```bash
6760
sudo apt-key del "OpenSPP Repository"
68-
```
69-
70-
**Update package list**
71-
```bash
7261
sudo apt-get update
7362
```
7463

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

7766
If you want to remove PostgreSQL as well:
7867

79-
**Remove PostgreSQL**
68+
**Remove PostgreSQL and its data and configuration**
8069
```bash
8170
sudo apt-get remove --purge postgresql postgresql-client postgresql-common
82-
```
83-
84-
**Remove PostgreSQL data and configuration**
85-
```bash
86-
sudo rm -rf /var/lib/postgresql && sudo rm -rf /etc/postgresql
71+
sudo rm -rf /var/lib/postgresql
72+
sudo rm -rf /etc/postgresql
8773
```
8874

8975
## Partial Uninstallation
9076

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

9379

94-
**Stop and disable OpenSPP service**
95-
```bash
96-
sudo systemctl stop openspp && sudo systemctl disable openspp
97-
```
98-
99-
**Remove package but keep configuration**
80+
**Stop, Disable(remove) service, and remove package**
10081
```bash
82+
sudo systemctl stop openspp
83+
sudo systemctl disable openspp
10184
sudo apt-get remove openspp-17-daily
10285
```
10386

0 commit comments

Comments
 (0)