docs: replace DEPLOYMENT.md with TROUBLESHOOTING.md and update README
- Remove redundant DEPLOYMENT.md file - Update README.md to reference TROUBLESHOOTING.md for deployment issues - Consolidate deployment documentation into comprehensive troubleshooting guide - Keep essential auto-starting services info in README for quick reference
This commit is contained in:
@@ -284,25 +284,8 @@ go test ./cmd/server/tests -v # Integration tests only
|
|||||||
|
|
||||||
## 🐳 Deployment
|
## 🐳 Deployment
|
||||||
|
|
||||||
### Docker Configuration
|
For detailed deployment instructions, Docker configuration, and troubleshooting common issues, see **[TROUBLESHOOTING.md](TROUBLESHOOTING.md)**.
|
||||||
```yaml
|
|
||||||
# docker-compose.yml
|
|
||||||
services:
|
|
||||||
bookmann:
|
|
||||||
build: .
|
|
||||||
ports:
|
|
||||||
- "8765:8765"
|
|
||||||
environment:
|
|
||||||
- JWT_SECRET=${JWT_SECRET}
|
|
||||||
- DBHOST=db
|
|
||||||
depends_on:
|
|
||||||
- db
|
|
||||||
volumes:
|
|
||||||
- /path/to/media:/media # Mount media directories
|
|
||||||
- /path/to/uploads:/uploads # Upload directory
|
|
||||||
```
|
|
||||||
|
|
||||||
### Auto-Starting Services
|
|
||||||
The application automatically starts background services on startup:
|
The application automatically starts background services on startup:
|
||||||
- **Scheduler**: Manages scheduled scanning jobs based on user settings
|
- **Scheduler**: Manages scheduled scanning jobs based on user settings
|
||||||
- **Watch Mode**: Monitors all library folders for file system changes
|
- **Watch Mode**: Monitors all library folders for file system changes
|
||||||
|
|||||||
@@ -1,15 +1,6 @@
|
|||||||
# 🚀 Deployment & Portability Guide
|
# 🛠️ Troubleshooting Guide
|
||||||
|
|
||||||
This guide addresses potential issues when building and running Bookmann on another machine.
|
This guide addresses common issues when deploying and running Bookmann on different environments.
|
||||||
|
|
||||||
## ✅ Current Status
|
|
||||||
|
|
||||||
**What Works:**
|
|
||||||
- ✅ Docker containers build and start successfully
|
|
||||||
- ✅ Database schema loads correctly with all tables
|
|
||||||
- ✅ Application connects to database and starts
|
|
||||||
- ✅ API endpoints respond correctly
|
|
||||||
- ✅ All highlights and notes functionality included
|
|
||||||
|
|
||||||
## ⚠️ Potential Issues & Solutions
|
## ⚠️ Potential Issues & Solutions
|
||||||
|
|
||||||
@@ -131,9 +122,24 @@ curl -s http://localhost:8765/api/libraries/visible
|
|||||||
curl -s http://SERVER_IP:8765/api/libraries/visible
|
curl -s http://SERVER_IP:8765/api/libraries/visible
|
||||||
```
|
```
|
||||||
|
|
||||||
## 🔧 Recommended Build Process
|
## 🚀 Quick Verification
|
||||||
|
|
||||||
### First Time Setup:
|
### Basic Health Checks:
|
||||||
|
```bash
|
||||||
|
# Check container status
|
||||||
|
docker compose ps
|
||||||
|
|
||||||
|
# Test database connection
|
||||||
|
docker compose exec db psql -U postgres -d bookmann -c "SELECT 1;"
|
||||||
|
|
||||||
|
# Test API endpoint
|
||||||
|
curl -s http://localhost:8765/api/libraries/visible
|
||||||
|
|
||||||
|
# Check application logs
|
||||||
|
docker compose logs app
|
||||||
|
```
|
||||||
|
|
||||||
|
### First-Time Setup:
|
||||||
```bash
|
```bash
|
||||||
# 1. Clone repository
|
# 1. Clone repository
|
||||||
git clone <repository-url>
|
git clone <repository-url>
|
||||||
@@ -152,9 +158,11 @@ docker compose ps
|
|||||||
curl -s http://localhost:8765/api/libraries/visible
|
curl -s http://localhost:8765/api/libraries/visible
|
||||||
```
|
```
|
||||||
|
|
||||||
### For Production Deployment:
|
## 🌐 Production Deployment
|
||||||
|
|
||||||
|
### Environment Variables:
|
||||||
```bash
|
```bash
|
||||||
# Use production-ready environment variables
|
# Required production variables
|
||||||
export JWT_SECRET="your-production-jwt-secret"
|
export JWT_SECRET="your-production-jwt-secret"
|
||||||
export DBPASS="your-production-db-password"
|
export DBPASS="your-production-db-password"
|
||||||
|
|
||||||
@@ -268,13 +276,20 @@ The highlights and notes functionality provides:
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 📞 If Issues Persist
|
## 🆘 When All Else Fails
|
||||||
|
|
||||||
|
### Last Resort Steps:
|
||||||
1. **Check this guide** for common solutions
|
1. **Check this guide** for common solutions
|
||||||
2. **Verify environment variables** are set correctly
|
2. **Verify environment variables** are set correctly
|
||||||
3. **Ensure no port conflicts** on the target machine
|
3. **Ensure no port conflicts** on the target machine
|
||||||
4. **Check Docker compatibility** (Docker vs Podman)
|
4. **Check Docker compatibility** (Docker vs Podman)
|
||||||
5. **Review logs** for specific error messages
|
5. **Review logs** for specific error messages
|
||||||
6. **Test incrementally**: Start with basic setup, then add complexity
|
6. **Test incrementally** - Start with basic setup, then add complexity
|
||||||
|
|
||||||
|
### Get Help:
|
||||||
|
- **Check GitHub Issues** for known problems
|
||||||
|
- **Verify Docker version** compatibility
|
||||||
|
- **Test with minimal setup** before adding customizations
|
||||||
|
- **Check system resources** (memory, disk space)
|
||||||
|
|
||||||
The system is designed to be robust and should work across different platforms with minimal configuration.
|
The system is designed to be robust and should work across different platforms with minimal configuration.
|
||||||
Reference in New Issue
Block a user