Skip to content

Commit 20e775d

Browse files
committed
[IMP] uninstalling
1 parent 96ca993 commit 20e775d

2 files changed

Lines changed: 47 additions & 49 deletions

File tree

docs/getting_started/installation_deb.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -303,5 +303,5 @@ Now that OpenSPP is installed, here are some recommended next steps:
303303

304304
- **Learn to Use OpenSPP**: Start with the {doc}`../user_guide/index` to understand core features.
305305
- **Administer the System**: Refer to the {doc}`../user_guide/administration/index` for guides on security, maintenance, and troubleshooting.
306-
- **Customize and Develop**: Explore the {doc}`../developer_guide/index` to learn how to extend the platform.
306+
- **Customize and Develop**: Explore the {doc}`../developer_guide/index` to learn how to extend the platform.
307307
- **Set Up a Pilot Program**: Follow the {doc}`../overview/poc_and_pilot` guide to launch a Proof of Concept (PoC).

docs/user_guide/administration/uninstalling.md

Lines changed: 46 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -7,111 +7,109 @@ migration-notes: "Added during 2025 documentation reorganization"
77

88
# Uninstalling OpenSPP
99

10-
This guide provides detailed instructions for uninstalling OpenSPP from your system. It covers both complete removal, which includes deleting the application, configuration files, and database, as well as a partial uninstallation that keeps your data intact for future use.
10+
This guide provides instructions for uninstalling OpenSPP from a Debian or Ubuntu system. It covers two main scenarios:
11+
- **Complete Uninstallation**: Removes the application, configuration, data, and database.
12+
- **Partial Uninstallation**: Removes the application but keeps your data and configuration for future use.
13+
14+
## Before You Begin: Back Up Your Data
15+
16+
**Warning**: A complete uninstallation is irreversible and will permanently delete your data. Before proceeding, it is strongly recommended to create a full backup of your database and filestore.
17+
18+
For detailed backup instructions, refer to the {doc}`database_management` guide.
1119

1220
## Complete Uninstallation
1321

14-
To completely remove OpenSPP from your system:
22+
Follow these steps to completely remove OpenSPP and all its components from your system.
1523

16-
### Step 1: Stop and Disable Services
24+
### Step 1: Stop and Disable the OpenSPP Service
1725

26+
**Stop OpenSPP service**
1827
```bash
19-
# Stop OpenSPP service
2028
sudo systemctl stop openspp
29+
```
2130

22-
# Disable service from starting on boot
31+
**Disable service from starting on boot**
32+
```bash
2333
sudo systemctl disable openspp
24-
25-
# Remove systemd service file
26-
sudo rm -f /etc/systemd/system/openspp.service
27-
sudo rm -f /lib/systemd/system/openspp.service
28-
29-
# Reload systemd
30-
sudo systemctl daemon-reload
3134
```
3235

3336
### Step 2: Remove OpenSPP Package
3437

38+
**Remove OpenSPP package**
3539
```bash
36-
# Remove OpenSPP package
3740
sudo apt-get remove --purge openspp-17-daily
41+
```
3842

39-
# Remove configuration files
40-
sudo rm -rf /etc/openspp
41-
42-
# Remove data directories
43-
sudo rm -rf /var/lib/openspp
44-
sudo rm -rf /var/log/openspp
45-
46-
# Remove binary files
47-
sudo rm -f /usr/bin/openspp-server
48-
sudo rm -f /usr/bin/openspp-shell
43+
**Remove configuration files**
44+
```bash
45+
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
4946
```
5047

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

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

52+
53+
**Drop the OpenSPP database**
5554
```bash
56-
# Drop the OpenSPP database
5755
sudo -u postgres dropdb openspp_prod
56+
```
5857

59-
# Remove the OpenSPP PostgreSQL user
58+
**Remove the OpenSPP PostgreSQL user**
59+
```bash
6060
sudo -u postgres dropuser openspp
6161
```
6262

6363
### Step 4: Remove Repository Configuration
6464

65+
**Remove APT repository configuration**
6566
```bash
66-
# Remove APT repository configuration
6767
sudo rm -f /etc/apt/sources.list.d/openspp.list
68+
```
6869

69-
# Remove GPG key (if added)
70+
**Remove GPG key (if added)**
71+
```bash
7072
sudo apt-key del "OpenSPP Repository"
73+
```
7174

72-
# Update package list
75+
**Update package list**
76+
```bash
7377
sudo apt-get update
7478
```
7579

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

7882
If you want to remove PostgreSQL as well:
7983

84+
**Remove PostgreSQL**
8085
```bash
81-
# Remove PostgreSQL
8286
sudo apt-get remove --purge postgresql postgresql-client postgresql-common
87+
```
8388

84-
# Remove PostgreSQL data
85-
sudo rm -rf /var/lib/postgresql
86-
87-
# Remove PostgreSQL configuration
88-
sudo rm -rf /etc/postgresql
89+
**Remove PostgreSQL data and configuration**
90+
```bash
91+
sudo rm -rf /var/lib/postgresql && sudo rm -rf /etc/postgresql
8992
```
9093

9194
## Partial Uninstallation
9295

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

98+
99+
**Stop and disable OpenSPP service**
95100
```bash
96-
# Stop service
97101
sudo systemctl stop openspp
98102
sudo systemctl disable openspp
103+
```
99104

100-
# Remove package but keep configuration
105+
**Remove package but keep configuration**
106+
```bash
101107
sudo apt-get remove openspp-17-daily
102-
103-
# Keep database and filestore for potential reinstallation
104-
# /var/lib/openspp/ and PostgreSQL database remain intact
105108
```
106109

107-
## Reinstall After Uninstallation
110+
- Keep database and filestore for potential reinstallation
111+
- var/lib/openspp/ and PostgreSQL database remain intact
108112

109-
To reinstall OpenSPP after uninstallation:
113+
## Reinstall After Uninstallation
110114

111-
```bash
112-
# Follow the installation steps from the beginning
113-
# If you kept the database, you can reuse it by:
114-
# 1. Reinstall OpenSPP
115-
# 2. Update configuration to point to existing database
116-
# 3. Start service
117-
```
115+
To reinstall OpenSPP after uninstallation, follow the {doc}`../getting_started/installation_deb`.

0 commit comments

Comments
 (0)