{"id":20469796,"url":"https://github.com/rooyca/rooykup-backup-and-sync","last_synced_at":"2026-05-27T20:32:09.552Z","repository":{"id":166347698,"uuid":"641832590","full_name":"Rooyca/rooykup-backup-and-sync","owner":"Rooyca","description":"Create backups, compress them, and sync them with a single script.","archived":false,"fork":false,"pushed_at":"2024-02-17T20:37:33.000Z","size":209,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-05T13:25:29.024Z","etag":null,"topics":["backup","cloud","encryption","rclone","script","sync"],"latest_commit_sha":null,"homepage":"","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/Rooyca.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}},"created_at":"2023-05-17T09:00:51.000Z","updated_at":"2023-08-14T18:11:49.000Z","dependencies_parsed_at":"2024-02-17T21:42:45.007Z","dependency_job_id":null,"html_url":"https://github.com/Rooyca/rooykup-backup-and-sync","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/Rooyca/rooykup-backup-and-sync","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Rooyca%2Frooykup-backup-and-sync","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Rooyca%2Frooykup-backup-and-sync/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Rooyca%2Frooykup-backup-and-sync/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Rooyca%2Frooykup-backup-and-sync/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Rooyca","download_url":"https://codeload.github.com/Rooyca/rooykup-backup-and-sync/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Rooyca%2Frooykup-backup-and-sync/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33583394,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-05-27T02:00:06.184Z","response_time":53,"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","cloud","encryption","rclone","script","sync"],"created_at":"2024-11-15T14:10:23.465Z","updated_at":"2026-05-27T20:32:09.537Z","avatar_url":"https://github.com/Rooyca.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# rooykup - Backup and sync tool\n\n![EXAMPLE](rooykup_example.gif)\n\n![IMG](https://img.shields.io/badge/Version-0.0.2-blue)\n\n## Table of Contents\n\n- [Configuration](#configuration)\n- [Usage](#usage)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Configuration\n\n### rclone\n\n- Download rclone from https://rclone.org/downloads/\n- Configure rclone with `rclone config`. Follow the instructions from https://rclone.org/docs/\n- Set a strong configuration password and save it in a `confg` file in `~/.config/rooykup`\n\n### rooykup\n\n- Clone this repository\n- Create a `config.toml` file in `~/.config/rooykup` with the following structure:\n\n```toml\n[config]\nworkingDirectory = \"/path/to/working/directory\" # Directory where compressed files and logs will be saved\nshutDownAfterBackup = false\nalwaysCompress = false\nremote = [\"remote:folder\", \"remote2:\"]\nlocal = \"local:\"\n\n[exclude]\ndirectories = [\".git\", \"node_modules\"] # If none leave it empty \n\n[[pathAndDirName]]\npath = \"/path/to/folder/to/backup\"\nzipName = \"NameOfTheZipFile\n```\n\nYou can add as many `[[pathAndDirName]]` as you want.\n\n- Export the `RCLONE_CONFIG_PASS` environment variable with the rclone configuration password. You also can add it to your `.bashrc` or `.zshrc` file.\n\n```bash\nexport RCLONE_CONFIG_PASS=\"yourRcloneConfigPass\"\n```\n\n## Usage\n\n- Run `python rooykup.py` (`./rooykup` if you download it from [release page](https://github.com/Rooyca/rooykup-backup-and-sync/releases)) to start the backup process\n- If you want to run it periodically, you can use `cron` or `systemd`\n\nYou can also create an alias in your `.bashrc` file or `.zshrc` file\n\n```bash\nalias rooykup=\"python /path/to/rooykup.py\"\n```\n\nIf you want to shut down your computer after the backup process, set `shutDownAfterBackup` to `true` in your `config.toml` file or run it with the `-s` flag.\n\nIf you want to always compress the files, set `alwaysCompress` to `true` in your `config.toml` file or run it with the `-c` flag. This will compress even if the directory already has a compressed file from today.\n\n### Polybar module\n\nIf you want to use the polybar module, add the following to your polybar config file:\n\n```ini\n[module/bs]\ntype = custom/script\nexec = echo \" \"\nformat-prefix = \"  \"\nformat-prefix-foreground = #000\nformat-background = #fb4934\nclick-left = alacritty --hold -e python /path/to/rooykup.py -s\n```\n\nHere I'm using `alacritty` as my terminal emulator, but you can change it to whatever you want.\n\n## Contributing\n\nAny contributions you make are **greatly appreciated**. \u003c3\n\n## License\n\nDistributed under the MIT License. See `LICENSE` for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frooyca%2Frooykup-backup-and-sync","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frooyca%2Frooykup-backup-and-sync","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frooyca%2Frooykup-backup-and-sync/lists"}