{"id":18565049,"url":"https://github.com/greenbone/docs","last_synced_at":"2025-04-10T04:32:18.790Z","repository":{"id":36977008,"uuid":"374144727","full_name":"greenbone/docs","owner":"greenbone","description":"Documentation for the Greenbone Community Edition","archived":false,"fork":false,"pushed_at":"2024-04-17T12:36:30.000Z","size":6331,"stargazers_count":18,"open_issues_count":3,"forks_count":26,"subscribers_count":21,"default_branch":"main","last_synced_at":"2024-04-17T16:11:16.507Z","etag":null,"topics":["base","container","docker","docker-compose","documentation","documentations","greenbone","greenbone-community-containers","greenbone-community-edition","gvm","openvas","openvas-container","openvas-docker","shell","source","source-build","techops"],"latest_commit_sha":null,"homepage":"https://greenbone.github.io/docs/","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc-by-sa-4.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/greenbone.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":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2021-06-05T15:11:46.000Z","updated_at":"2024-04-19T10:36:52.408Z","dependencies_parsed_at":"2023-10-02T05:52:11.407Z","dependency_job_id":"71c7d929-546e-4e46-adce-ef15f0acc7e8","html_url":"https://github.com/greenbone/docs","commit_stats":null,"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greenbone%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greenbone%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greenbone%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greenbone%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/greenbone","download_url":"https://codeload.github.com/greenbone/docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223424313,"owners_count":17142745,"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":["base","container","docker","docker-compose","documentation","documentations","greenbone","greenbone-community-containers","greenbone-community-edition","gvm","openvas","openvas-container","openvas-docker","shell","source","source-build","techops"],"created_at":"2024-11-06T22:17:31.070Z","updated_at":"2024-11-06T22:17:31.168Z","avatar_url":"https://github.com/greenbone.png","language":"Shell","readme":"![Greenbone Logo](https://www.greenbone.net/wp-content/uploads/gb_new-logo_horizontal_rgb_small.png)\n\n# Documentation for the Greenbone Community Edition\n\nThe documentation is build automatically via GitHub Actions and available at\nhttps://greenbone.github.io/docs/\n\n## Requirements\n\nFor a manual build locally Python \u003e= 3.9 and [poetry] is required.\n\n## Install Poetry\n\nThe project requires poetry \u003e= 1.8.0.\n\nTo install poetry it is recommended to use [pipx]. pipx can be installed with\nthe following command on Debian based systems:\n\n```sh\nsudo apt install pipx\n```\n\nInstall poetry using pipx\n\n```sh\npython3 -m pipx install poetry\n```\n\n## Install and Upgrade Dependencies\n\nWhen building the docs you should ensure that all the dependencies are installed\nand up to date. To install for the first time or to update the project\ndependencies via [poetry] run:\n\n```sh\npoetry install\n```\n\nYou should run this command once a week to install the latest dependencies.\n\n## Manual Build\n\nAfter installing [poetry] and the project's dependencies, the docs can be built with:\n```sh\npoetry run make html\n```\n\nTo open the generated HTML docs with Firefox you can run:\n\n```sh\nfirefox _build/html/index.html\n```\n\n## Auto Rebuild\n\nAlternatively it is possible to start a local HTTP server that automatically\nrebuilds the docs on every file change:\n\n```sh\npoetry run make livehtml\n```\n\nTo open the served docs with Firefox you can run:\n\n```sh\nfirefox http://127.0.0.1:8000\n```\n\n## Starting From Scratch\n\nIf something is wrong with your dependencies or you just want to re-start from\na clean environment you need to remove the [virtual environment](https://docs.python.org/3/library/venv.html).\nFirst of all ensure that poetry's virtual environment is placed within the\nproject:\n\n```sh\npoetry config virtualenvs.in-project true\n```\n\nAfterwards the virtual environment including all installed dependencies can be\ndeleted:\n\n```sh\nrm -rf .venv\n```\n\n[poetry]: https://python-poetry.org/\n[pipx]: https://pipx.pypa.io/stable/\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgreenbone%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgreenbone%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgreenbone%2Fdocs/lists"}