Merge pull request #85 from OpenSPP/refactor-structure-michael

[IMP] database management and maintenance

Author: emjay0921

docs/user_guide/administration/database_management.md

@@ -17,27 +17,17 @@ If you need to reset your OpenSPP database (e.g., for testing or to start fresh)
 ### Option B: Via Command Line
 
 ```bash
-# Stop OpenSPP service
 sudo systemctl stop openspp
-
-# Drop the existing database
 sudo -u postgres dropdb openspp_prod
-
-# Create a new empty database
 sudo -u postgres createdb openspp_prod
-
-# Start OpenSPP service
 sudo systemctl start openspp
-
-# Initialize the database with base modules
 sudo -u openspp openspp-server \
     --database=openspp_prod \
     --init=base \
     --stop-after-init
-
-# Restart service
 sudo systemctl restart openspp
 ```
+This will drop the database `openspp_prod` and re-create it.
 
 **Warning**: Resetting the database will permanently delete all data, including:
 - All registrant records
@@ -52,12 +42,7 @@ sudo systemctl restart openspp
 Always create a backup before resetting:
 
 ```bash
-# Create backup directory
 sudo mkdir -p /var/backups/openspp
-
-# Backup database
 sudo -u postgres pg_dump openspp_prod | gzip > /var/backups/openspp/db_backup_$(date +%Y%m%d_%H%M%S).sql.gz
-
-# Backup filestore
 sudo tar -czf /var/backups/openspp/filestore_backup_$(date +%Y%m%d_%H%M%S).tar.gz /var/lib/openspp/filestore/openspp_prod
 ```

docs/user_guide/administration/monitoring_maintenance.md

@@ -5,30 +5,41 @@ This section provides basic instructions for monitoring your OpenSPP system, vie
 
 ## View Logs
 
+### Real-time service logs
+
 ```bash
-# Real-time service logs
 sudo journalctl -u openspp -f
+```
 
-# Application logs
+### Application logs
+```bash
 sudo tail -f /var/log/openspp/openspp.log
+```
 
-# PostgreSQL logs
+### PostgreSQL logs
+```bash
 sudo tail -f /var/log/postgresql/postgresql-*.log
 ```
 
 ## Service Management
 
+### Restart service
 ```bash
-# Restart service
 sudo systemctl restart openspp
+```
 
-# Stop service
+### Stop service
+```bash
 sudo systemctl stop openspp
+```
 
-# Start service
+### Start service
+```bash
 sudo systemctl start openspp
+```
 
-# Reload configuration without restart
+### Reload configuration without restart
+```bash
 sudo systemctl reload openspp
 ```
 
@@ -37,44 +48,22 @@ sudo systemctl reload openspp
 When a new version is available:
 
 ```bash
-# Update package list
 sudo apt-get update
-
-# Check for OpenSPP updates
 apt list --upgradable | grep openspp
-
-# Stop service before upgrade
 sudo systemctl stop openspp
-
-# Backup current installation
 sudo tar -czf /var/backups/openspp-backup-$(date +%Y%m%d).tar.gz /opt/openspp /etc/openspp
-
-# Upgrade OpenSPP
 sudo apt-get upgrade openspp
-
-# Start service
 sudo systemctl start openspp
-
-# Update modules via web interface
 ```
 
 ## Alternative: Manual Update
 
 If updating manually:
 
 ```bash
-# Download new package from Nexus
 wget https://builds.acn.fr/repository/apt-openspp/pool/main/o/openspp/openspp_X.X.X_amd64.deb
-
-# Stop service
 sudo systemctl stop openspp
-
-# Backup current installation
 sudo tar -czf /var/backups/openspp-backup-$(date +%Y%m%d).tar.gz /opt/openspp /etc/openspp
-
-# Install new version
 sudo dpkg -i openspp_X.X.X_amd64.deb
-
-# Start service
 sudo systemctl start openspp
 ```