feat(readme): add readme to repository

This commit is contained in:
stitchy 2024-12-24 06:09:18 -08:00
parent 37fbf26658
commit 807deb9571
Signed by: stitchy
SSH key fingerprint: SHA256:f7Wxv5r7Ooi4z3GxqMBx50LlPRtY/kUK/Sw8K02PYys

18
readme.md Normal file
View file

@ -0,0 +1,18 @@
# Docker Containers
A repository to store the docker container configurations located on the `tanzanite` host in my [nixos configuration](https://gay.stitchy.moe/stitchy/dotfiles).
Since most of these containers were created before this repository came into existence, a lot of the containers have plain-text private keys in them and thus have not been migrated. Over time, the amount of these will hopefully decrease to zero. In addtion, this repo might eventually be swallowed entirely by the nixos configuration. Only time will tell.
## Usage
These containers should all work with docker compose. Simply run:
```bash
docker compose up -d
```
in the directory and the service will start. Many services have .env files or require configurations that are not present at the moment, proceed with caution.
## Contributing
Feel free to add any PRs with fixes and whatnot. I don't think there is a ton to be done here though.