Update README.md to streamline content by removing redundant sections and enhancing clarity
All checks were successful
continuous-integration/drone/push Build is passing

This commit is contained in:
gyurix
2025-08-26 17:41:18 +02:00
parent 3271d4ae9f
commit 3fc500ce86

View File

@@ -28,25 +28,17 @@ The container automatically:
User Setup: Creates the backup user with configured credentials
SSH Configuration: Generates host keys (RSA and Ed25519) if not present
Server Start: Launches SSH daemon with SFTP support
Monitoring: Watches for configuration changes and reloads SSH server as needed
Key Components
Dockerfile: Alpine-based image with OpenSSH, su-exec, and BorgBackup
start_backup.sh: Main entrypoint script handling SSH setup and monitoring
start_backup.sh: Main entrypoint script handling SSH setup
.drone.yml: CI/CD pipeline for multi-architecture builds
Architecture
┌─────────────────┐ ┌──────────────────┐ ┌─────────────────┐
│ SSH Client │───▶│ Docker Container │───▶│ Backup Storage │
│ (Your backup │ │ (Alpine Linux) │ │ (/home/backup)│
│ application) │ │ │ │ │
└─────────────────┘ └──────────────────┘ └─────────────────┘
│ (Your backup │ │ (Alpine Linux) │ │ (/home/backup)│
Security Features
Host Key Persistence: SSH host keys are generated once and persisted
Configurable Authentication: Supports both password and public key authentication
User Isolation: Runs SSH daemon as non-root user
SFTP Subsystem: Secure file transfer protocol support
Development
Building Locally
Testing
@@ -56,12 +48,7 @@ The project uses Drone CI for automated builds:
Development builds: Push to registry.dev.format.hu/backup-client
Release builds: Tag events push to safebox/backup-client on DockerHub
Multi-architecture: Supports both AMD64 and ARM64 platforms
Contributing
Fork the repository
Create a feature branch
Make your changes
Test the Docker build
Submit a pull request
License
This project is open source. Please check the license file for details.