host-git/README.md
GregoryDosh 3c846ca89a
All checks were successful
Deploy Ansible Pipeline / Deploy Ansible Pipeline (push) Successful in 53s
refactor: licensing updates to match other repos (#163)
feat: licensing refactor

fix: update gitignore for logs files (license check in ci)

Reviewed-on: #163
Co-authored-by: GregoryDosh <authentik@gregorydosh.com>
Co-committed-by: GregoryDosh <authentik@gregorydosh.com>
2024-12-20 21:56:20 +00:00

37 lines
2.8 KiB
Markdown

<!--
Private Forgejo instance for managing/automating Auengun.net
Source available at git.auengun.net/homelab/host-git
Copyright (C) 2024 GregoryDosh
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
SPDX-License-Identifier: AGPL-3.0-or-later
SPDX-FileCopyrightText: 2024 GregoryDosh
-->
# Generically how is [`host-git`](https://git.auengun.net) used or what does it do?
You're probably reading this on https://git.auengun.net right now, but if not, this code is used to stand up a portion of the infrastructure needed to operate a/this [Forgejo](https://forgejo.org/) instance. Designed in a way that minimizes the amount of [cognitive load](https://youtu.be/haejb5rzKsM?t=1680) required for one person, [me (@gregdosh@auengun.net)](https://blog.auengun.net/@gregdosh), to hopefully maintain and manage.
# What value does it provide me?
Being able to codify all of my infrastructure makes recovery and bootstrap much easier. I used GitHub for quite a while but self-hosting my own code platform allows me to iterate and learn in ways that using external GitHub or GitLab don't provide. Safety in knowing an oops in my knowledge won't cost me an arm and a leg. That I could run downstairs and restart the darn thing or connect to the physical machine and (un/re)do something.
# Anything noteworthy to see in this repo?
Most of the files contain in-line comments on why or how something works along with some historical reference points or contextual in-repo references to orient myself (or you) how it all works. A few file types don't support comments, so in those cases I'll create a duplicate name with a `.md` extension to add some commentary to the file.
There is a focus towards whatever is the most recent technology while reducing overall cognitive load required for a hobbyist to maintain. I make pre-apologies on the cognitive load required to bootstrap understand the thing) from the ground up.
Because comments and ideas are added organically with time it's going to be sort-of hard to read. My thoughts coalesce and I write them down and it may not be consistent or complete but it's essentially this or trying to write up a blog post somewhere somehow, and that dream has lived for too long that I need to get something down on paper finally 😃