Update README with Docker quick start and development warning
DOCUMENTATION UPDATE: Added comprehensive Docker instructions to README: CHANGES: - Added "🚧 IN DEVELOPMENT" warning to Docker section - Emphasized native Linux installer as stable production version - Added step-by-step Quick Start instructions: 1. Build the image 2. Run container with volume mounts 3. Configure via web UI - Included examples for different backup paths - Added "Configuration UI" to features list - Clarified Settings page workflow ORGANIZATION: - Docker section appears AFTER all native Linux sections - Clear warning that Docker is for testing/cross-platform use - Native Linux positioned as primary, stable solution This makes it clear to users: - Native Linux = Production ready ✅ - Docker = Development/Testing 🚧 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
parent
efba1948f6
commit
583a289523
1 changed files with 36 additions and 4 deletions
40
README.md
40
README.md
|
|
@ -208,24 +208,56 @@ cd ~/dev/PBSClientTool
|
||||||
sudo ./uninstaller.sh
|
sudo ./uninstaller.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
## Docker Solution (Windows/Mac)
|
## Docker Solution (Windows/Mac) - 🚧 IN DEVELOPMENT
|
||||||
|
|
||||||
|
> ⚠️ **Note:** The Docker solution is currently in active development. The native Linux installer above is the **stable, production-ready version**. Use Docker for cross-platform testing or if you need Windows/Mac support.
|
||||||
|
|
||||||
Want to backup Windows or macOS systems? Use the Docker-based solution:
|
Want to backup Windows or macOS systems? Use the Docker-based solution:
|
||||||
|
|
||||||
|
### Quick Start
|
||||||
|
|
||||||
|
**1. Build the image:**
|
||||||
```bash
|
```bash
|
||||||
cd docker
|
cd docker
|
||||||
./build.sh
|
./build.sh
|
||||||
./deploy.sh
|
|
||||||
```
|
```
|
||||||
|
|
||||||
The Docker solution provides:
|
**2. Run the container:**
|
||||||
|
```bash
|
||||||
|
docker run -d \
|
||||||
|
--name pbs-backup \
|
||||||
|
-p 8080:8080 \
|
||||||
|
-v /path/to/backup:/host-data:ro \
|
||||||
|
-v pbs-config:/config \
|
||||||
|
-v pbs-logs:/logs \
|
||||||
|
-e MODE=daemon \
|
||||||
|
-e ENABLE_API=true \
|
||||||
|
pbsclient:latest
|
||||||
|
```
|
||||||
|
|
||||||
|
Replace `/path/to/backup` with your data directory:
|
||||||
|
- **Home directory**: `-v /home/username:/host-data:ro`
|
||||||
|
- **Entire system**: `-v /:/host-data:ro`
|
||||||
|
- **Specific folder**: `-v /data:/host-data:ro`
|
||||||
|
|
||||||
|
**3. Configure via web UI:**
|
||||||
|
- Open http://localhost:8080
|
||||||
|
- Click **⚙ Settings**
|
||||||
|
- Enter your PBS server details
|
||||||
|
- Click **💾 Save Configuration**
|
||||||
|
- Click **▶ Run Backup Now** to test
|
||||||
|
|
||||||
|
### What It Provides
|
||||||
|
|
||||||
- **Cross-platform** - Works on Windows, macOS, and Linux
|
- **Cross-platform** - Works on Windows, macOS, and Linux
|
||||||
- **Web Dashboard** - Real-time monitoring with retro terminal UI (http://localhost:8080)
|
- **Web Dashboard** - Real-time monitoring with retro terminal UI
|
||||||
|
- **Configuration UI** - Set up PBS backups from your browser
|
||||||
- **REST API** - Remote management and monitoring
|
- **REST API** - Remote management and monitoring
|
||||||
- **File-level backups** - Daily automated backups
|
- **File-level backups** - Daily automated backups
|
||||||
- **Easy deployment** - Single container, simple configuration
|
- **Easy deployment** - Single container, simple configuration
|
||||||
|
|
||||||
**Web Dashboard Features:**
|
**Web Dashboard Features:**
|
||||||
|
- Settings page for PBS configuration
|
||||||
- Live backup status and progress
|
- Live backup status and progress
|
||||||
- System health monitoring
|
- System health monitoring
|
||||||
- Backup history and logs
|
- Backup history and logs
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue