HomeLab

File and tools used to support my Home Lab projects and ideas.

Description

A collection of files and scripts to set up and maintain my homelab. If you find anything In here interesting or helpfull. Feel free to take and use for yourself.

Secrets

Store sensitive values/secrets in the secrets folder, .env file, file names that contain*.no-git.* or end a file with .passwd.

NOTE: Detect-secrets with pre-commit is used to reduce the risk of committing sensitive values to git.

Directory

• .devcontainer - config for the dev container.
• .vscode - config and hints for the vscode editor.
• .github - github related files.
• secrets/ - holds most secrets for the project, most file in this directory will be ignored by git.

Pre-commit

Pre-commit hooks are used to enforce code quality and standards. Pre-commit is active by defualt in the devcontainer.

1. Install pre-commit.

2. Auto update pre-commit hooks.

   pre-commit autoupdate

3. Run the below commands to install the git hooks.

   pre-commit install

Code Standards

• LF line endings enforced via .gitattributes
• pre-commit hooks are used to enforce style and check for errors
  • Markdown linting with markdownlint-cli2
  • Script is through shell check
  • Secrets are detected with detect-secrets
  • Ansible linting with ansible-lint

Authors

• Anthony Tilelli

License

This project is licensed under the GPLV3 License - see the LICENSE.md file for details