docs: Add missing line breaks for improved readability in documentation files

This commit is contained in:
Peter Wood
2025-05-26 08:04:39 -04:00
parent e90b9413de
commit 23d0d158f6
8 changed files with 76 additions and 1 deletions

View File

@@ -62,12 +62,14 @@ sudo ./backup-plex.sh --check-integrity --non-interactive
### 4. Test Notification Systems
#### Webhook Testing
```bash
# Replace with your actual webhook URL
sudo ./backup-plex.sh --check-integrity --webhook=https://your-webhook-endpoint.com/test
```
#### Email Testing
```bash
# Replace with your email address
sudo ./backup-plex.sh --check-integrity --email=admin@yourdomain.com
@@ -83,6 +85,7 @@ sudo ./backup-plex.sh --non-interactive
```
**Verify**:
- [ ] Plex service stopped and restarted properly
- [ ] Backup files created in `/mnt/share/media/backups/plex/YYYYMMDD/`
- [ ] Log files updated in `/mnt/share/media/backups/logs/`
@@ -194,6 +197,7 @@ Schedule weekly backup validation:
### Common Issues
#### 1. Permission Denied Errors
```bash
# Fix script permissions
chmod +x /home/acedanger/shell/*.sh
@@ -203,6 +207,7 @@ sudo chown -R $(whoami):$(whoami) /mnt/share/media/backups/
```
#### 2. Plex Service Issues
```bash
# Check Plex service status
sudo systemctl status plexmediaserver
@@ -212,6 +217,7 @@ sudo systemctl restart plexmediaserver
```
#### 3. Insufficient Disk Space
```bash
# Check available space
df -h /mnt/share/media/backups/
@@ -221,6 +227,7 @@ df -h /mnt/share/media/backups/
```
#### 4. Database Integrity Issues
```bash
# Run integrity check only
sudo ./backup-plex.sh --check-integrity --auto-repair
@@ -232,20 +239,24 @@ sudo ./backup-plex.sh --auto-repair
### Performance Optimization
#### 1. Parallel Processing
- Enable parallel verification for faster backups (default: enabled)
- Disable with `--no-parallel` if experiencing issues
#### 2. Performance Monitoring
- Disable with `--no-performance` if not needed
- Monitor trends to optimize backup timing
#### 3. Notification Optimization
- Use webhooks instead of email for faster notifications
- Configure webhook endpoints with proper error handling
## Security Considerations
### 1. File Permissions
```bash
# Secure backup files
chmod 600 /home/acedanger/shell/logs/plex-backup*.json
@@ -253,11 +264,13 @@ chmod 700 /mnt/share/media/backups/plex/
```
### 2. Webhook Security
- Use HTTPS endpoints for webhooks
- Implement webhook signature verification if possible
- Avoid including sensitive data in webhook payloads
### 3. Access Control
- Limit script execution to authorized users
- Consider using dedicated backup user account
- Regularly audit file access permissions
@@ -273,6 +286,7 @@ The script automatically manages backup retention:
## Recovery Planning
### 1. Backup Restoration
```bash
# List available backups
./restore-plex.sh --list
@@ -282,6 +296,7 @@ sudo ./restore-plex.sh --restore YYYYMMDD
```
### 2. Emergency Procedures
1. Stop Plex service: `sudo systemctl stop plexmediaserver`
2. Backup current data: `./restore-plex.sh --backup-current`
3. Restore from backup: `sudo ./restore-plex.sh --restore YYYYMMDD`
@@ -301,12 +316,14 @@ Monitor these metrics to ensure backup system health:
## Support and Updates
### Getting Help
1. Check logs for error messages
2. Run validation tools for diagnosis
3. Review troubleshooting guide
4. Test with `--check-integrity` for safe debugging
### Script Updates
- Keep scripts updated with latest features
- Test updates in non-production environment first
- Backup current scripts before updating