{"id":13305705,"url":"https://github.com/smartondev/gwbackupy-docker","last_synced_at":"2026-01-19T05:37:19.246Z","repository":{"id":178738037,"uuid":"591849411","full_name":"smartondev/gwbackupy-docker","owner":"smartondev","description":"Docker container for gwbackupy. This docker container runs scheduled backups of one or more Gmail accounts, including full and fast backups.","archived":false,"fork":false,"pushed_at":"2023-07-23T10:19:01.000Z","size":47,"stargazers_count":4,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-05-01T11:31:49.287Z","etag":null,"topics":["backup","docker","docker-image","dockerfile","g-suite","gmail","gmail-api","gmvault","google-workspace","gwbackupy"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/smartondev.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["kamarton","smartondev"]}},"created_at":"2023-01-22T04:20:33.000Z","updated_at":"2023-11-12T15:25:22.000Z","dependencies_parsed_at":null,"dependency_job_id":"12315eb7-9f79-4651-97be-90b25fa9db83","html_url":"https://github.com/smartondev/gwbackupy-docker","commit_stats":null,"previous_names":["smartondev/gwbackupy-docker"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smartondev%2Fgwbackupy-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smartondev%2Fgwbackupy-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smartondev%2Fgwbackupy-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smartondev%2Fgwbackupy-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/smartondev","download_url":"https://codeload.github.com/smartondev/gwbackupy-docker/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242859789,"owners_count":20196993,"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","docker","docker-image","dockerfile","g-suite","gmail","gmail-api","gmvault","google-workspace","gwbackupy"],"created_at":"2024-07-29T17:54:00.048Z","updated_at":"2026-01-19T05:37:19.237Z","avatar_url":"https://github.com/smartondev.png","language":"Shell","funding_links":["https://github.com/sponsors/kamarton","https://github.com/sponsors/smartondev"],"categories":[],"sub_categories":[],"readme":"# Docker image for [gwbackupy](https://github.com/smartondev/gwbackupy)\n\nThis docker container runs scheduled backups of one or more Gmail accounts, including full and fast backups.\nThe backup process is based on the open-source software [gwbackupy](https://github.com/smartondev/gwbackupy).\n\n**Under development**\n\n## Overview\n\n## OAuth challenge\n\nIf docker host with desktop UI:\n\n```\ncontainer PORT -\u003e docker -\u003e host PORT -\u003e browser -\u003e redirect --\\\n                                                               |\ncontainer PORT \u003c- docker \u003c- host PORT \u003c------------------------/\n```\n\nIf docker host is in terminal only context:\n\n```\ncontainer PORT -\u003e docker -\u003e host PORT -\u003e public or local network IP -\u003e wait for operator\n                                                                          -\u003e operator -\u003e open link in browser -\u003e redirect --\\\n                                                                                                                            |\ncontainer PORT \u003c- docker \u003c- host PORT \u003c- public or local network IP \u003c-------------------------------------------------------/\n```\n\nPort, bind host, redirect host are set with `GWBACKUPY_OAUTH_PORT`, `GWBACKUPY_OAUTH_BIND_ADDRESS`\nand `GWBACKUPY_OAUTH_REDIRECT_HOST` environment variables.\n\nIf the redirect host is a hostname, it must be a public hostname and must be added to the OAuth configuration.\n\n## Environment variables\n\n| Env name                                 | Default value                              | Description                                                                                                       |\n|------------------------------------------|--------------------------------------------|-------------------------------------------------------------------------------------------------------------------|\n| `GWBACKUPY_WORKDIR`                      | `/data`                                    | Data directory, see more `--workdir` parameter                                                                    |\n| `GWBACKUPY_APPDIR`                       | `/app`                                     |                                                                                                                   |\n| `GWBACKUPY_LOGDIR`                       | `${GWBACKUPY_WORKDIR}/logs`                |                                                                                                                   |\n| `GWBACKUPY_TEMPDIR`                      | `/tmp`                                     |                                                                                                                   |\n| `GWBACKUPY_ACCOUNT_EMAILS`               | `example@example.com example2@example.com` | Email accounts, space separated list                                                                              |\n| `GWBACKUPY_CRON_FULL_SYNC`               | `0 0 * * 0`                                | Cron's pattern to full backup. If empty, it will be turned off. By default, it runs every Monday at 0 AM.         |\n| `GWBACKUPY_CRON_QUICK_SYNC`              | `0 */12 * * *`                             | Cron's pattern to quick backup. If empty, it will be turned off. By default, it runs every day at 0 and 12 hours. |\n| `GWBACKUPY_CRON_LOG`                     | `${GWBACKUPY_LOGDIR}/crontab.log`          |                                                                                                                   |\n| `GWBACKUPY_CRONTAB`                      | `${GWBACKUPY_APPDIR}/crontab`              |                                                                                                                   |\n| `GWBACKUPY_CRON_FLOCK_FILEPATH`          | `/var/lock/gwbackupy-cron.lock`            | Filepath of cron's `flock`                                                                                        |\n| `GWBACKUPY_LOG_LEVEL`                    | `warning`                                  | see more `--log-level` parameter                                                                                  |\n| `GWBACKUPY_CREDENTIALS_FILEPATH`         | ` `                                        |                                                                                                                   |\n| `GWBACKUPY_SERVICE_ACCOUNT_KEY_FILEPATH` | ` `                                        |                                                                                                                   |\n| `GWBACKUPY_MAIN_ARGS`                    | ` `                                        |                                                                                                                   |\n| `GWBACKUPY_SERVICES`                     | `gmail`                                    | Services for backup, currently `gmail` only                                                                       |\n| `GWBACKUPY_OAUTH_REDIRECT_HOST`          | `127.0.0.1`                                |                                                                                                                   |\n| `GWBACKUPY_OAUTH_PORT`                   | `43339`                                    |                                                                                                                   |\n| `GWBACKUPY_OAUTH_BIND_ADDRESS`           | `0.0.0.0`                                  |                                                                                                                   |\n| `GWBACKUPY_QUICK_SYNC_DAYS`              | `7`                                        |                                                                                                                   |\n| `TZ`                                     | ` `                                        | timezone settings from alpine docker                                                                              |\n\nThe full and quick backup do not run simultaneously.\nIf a quick backup is already running, a new instance of the quick backup will not be started.\nThe full backup will wait for the currently running process to finish and then start.\n\n## Arguments\n\nIt is possible to specify the name/location and version of the gwbackupy download during the build by passing arguments.\n\n| Env name                | Default value | Description                                                                                                                                            |\n|-------------------------|---------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `GWBACKUPY_PIP_VERSION` | ` `           | The version of gwbackupy for installation (default is latest version by pip). The version specification should be understood according to pip install. |\n| `GWBACKUPY_PIP_PACKAGE` | `gwbackupy`   | The package name of gwbackupy for installation. Either the pip package name or direct zip access can be specified, see pip.                            |\n\nFor build a specific version of gwbackupy use this argument:\n\n- `GWBACKUPY_PIP_VERSION=\"~=0.10\"`\n\n```bash\ndocker build --build-arg GWBACKUPY_PIP_VERSION=\"~=0.10\" -t gwbackupy-v0-10 ./\n```\n\nFor build image with dev master (main) use this argument:\n\n- `GWBACKUPY_PIP_PACKAGE=\"https://github.com/smartondev/gwbackupy/archive/main.zip\"`\n\n```bash\ndocker build --build-arg GWBACKUPY_PIP_PACKAGE=\"https://github.com/smartondev/gwbackupy/archive/main.zip\" -t gwbackupy-devmaster ./\n```\n\n*Please note that the given docker image may not be compatible with all versions of gwbackupy.*\n\n## Scripts\n\n- `entrypoint.sh`: check authentication status, and if is ok, then starts crond (default script) and schedule\n  full and quick backups\n- `quick-sync.sh`: script for start quick backup\n- `sync.sh`: script for start full backup\n- `access-init.sh`: script for start initialize authentication (use first time and if auth changes)\n  ```bash\n  docker ... -it exec /bin/bash access-init.sh\n  ```\n- `access-check.sh`: script for authentication states checking\n    - `access-check.sh \u003cemail(s)\u003e`: run checks for email addresses\n    - `access-check.sh \u003cemail(s)\u003e \u003cservice(s)\u003e`: run checks for specified services and email addresses\n\nRun gwbackupy with custom parameters (e.g. restore):\n\n```bash\ndocker ... -it exec python -m gwbackupy ...\n```\n\n## Security\n\nSee [SECURITY.md](SECURITY.md)\n\n## Contributing\n\nWelcome! I am happy that you want to make the project better.\n\nCurrently, there is no developed documentation for the process, in the meantime, please use issues and pull requests.\n\n## Changelog\n\nThe changes are contained in [CHANGELOG.md](CHANGELOG.md).\n\n## About\n\n[Márton Somogyi](https://github.com/Kamarton)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmartondev%2Fgwbackupy-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsmartondev%2Fgwbackupy-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmartondev%2Fgwbackupy-docker/lists"}