{"id":22230168,"url":"https://github.com/xlab-si/iac-scanner-docs","last_synced_at":"2026-03-19T22:09:13.958Z","repository":{"id":108987079,"uuid":"414975300","full_name":"xlab-si/iac-scanner-docs","owner":"xlab-si","description":"Documentation for IaC Scanner","archived":false,"fork":false,"pushed_at":"2023-05-16T06:57:08.000Z","size":3295,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-02-08T17:50:26.461Z","etag":null,"topics":["docs","documentation","iac","scanner"],"latest_commit_sha":null,"homepage":"https://xlab-si.github.io/iac-scanner-docs/","language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/xlab-si.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,"zenodo":null}},"created_at":"2021-10-08T12:18:56.000Z","updated_at":"2024-01-29T10:26:57.000Z","dependencies_parsed_at":null,"dependency_job_id":"7592a410-75f0-4fac-83fa-362fd4b12d9f","html_url":"https://github.com/xlab-si/iac-scanner-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/xlab-si/iac-scanner-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xlab-si%2Fiac-scanner-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xlab-si%2Fiac-scanner-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xlab-si%2Fiac-scanner-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xlab-si%2Fiac-scanner-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xlab-si","download_url":"https://codeload.github.com/xlab-si/iac-scanner-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xlab-si%2Fiac-scanner-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30716576,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-19T05:29:31.190Z","status":"ssl_error","status_checked_at":"2026-03-19T05:28:25.821Z","response_time":57,"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":["docs","documentation","iac","scanner"],"created_at":"2024-12-03T01:14:32.485Z","updated_at":"2026-03-19T22:09:13.954Z","avatar_url":"https://github.com/xlab-si.png","language":"Dockerfile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# IaC Scanner documentation\nThis repository holds the documentation for the [IaC Scanner].\n\n[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/xlab-si/iac-scanner-docs/ci_cd.yml?branch=main)](https://github.com/xlab-si/iac-scanner-docs/actions)\n[![GitHub deployments](https://img.shields.io/github/deployments/xlab-si/iac-scanner-docs/github-pages?label=gh-pages)](https://github.com/xlab-si/iac-scanner-docs/deployments)\n[![Docker Image Version (latest by date)](https://img.shields.io/docker/v/xscanner/docs?color=blue\u0026label=docker)](https://hub.docker.com/r/xscanner/docs)\n\n## Table of Contents\n  - [Description](#purpose-and-description)\n  - [Run with Docker](#run-with-docker)\n  - [Local building and testing](#local-building-and-testing)\n  - [License](#license)\n  - [Contact](#contact)\n  - [Acknowledgement](#acknowledgement)\n\n## Purpose and description\nThis project documents all the related IaC Scanner tools and services.\nThe documentation is available on [GitHub Pages].\n\n## Run with Docker\nYou can run the docs using a public [xscanner/docs] Docker image as follows:\n\n```console\n# run IaC Scanner documentation in a Docker container and navigate to localhost:8000\n$ docker run --name iac-scanner-docs -p 8000:80 xscanner/docs\n```\n\nOr you can build the image locally and run it as follows:\n\n```console\n# build Docker container\n$ docker build -t iac-scanner-docs .\n# run IaC Scanner documentation in a Docker container and navigate to localhost:8000\n$ docker run --name iac-scanner-docs -p 8000:80 iac-scanner-docs\n```\n\n## Local building and testing\nFor documenting the IaC Scanner we use the [Sphinx documentation tool].\nHere we can render Sphinx Documentation from RST files and we use [Read the Docs] theme.\n\nTo test the documentation locally run the commands below:\n\n```console\n# create and activate a new Python virualenv\n$ python3 -m venv .venv \u0026\u0026 . .venv/bin/activate\n# update pip and install Sphinx requirements\n(.venv) $ pip install --upgrade pip\n(.venv) $ pip install -r requirements.txt\n# build the HTML documentation\n(.venv) $ sphinx-build -M html docs build\n# build the Latex and PDF documentation\n(.venv) $ sphinx-build -M latexpdf docs build\n```\n\nAfter that you will found rendered documentation HTML files in `build` folder and you can open and view them inside \nyour browser. \n\n## License\nThis work is licensed under the [Apache License 2.0].\n\n## Contact\nYou can contact the xOpera team by sending an email to [xopera@xlab.si].\n\n## Acknowledgement\nThis project has received funding from the European Union’s Horizon 2020 research and innovation programme under Grant \nAgreement No. 101000162 ([PIACERE]).\n\n[IaC Scanner]: https://xlab-si.github.io/iac-scanner-docs/\n[GitHub Pages]: https://xlab-si.github.io/iac-scanner-docs/\n[xscanner/docs]: https://hub.docker.com/r/xscanner/docs\n[Sphinx documentation tool]: https://www.sphinx-doc.org/en/master/\n[Read the Docs]: https://readthedocs.org/\n[Apache License 2.0]: https://www.apache.org/licenses/LICENSE-2.0\n[xopera@xlab.si]: mailto:xopera@xlab.si\n[PIACERE]: https://www.piacere-project.eu/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxlab-si%2Fiac-scanner-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxlab-si%2Fiac-scanner-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxlab-si%2Fiac-scanner-docs/lists"}