nune/docker-compose-files
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add README.md

Browse Source
This commit is contained in:
nune 2024-12-12 23:53:26 +00:00
commit a98bf37445
1 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md Normal file
View File

@ -0,0 +1,22 @@
## How to use
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.
## 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.
Use a server in your home properly configured, or a VPS. I personally recommend Webdock for a VPS.
You don't need to do any steps to install dependencies for these services other than docker-compose, docker containers do that for you inside the container.
## Basic reverse proxy
This will work fine for most things assuming the URL is configured in `environment:` section/config if needed.
Install caddy with the following command after `apt-get update` and `apt-get upgrade`:
```
apt-get install caddy
```
Once installed, make a folder and make a file named Caddyfile. Write this in it with nano, and replace accordingly. The number can be replaced with the machine port (again, first number under ports section).
Make sure the domain has a DNS record with the server IP.
```
example.com {
reverse_proxy localhost:7825
}
```
Then type `caddy reload` or `caddy start`.
Wait a bit, and your service should come up.