{"id":19015131,"url":"https://github.com/adfinis/gitlab-docsbot","last_synced_at":"2026-04-21T09:32:55.289Z","repository":{"id":68508329,"uuid":"91553827","full_name":"adfinis/gitlab-docsbot","owner":"adfinis","description":"The Docs Bot - A simple service which receives HTTP build triggers from GitLab and unpacks built artifacts inside a configured directory.","archived":false,"fork":false,"pushed_at":"2019-01-03T15:19:21.000Z","size":33,"stargazers_count":1,"open_issues_count":2,"forks_count":1,"subscribers_count":17,"default_branch":"master","last_synced_at":"2025-10-10T16:23:11.320Z","etag":null,"topics":["automation","bot","documentation","gitlab","gitlab-ci","webhook"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/adfinis.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":"2017-05-17T08:43:39.000Z","updated_at":"2019-03-03T04:00:42.000Z","dependencies_parsed_at":"2023-03-11T03:46:03.859Z","dependency_job_id":null,"html_url":"https://github.com/adfinis/gitlab-docsbot","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/adfinis/gitlab-docsbot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adfinis%2Fgitlab-docsbot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adfinis%2Fgitlab-docsbot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adfinis%2Fgitlab-docsbot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adfinis%2Fgitlab-docsbot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adfinis","download_url":"https://codeload.github.com/adfinis/gitlab-docsbot/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adfinis%2Fgitlab-docsbot/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32085497,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-21T06:27:27.065Z","status":"ssl_error","status_checked_at":"2026-04-21T06:27:21.250Z","response_time":128,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["automation","bot","documentation","gitlab","gitlab-ci","webhook"],"created_at":"2024-11-08T19:35:41.531Z","updated_at":"2026-04-21T09:32:55.264Z","avatar_url":"https://github.com/adfinis.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GitLab CI Docs Bot\n\n[![Travis](https://img.shields.io/travis/adfinis-sygroup/gitlab-docsbot.svg?style=flat-square)](https://travis-ci.org/adfinis-sygroup/gitlab-docsbot)\n[![License](https://img.shields.io/github/license/adfinis-sygroup/gitlab-docsbot.svg?style=flat-square)](LICENSE)\n\nThis script starts a simple web server which accepts requests from GitLab\nwebhooks and downloads artifacts from the latest build to a defined directory.\n\n## Installation\n\n```\n# apt-get install python-setuptools python-pip python-yaml\n# python setup.py install\n# systemctl daemon-reload\n# systemctl enable gitlab-autodocs.service\n# systemctl start gitlab-autodocs.service\n```\n\n## Configuration\n\n### Initial\n\nAdd a new user in GitLab called `docs-bot` and get his API-Key. Then edit \n`/etc/gitlab-autodocs.yaml` and set your GitLab URL and the API key.\n\n### Add new repos to sync\n\nYou need to create a `.docs-bot.yml` in your repository, example:\n\n```\ndocs:\n  extract_to: /var/www/docs/autodocs-ci-test\n  download_delay: 10\n  stages:\n    - docs\n```\n\n`docs` needs to be the root entry of `.docs-bot.yml`\n- `extract_to` directory to put artifacts\n- `download_delay` since GitLab triggers before uploading artifacts, you can\n   configure a delay before fetching them\n- `stages` if defined, only sync specified build stages configured in \n  `.gitlab-ci.yml`\n\nIn GitLab, you need to grant `docs-bot` access to your repo and add a new\nwebhook which triggers on build events, pointing to your docsync URL.\n\n## Contributions\nContributions are more than welcome! Please feel free to open new issues or\npull requests.\n\n## License\nGNU GENERAL PUBLIC LICENSE Version 3\n\nSee the [LICENSE](LICENSE) file.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadfinis%2Fgitlab-docsbot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadfinis%2Fgitlab-docsbot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadfinis%2Fgitlab-docsbot/lists"}