sebastian-sommerfeld-io / configs

Configuration as code for all my computers and RasPi nodes.
Other
1 stars 0 forks source link

= Config Docs Sebastian Sommerfeld sebastian@sommerfeld.io :project-name: configs :url-project: https://github.com/sebastian-sommerfeld-io/{project-name} :github-actions-url: {url-project}/actions/workflows :job-build: build.yml :job-generate-docs: generate-docs.yml :badge: badge.svg

Infrastructure repository with configs and docs for my workstations, servers and RasPi nodes.

image:{github-actions-url}/{job-generate-docs}/{badge}[Github Badge, link={github-actions-url}/{job-generate-docs}] image:{github-actions-url}/{job-build}/{badge}[Github Badge, link={github-actions-url}/{job-ci}]

== About this project This project defines all my infrastructure following the infrastructure as code pattern. It is intended to work specifically on my machines. You might be able to adopt some stuff from this project, but using it "as is" most likely will result in failure.

== How to use this project This project contains several scripts to control the respective function set. For a complete reference and information on how to use the respective script see index.adoc[]/link:https://github.com/sebastian-sommerfeld-io/configs/tree/main/docs/modules/AUTO-GENERATED/pages/components/homelab/src/main[the inline docs]/index.adoc[].

Be aware that the environment must follow some ground rules:

. Every machine is Ubuntu Linux (or at least Debian-based)

== Risks and Technical Debts See https://github.com/sebastian-sommerfeld-io/configs/issues?q=is%3Aissue+is%3Aopen+label%3Asecurity%2Crisk+ for all issus labeles as risk (= some sort of risk or a technical debt) or security (= related to security issues).

== Contact Feel free to contact me via sebastian@sommerfeld.io or visit my website https://www.sommerfeld.io.

// +---------------------------------------------------+ // | | // | DO NOT EDIT DIRECTLY !!!!! | // | | // | File is auto-generated by pipeline. | // | Contents are based on Antora docs. | // | | // +---------------------------------------------------+