diff --git a/index.md b/index.md new file mode 100644 index 0000000..596be37 --- /dev/null +++ b/index.md @@ -0,0 +1,105 @@ +--- +title: renovate_bot +type: docs +--- + +[![Source Code](https://img.shields.io/badge/gitea-source%20code-blue?logo=gitea&logoColor=white)](https://gitea.rknet.org/ansible/xoxys.renovate_bot) [![Build Status](https://img.shields.io/drone/build/ansible/xoxys.renovate_bot?logo=drone&server=https%3A%2F%2Fdrone.rknet.org)](https://drone.rknet.org/ansible/xoxys.renovate_bot) [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://gitea.rknet.org/ansible/xoxys.renovate_bot/src/branch/master/LICENSE) + +Setup docker-renovate garbage collector. Keep docker hosts small. + +* [Default Variables](#default-variables) + * [](#) + * [renovatebot_autodiscover](#renovatebot_autodiscover) + * [renovatebot_endpoint](#renovatebot_endpoint) + * [renovatebot_git_author](#renovatebot_git_author) + * [renovatebot_github_token](#renovatebot_github_token) + * [renovatebot_image](#renovatebot_image) + * [renovatebot_interval](#renovatebot_interval) + * [renovatebot_platform](#renovatebot_platform) + * [renovatebot_service_stopped](#renovatebot_service_stopped) + * [renovatebot_token](#renovatebot_token) +* [Dependencies](#dependencies) + +--- + +## Default Variables + +### + +If you are running on any platform except github.com, it's important to also configure a personal access token for github.com. It's used when fetching release notes for repositories in order to increase the hourly API limit. + +### renovatebot_autodiscover + +#### Default value + +```YAML +renovatebot_autodiscover: false +``` + +### renovatebot_endpoint + +#### Default value + +```YAML +renovatebot_endpoint: https://github.company.com/api/v3 +``` + +### renovatebot_git_author + +#### Default value + +```YAML +renovatebot_git_author: Renovate Bot +``` + +### renovatebot_github_token + +#### Default value + +```YAML +renovatebot_github_token: _unset_ +``` + +### renovatebot_image + +Docker image to use. + +#### Default value + +```YAML +renovatebot_image: renovate/renovate:latest +``` + +### renovatebot_interval + +Interval for the systemd timer. + +#### Default value + +```YAML +renovatebot_interval: daily +``` + +### renovatebot_platform + +#### Default value + +```YAML +renovatebot_platform: github +``` + +### renovatebot_service_stopped + +#### Default value + +```YAML +renovatebot_service_stopped: false +``` + +### renovatebot_token + +Personal access token for your bot account. + +## Dependencies + +None.