3 Commits
Author SHA1 Message Date
m1saka c5db104734 docs: 添加 MIT 许可证
build / build (push) Successful in 1m32s
2026-07-08 01:00:45 +08:00
m1saka 3fdc6d2c08 docs: systemd 部署改用软链接 service 文件
build / build (push) Successful in 1m25s
将 service 文件放到安装目录,再软链接到 /etc/systemd/system,
便于更新时只改安装目录内的文件
2026-07-04 22:32:07 +08:00
m1saka d7b46c9ee3 docs: 下载链接改为 latest release 地址
build / build (push) Successful in 1m30s
安装与 systemd 部署章节改用 Gitea latest release 的下载链接,
省去从源码构建
2026-07-04 22:25:43 +08:00
2 changed files with 46 additions and 3 deletions
+21
View File
@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2026 M1saka
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
+25 -3
View File
@@ -13,6 +13,21 @@ A backup tool for Docker Compose projects with **minimal downtime** — stop, co
## Installation
### Download a pre-built binary (recommended)
Download the latest release for your architecture:
```bash
# linux amd64
curl -fsSL -o docker-compose-backup https://git.misaka.ren/m1saka/docker-compose-backup/releases/download/latest/docker-compose-backup-linux-amd64
# linux arm64
curl -fsSL -o docker-compose-backup https://git.misaka.ren/m1saka/docker-compose-backup/releases/download/latest/docker-compose-backup-linux-arm64
chmod +x docker-compose-backup
```
### Build from source
```bash
go build -o docker-compose-backup .
# or cross-compile:
@@ -51,11 +66,14 @@ This repository includes `docker-compose-backup.service`, configured for install
```bash
sudo mkdir -p /opt/docker-compose-backup
sudo cp docker-compose-backup-linux-arm64 /opt/docker-compose-backup/docker-compose-backup
# Download the latest release (pick amd64 or arm64 to match the host):
sudo curl -fsSL -o /opt/docker-compose-backup/docker-compose-backup \
https://git.misaka.ren/m1saka/docker-compose-backup/releases/download/latest/docker-compose-backup-linux-arm64
sudo chmod +x /opt/docker-compose-backup/docker-compose-backup
sudo cp config.yaml /opt/docker-compose-backup/config.yaml
sudo mkdir -p /opt/docker-compose-backup/backups /opt/docker-compose-backup/tmp
sudo cp docker-compose-backup.service /etc/systemd/system/
sudo cp docker-compose-backup.service /opt/docker-compose-backup/docker-compose-backup.service
sudo ln -sf /opt/docker-compose-backup/docker-compose-backup.service /etc/systemd/system/docker-compose-backup.service
sudo systemctl daemon-reload
sudo systemctl enable --now docker-compose-backup
```
@@ -100,6 +118,10 @@ projects:
Environment variables in `${VAR}` form are expanded automatically.
## License
MIT. See [LICENSE](LICENSE).
`exclude` uses Go `filepath.Match` patterns and also matches each file/directory basename. It is **not** full `.gitignore` syntax: `**` and negation rules like `!foo` are not supported.
## Commands
@@ -121,4 +143,4 @@ Global flags:
## Requirements
- Docker CLI accessible on `PATH`
- Go 1.26+ (to build from source)
- Go 1.26+ (to build from source)