{"id":18648098,"url":"https://github.com/vitonsky/replicator","last_synced_at":"2025-11-05T07:30:35.100Z","repository":{"id":169981041,"uuid":"646079875","full_name":"vitonsky/replicator","owner":"vitonsky","description":"Replicator is a task runner for backups","archived":false,"fork":false,"pushed_at":"2023-06-14T19:38:50.000Z","size":31,"stargazers_count":0,"open_issues_count":14,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-28T14:02:35.630Z","etag":null,"topics":["backup","backup-cli","backup-cron","backup-script","backup-tool","backup-utility","backups","cli","task-manager","task-runner"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/replicator-cli/","language":"Python","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/vitonsky.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":"2023-05-27T08:07:38.000Z","updated_at":"2023-05-27T10:44:14.000Z","dependencies_parsed_at":null,"dependency_job_id":"1fafd61a-b385-4be9-addc-54216c46c41e","html_url":"https://github.com/vitonsky/replicator","commit_stats":null,"previous_names":["vitonsky/replicator"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vitonsky%2Freplicator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vitonsky%2Freplicator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vitonsky%2Freplicator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vitonsky%2Freplicator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vitonsky","download_url":"https://codeload.github.com/vitonsky/replicator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239450022,"owners_count":19640645,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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","backup-cli","backup-cron","backup-script","backup-tool","backup-utility","backups","cli","task-manager","task-runner"],"created_at":"2024-11-07T06:28:55.960Z","updated_at":"2025-11-05T07:30:35.007Z","avatar_url":"https://github.com/vitonsky.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Replicator is a task runner for backups.\n\nYou can describe your tasks declarative with YAML file and run task files with CRON.\n\nReplicator supports notifications, it's useful for tasks that take a lot of time.\n\n## Install\n\nInstall from pip `pip install replicator-cli`\n\nOr build:\n- Clone repository `git clone https://github.com/vitonsky/replicator.git`\n- Build package with run `make build`\n- Install package `pip install dist/replicator-0.0.1-py3-none-any.whl`\n\n## Usage\n\n```\nusage: replicator [-h] config\n\nUtil to replicate backups from primary storage to a mirrors\n\npositional arguments:\n  config      Path to config file\n\noptional arguments:\n  -h, --help  show this help message and exit\n```\n\nTo use util, first create task file.\n\nExample task file for a local device\n```yml\ntasks:\n    # Task may have name\n    - name: 'Copy files to backup disk'\n      run: rclone ./backups /path/to/local/mirror1\n\n    - name: 'Upload to S3'\n      run: rclone ./backups s3Replica:backups\n\n    - name: 'Replicate on server'\n      # Just run replicator on server with their own config and end locally\n      run: ssh replicator@backup-server 'nohup replicator ./backups.yml \u003e ./replicator.log 2\u003e\u00261 \u003c/dev/null \u0026'\n```\n\nExample task file for backup server\n```yml\n# Notifications config\nnotifications:\n    telegram:\n        # Define should notifications been sent\n        enabled: true\n        # Token for bot who will sent notifications\n        # How to: https://core.telegram.org/bots/tutorial#getting-ready\n        botToken: '123:token'\n        # User IDs to receive notifications\n        userIds:\n            - 123456\n\n# Replicate backup from main storage\ntasks:\n    - run: rclone s3Replica:backups s3Mirror1:backups\n    - run: rclone s3Replica:backups s3Mirror2:backups\n    - run: rclone s3Replica:backups s3Mirror3:backups\n```\n\n## TODO\n- [x] Support few entries for replication\n- [x] Provide commands to run, instead of paths\n- [x] Provide instructions to install as binary\n- [ ] Split the code\n- [ ] Add docker image","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvitonsky%2Freplicator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvitonsky%2Freplicator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvitonsky%2Freplicator/lists"}