{"id":20281277,"url":"https://github.com/badouralix/rclone-lambda-sync","last_synced_at":"2025-08-21T12:47:02.673Z","repository":{"id":42008734,"uuid":"367741780","full_name":"badouralix/rclone-lambda-sync","owner":"badouralix","description":"A lambda function to run `rclone sync` periodically","archived":false,"fork":false,"pushed_at":"2023-11-27T17:38:40.000Z","size":307,"stargazers_count":29,"open_issues_count":2,"forks_count":6,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-05-24T08:36:54.249Z","etag":null,"topics":["aws","aws-lambda","cloud","rclone","storage"],"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/badouralix.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","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":"2021-05-15T22:34:07.000Z","updated_at":"2025-02-18T18:09:49.000Z","dependencies_parsed_at":"2024-11-14T18:49:13.507Z","dependency_job_id":null,"html_url":"https://github.com/badouralix/rclone-lambda-sync","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"purl":"pkg:github/badouralix/rclone-lambda-sync","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/badouralix%2Frclone-lambda-sync","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/badouralix%2Frclone-lambda-sync/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/badouralix%2Frclone-lambda-sync/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/badouralix%2Frclone-lambda-sync/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/badouralix","download_url":"https://codeload.github.com/badouralix/rclone-lambda-sync/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/badouralix%2Frclone-lambda-sync/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268326436,"owners_count":24232478,"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","status":"online","status_checked_at":"2025-08-01T02:00:08.611Z","response_time":67,"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":["aws","aws-lambda","cloud","rclone","storage"],"created_at":"2024-11-14T13:39:50.201Z","updated_at":"2025-08-02T01:40:51.933Z","avatar_url":"https://github.com/badouralix.png","language":"Python","readme":"# Rclone Lambda Sync\n\n[![Github Actions Lint](https://github.com/badouralix/rclone-lambda-sync/actions/workflows/lint.yaml/badge.svg)](https://github.com/badouralix/rclone-lambda-sync/actions/workflows/lint.yaml)\n\nA lambda function to run `rclone sync` periodically.\n\n## Prerequisites\n\nInstall a lambda layer with rclone, such as [rclone-lambda-layer](https://github.com/badouralix/rclone-lambda-layer).\n\nCreate a valid rclone config with two remotes `source` and `destination`. See \u003chttps://rclone.org/docs/#configure\u003e for details.\n\n```bash\nrclone config create \"source\" ...\nrclone config create \"destination\" ...\n```\n\nThis creates a local file that looks like this :\n\n```bash\n$ cat ~/.config/rclone/rclone.conf\n[source]\n...\n\n[destination]\n...\n```\n\nUpload this config in the SSM parameter `rclone-config`, either using the console or the following one-liner :\n\n```bash\naws ssm put-parameter --region eu-west-3 --name rclone-config --type SecureString --value file://$HOME/.config/rclone/rclone.conf --description \"Entire rclone.conf for rclone-lambda\"\n```\n\n![AWS Systems Manager \u003e Parameter Store \u003e rclone-config \u003e Overview](https://user-images.githubusercontent.com/19719047/144329662-cb0761db-ba3c-46db-8ef3-e8c5b6ec138f.png)\n\nAlso set `DEPLOYMENT_BUCKET` and `EVENTS_FILE` in a new `.env` local file.\n\n## Deploy\n\n```bash\nserverless deploy\n```\n\n## Test\n\n```bash\nserverless invoke --function sync\n```\n\n## Configuration\n\n|       Environment Variable        |                                     Description                                     |                     Default                      |\n| :-------------------------------: | :---------------------------------------------------------------------------------: | :----------------------------------------------: |\n|     `RCLONE_CONFIG_SSM_NAME`      |                 Name of the SSM parameter to fetch the config from.                 |                 `rclone-config`                  |\n| `RCLONE_SYNC_CONTENT_DESTINATION` |               Name of the sync destination in the format \"dest:path\".               |                 `destination:/`                  |\n|   `RCLONE_SYNC_CONTENT_SOURCE`    |                Name of the sync source in the format \"source:path\".                 |                    `source:/`                    |\n|       `RCLONE_SYNC_DRY_RUN`       |                      Do a trial run with no permanent changes.                      |                     `false`                      |\n|     `RCLONE_SYNC_EXTRA_FLAGS`     | List of flags passed to rclone. See available flags in \u003chttps://rclone.org/flags/\u003e. | `--exclude /Downloads/** --exclude /External/**` |\n\n## Schedules\n\nBy default, `rclone-lambda-sync` runs once a day around 00:00 UTC. See [rclone_lambda_daily.yaml](./rclone_lambda_daily.yaml). This behavior can be customized by following these steps :\n\n1. Create a custom yaml file containing the desired schedules\n\n    ```yaml\n    - schedule:\n        name: rclone-lambda-daily-1\n        rate: cron(0 1 * * ? *)\n        input:\n          RCLONE_CONFIG_SSM_NAME: rclone-config-1\n\n    - schedule:\n        name: rclone-lambda-daily-2\n        rate: cron(0 2 * * ? *)\n        input:\n          RCLONE_CONFIG_SSM_NAME: rclone-config-2\n    ```\n\n1. Change `EVENTS_FILE` value to the name of the custom yaml file in the `.env` local file\n1. Test with a slightly different command\n\n    ```bash\n    serverless invoke --function sync --data '{\"RCLONE_CONFIG_SSM_NAME\": \"rclone-config-1\"}'\n    ```\n\n## Documentation\n\n- \u003chttps://rclone.org/docs/\u003e\n- \u003chttps://itnext.io/a-deep-dive-into-serverless-tracing-with-aws-x-ray-lambda-5ff1821c3c70\u003e\n\n## License\n\nUnless explicitly stated to the contrary, all contents licensed under the [MIT License](LICENSE).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbadouralix%2Frclone-lambda-sync","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbadouralix%2Frclone-lambda-sync","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbadouralix%2Frclone-lambda-sync/lists"}