diff --git a/README.md b/README.md index 6d86288..df3d1f7 100644 --- a/README.md +++ b/README.md @@ -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.