Skip to content

Commit eb0b7f0

Browse files
committed
[IMP] database management and maintenance
1 parent 4bbc270 commit eb0b7f0

2 files changed

Lines changed: 19 additions & 45 deletions

File tree

docs/user_guide/administration/database_management.md

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -23,27 +23,17 @@ If you need to reset your OpenSPP database (e.g., for testing or to start fresh)
2323
### Option B: Via Command Line
2424

2525
```bash
26-
# Stop OpenSPP service
2726
sudo systemctl stop openspp
28-
29-
# Drop the existing database
3027
sudo -u postgres dropdb openspp_prod
31-
32-
# Create a new empty database
3328
sudo -u postgres createdb openspp_prod
34-
35-
# Start OpenSPP service
3629
sudo systemctl start openspp
37-
38-
# Initialize the database with base modules
3930
sudo -u openspp openspp-server \
4031
--database=openspp_prod \
4132
--init=base \
4233
--stop-after-init
43-
44-
# Restart service
4534
sudo systemctl restart openspp
4635
```
36+
This will drop the database `openspp_prod` and re-create it.
4737

4838
**Warning**: Resetting the database will permanently delete all data, including:
4939
- All registrant records
@@ -58,12 +48,7 @@ sudo systemctl restart openspp
5848
Always create a backup before resetting:
5949

6050
```bash
61-
# Create backup directory
6251
sudo mkdir -p /var/backups/openspp
63-
64-
# Backup database
6552
sudo -u postgres pg_dump openspp_prod | gzip > /var/backups/openspp/db_backup_$(date +%Y%m%d_%H%M%S).sql.gz
66-
67-
# Backup filestore
6853
sudo tar -czf /var/backups/openspp/filestore_backup_$(date +%Y%m%d_%H%M%S).tar.gz /var/lib/openspp/filestore/openspp_prod
6954
```

docs/user_guide/administration/monitoring_maintenance.md

Lines changed: 18 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -11,30 +11,41 @@ This section provides basic instructions for monitoring your OpenSPP system, vie
1111

1212
## View Logs
1313

14+
### Real-time service logs
15+
1416
```bash
15-
# Real-time service logs
1617
sudo journalctl -u openspp -f
18+
```
1719

18-
# Application logs
20+
### Application logs
21+
```bash
1922
sudo tail -f /var/log/openspp/openspp.log
23+
```
2024

21-
# PostgreSQL logs
25+
### PostgreSQL logs
26+
```bash
2227
sudo tail -f /var/log/postgresql/postgresql-*.log
2328
```
2429

2530
## Service Management
2631

32+
### Restart service
2733
```bash
28-
# Restart service
2934
sudo systemctl restart openspp
35+
```
3036

31-
# Stop service
37+
### Stop service
38+
```bash
3239
sudo systemctl stop openspp
40+
```
3341

34-
# Start service
42+
### Start service
43+
```bash
3544
sudo systemctl start openspp
45+
```
3646

37-
# Reload configuration without restart
47+
### Reload configuration without restart
48+
```bash
3849
sudo systemctl reload openspp
3950
```
4051

@@ -43,44 +54,22 @@ sudo systemctl reload openspp
4354
When a new version is available:
4455

4556
```bash
46-
# Update package list
4757
sudo apt-get update
48-
49-
# Check for OpenSPP updates
5058
apt list --upgradable | grep openspp
51-
52-
# Stop service before upgrade
5359
sudo systemctl stop openspp
54-
55-
# Backup current installation
5660
sudo tar -czf /var/backups/openspp-backup-$(date +%Y%m%d).tar.gz /opt/openspp /etc/openspp
57-
58-
# Upgrade OpenSPP
5961
sudo apt-get upgrade openspp
60-
61-
# Start service
6262
sudo systemctl start openspp
63-
64-
# Update modules via web interface
6563
```
6664

6765
## Alternative: Manual Update
6866

6967
If updating manually:
7068

7169
```bash
72-
# Download new package from Nexus
7370
wget https://builds.acn.fr/repository/apt-openspp/pool/main/o/openspp/openspp_X.X.X_amd64.deb
74-
75-
# Stop service
7671
sudo systemctl stop openspp
77-
78-
# Backup current installation
7972
sudo tar -czf /var/backups/openspp-backup-$(date +%Y%m%d).tar.gz /opt/openspp /etc/openspp
80-
81-
# Install new version
8273
sudo dpkg -i openspp_X.X.X_amd64.deb
83-
84-
# Start service
8574
sudo systemctl start openspp
8675
```

0 commit comments

Comments
 (0)