Update README.md

This commit is contained in:
nune 2024-12-22 02:49:55 +00:00
parent f92f036aee
commit a98dc7f49a

View File

@ -2,6 +2,7 @@ On Github or somewhere else? This is mirrored from: https://gitz.blitzw.in/nune/
## How to use ## How to use
You need to install docker-compose. Also Caddy if you need a reverse proxy. You need to install docker-compose. Also Caddy if you need a reverse proxy.
Generally with these, you'll make a folder for the service you wanna host, make a file called compose.yml, copy the contents in, modify accordingly, and `docker compose up -d` these up. Generally with these, you'll make a folder for the service you wanna host, make a file called compose.yml, copy the contents in, modify accordingly, and `docker compose up -d` these up.
For a reverse proxy, you need a domain. If you can't buy any domain for any reason, eu.org and [freedns](https://freedns.afraid.org/) are awesome projects that can host stuff for you and give you a domain for free that you can reverse-proxy safely to.
## Things to keep in mind ## Things to keep in mind
The first four-five-digit number in ports is the port for your machine, the second after the `:` is the port for the container. Don't change the second number unless there's a configuration setting that allows you to modify like so. The first four-five-digit number in ports is the port for your machine, the second after the `:` is the port for the container. Don't change the second number unless there's a configuration setting that allows you to modify like so.
Use a server in your home [properly configured](https://caddy.community/t/using-caddy-as-a-reverse-proxy-in-a-home-network/9427), or a VPS. I personally recommend Webdock for a VPS. Use a server in your home [properly configured](https://caddy.community/t/using-caddy-as-a-reverse-proxy-in-a-home-network/9427), or a VPS. I personally recommend Webdock for a VPS.