Jafner/homelab
1
1
Fork 0
Code Issues 15 Pull Requests Actions Packages Projects Releases Wiki Activity

Edit navigation code block formatting

Browse Source
This commit is contained in:
Joey Hafner 2022-07-08 15:05:18 -07:00
parent 81ba152c80
commit 42911e1cba
1 changed files with 33 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
README.md
View File

@ -5,16 +5,40 @@ Monolithic repository for my homelab
# Navigation
This repo is (mostly) organized into the following structure:
```bash
/ # The root contains repository meta-information like .gitignore, .gitlab-ci.yml, .gitmodules, and README.md.
docs/ # The /docs directory is for all self-contained documentation that is not tied to a specific service. Service-specific documentation is contained in /$host/config/$service/README.md
img/ # supporting images for use in docs
/
# The root contains repository meta-information like .gitignore,
# .gitlab-ci.yml, .gitmodules, and README.md.
docs/
# The /docs directory is for all self-contained documentation
# that is not tied to a specific service. Service-specific documentation
# is contained in /$host/config/$service/README.md
img/
# supporting images for use in docs
$host/ # There are separate directories for the details and configuration of each host. At the root of `/$host/` we have non-authoritative documentation and reference. This includes printouts of hardware configs (`inxi -b`), host-specific procedure docs, useful scripts, etc..
config/ # Anything in the `/$host/config` directory is used as a source of truth from which hosts pull and apply the defined configuration.
$service/ # for Docker-enabled hosts each service stack will be configured within a directory
docker-compose.yml # all services (except minecraft, which needed a more modular system) use docker-compose.yml to define their stack configuration.
.env # contains environment variables to be used by multiple containers within a stack
README.md # if a service stack has documentation specific to itself, it will be contained within this file. This usually contains procedure for interacting with a container and system configuration changes that could not be tracked in code (e.g. /etc/fstab or crontab or /etc/docker/daemon.json)
$host/
# There are separate directories for the details and configuration of
# each host. At the root of `/$host/` we have non-authoritative
# documentation and reference. This includes printouts of hardware
# configs (`inxi -b`), host-specific procedure docs, useful scripts, etc.
config/
# Anything in the `/$host/config` directory is used as a source of
# truth from which hosts pull and apply the defined configuration.
$service/
# for Docker-enabled hosts each service stack will be
# configured within a directory
docker-compose.yml
# all services (except minecraft, which needed a
# more modular system) use docker-compose.yml to
# define their stack configuration.
.env
# contains environment variables to be used by multiple
# containers within a stack
README.md
# if a service stack has documentation specific to itself,
# it will be contained within this file. This usually contains
# procedure for interacting with a container and system configuration
# changes that could not be tracked in code (e.g. /etc/fstab or
# crontab or /etc/docker/daemon.json)
```
# Getting an SSH Key