{"id":16970764,"url":"https://github.com/cs-tao/docker-cron-backup","last_synced_at":"2026-05-05T09:32:01.377Z","repository":{"id":92459685,"uuid":"237884574","full_name":"CS-Tao/docker-cron-backup","owner":"CS-Tao","description":"定时使用 sftp 将远程服务器的文件或文件夹备份到本地","archived":false,"fork":false,"pushed_at":"2020-02-09T09:59:13.000Z","size":12,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-22T06:36:45.057Z","etag":null,"topics":["backup-script","dockerfile","sftp"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CS-Tao.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-02-03T04:26:39.000Z","updated_at":"2020-02-09T09:59:15.000Z","dependencies_parsed_at":"2023-06-02T12:45:33.432Z","dependency_job_id":null,"html_url":"https://github.com/CS-Tao/docker-cron-backup","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/CS-Tao/docker-cron-backup","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CS-Tao%2Fdocker-cron-backup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CS-Tao%2Fdocker-cron-backup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CS-Tao%2Fdocker-cron-backup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CS-Tao%2Fdocker-cron-backup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CS-Tao","download_url":"https://codeload.github.com/CS-Tao/docker-cron-backup/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CS-Tao%2Fdocker-cron-backup/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32643565,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-04T10:08:07.713Z","status":"online","status_checked_at":"2026-05-05T02:00:06.033Z","response_time":54,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["backup-script","dockerfile","sftp"],"created_at":"2024-10-14T00:46:01.600Z","updated_at":"2026-05-05T09:32:01.369Z","avatar_url":"https://github.com/CS-Tao.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# docker-cron-backup\n\n\u003e 定时使用 sftp 将远程服务器的文件或文件夹备份到本地\n\n[![Deploy To GitHub Registry](https://github.com/CS-Tao/docker-cron-backup/workflows/Deploy%20To%20GitHub%20Registry/badge.svg)](https://github.com/CS-Tao/docker-cron-backup/packages/101776?version=master)\n[![Deploy To Docker Hub](https://github.com/CS-Tao/docker-cron-backup/workflows/Deploy%20To%20Docker%20Hub/badge.svg)](https://hub.docker.com/r/cstao/docker-cron-backup)\n\n## 用法\n\n### 使用命令行\n\n```bash\nsudo docker run -d --rm \\\n  --name cron-backup \\\n  -e HOST=host_ip \\\n  -e SSH_PORT=22 \\\n  -e SSH_USER=user \\\n  -e SSH_PASSWD=secret_passwd \\\n  -e SYNC_FILES=file1:file1_bak,file2:file2_bak \\\n  -e SYNC_FOLDERS=folder1:folder1_bak,folder2:folder2_bak,folder3:folder3_bak \\\n  -e MAX_BACKUPS=7 \\\n  -e INIT_BACKUP=1 \\\n  -e INIT_BACKUP_TIMEOUT=5 \\\n  -e CRON_TIME='0 4 * * *' \\\n  -v ./backups/:/root/backups/ \\\n  -v ./sync/:/root/sync/ \\\n  -v ./log/:/var/log/ \\\n  cstao/cron-backup:v1.0.0\n```\n\n### 使用 docker-compose\n\ndocker-compose.yml\n```yml\nversion: '3.5'\n\nservices:\n  cron-backup:\n    image: cstao/cron-backup:v1.0.0\n    container_name: cron-backup\n    restart: unless-stopped\n    volumes:\n      - ./backups/:/root/backups/\n      - ./sync/:/root/sync/\n      - ./log/:/var/log/\n    environment:\n      HOST: host_ip\n      SSH_PORT: 22\n      SSH_USER: user\n      SSH_PASSWD: secret_passwd\n      SYNC_FILES: file1:file1_bak,file2:file2_bak\n      SYNC_FOLDERS: folder1:folder1_bak,folder2:folder2_bak,folder3:folder3_bak\n      MAX_BACKUPS: 7\n      INIT_BACKUP: 1\n      INIT_BACKUP_TIMEOUT: 5\n      CRON_TIME: '0 4 * * *'\n```\n\n## 环境变量\n\n- `HOST`：主机 IP, 默认为`localhost`\n- `SSH_PORT`：ssh 端口, 默认为`22`\n- `SSH_USER`：ssh 用户, 默认为`root`\n- `SSH_PASSWD`：ssh 密码，`不可为空`\n- `SYNC_FILES`：需要备份的文件，以英文冒号隔开远程路径和本地路径，以英文逗号隔开不同文件，不能有空格，如 file1:file1_bak,file2:file2_bak。冒号前的文件为服务器上的文件绝对路径，冒号后的文件为在`./sync/`文件夹中的名字\n- `SYNC_FOLDERS`：需要备份的文件夹，以英文冒号隔开远程路径和本地路径，以英文逗号隔开不同文件夹，不能有空格，如 folder1:folder1_bak,folder2:folder2_bak。冒号前的文件夹为服务器上的文件绝对路径，冒号后的文件夹路径为文件夹在`./sync/`文件夹中的路径\n- `MAX_BACKUPS`：最大备份数量，即 backup 文件夹中压缩包的数量，默认为`10`\n- `INIT_BACKUP`：每次启动容器是否需要备份一次，数字大于 0 表示需要，默认为空，即每次启动容器时`不执行`备份\n- `INIT_BACKUP_TIMEOUT`：第一次备份等待时间(s)，仅在`INIT_BACKUP`大于 0 时有效，默认为`0`\n- `CRON_TIME`：定时表达式，默认为`0 4 * * `，即每天 4 点执行备份\n\n*`SSH_PASSWD`不可为空，`SYNC_FILES`和`SYNC_FOLDERS`不可同时为空*\n\n## 持久卷\n\n- `/root/backups/`：备份文件夹，保存每次`/root/sync/`文件夹的压缩包\n- `/root/sync/`：同步文件夹，每次同步会清空之前的内容并下载最新内容\n- `/var/log/`：日志文件夹\n\n## 容器操作\n\n- 备份文件和文件夹的命令\n  ```bash\n  docker exec cron-backup /root/backup.sh\n  ```\n\n- 恢复文件和文件夹的命令\n  ```bash\n  docker exec cron-backup /root/restore.sh\n  ```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcs-tao%2Fdocker-cron-backup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcs-tao%2Fdocker-cron-backup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcs-tao%2Fdocker-cron-backup/lists"}