diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..6ed3a88 --- /dev/null +++ b/readme.md @@ -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.