You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

236 lines
9.0 KiB
Markdown

4 years ago
# Selfhosted-Apps-Docker
4 years ago
4 years ago
###### guide-by-example
4 years ago
4 years ago
---
4 years ago
![logo](https://i.imgur.com/u5LH0jI.png)
4 years ago
4 years ago
---
4 years ago
* [caddy_v2](caddy_v2/) - reverse proxy
1 year ago
* [vaultwarden](vaultwarden/) - password manager
4 years ago
* [bookstack](bookstack/) - notes and documentation
* [borg_backup](borg_backup/) - backup utility
* [ddclient](ddclient/) - automatic DNS update
4 years ago
* [dnsmasq](dnsmasq/) - DNS and DHCP server
1 year ago
* [gotify / ntfy / signal](gotify-ntfy-signal/) - instant notifications apps
4 years ago
* [homer](homer/) - homepage
1 year ago
* [jellyfin](jellyfin/) - video and music streaming
* [kopia](kopia_backup/) - backup utility replacing borg
2 years ago
* [minecraft](minecraft/) - game server
1 year ago
* [meshcrentral](meshcrentral/) - web based remote desktop, like teamviewer or anydesk
* [rustdesk](rustdesk/) - remote desktop, like teamviewer or anydesk
4 years ago
* [nextcloud](nextcloud/) - file share & sync
1 year ago
* [opnsense](opnsense/) - a firewall, enterprise level
2 years ago
* [qbittorrent](qbittorrent/) - video and music streaming
4 years ago
* [portainer](portainer/) - docker management
4 years ago
* [prometheus_grafana](prometheus_grafana/) - monitoring
1 year ago
* [unifi](unifi/) - management utility for ubiquiti devices
* [snipeit](snipeit/) - IT inventory management
* [trueNAS scale](trueNASscale/) - network file sharing
4 years ago
* [watchtower](watchtower/) - automatic docker images update
4 years ago
* [wireguard](wireguard/) - the one and only VPN to ever consider
1 year ago
* [zammad](zammad/) - ticketing system
4 years ago
* [arch_linux_host_install](arch_linux_host_install)
4 years ago
1 year ago
Can also just check the directories listed at the top for work in progress
1 year ago
2 years ago
Check also [StarWhiz / docker_deployment_notes](https://github.com/StarWhiz/docker_deployment_notes/blob/master/README.md)<br>
1 year ago
Repo documents self hosted apps in similar format and also uses caddy for reverse proxy
2 years ago
1 year ago
# Core concepts
4 years ago
1 year ago
- `docker-compose.yml` do not need any editing to get started,
changes are to be done in the `.env` file.
1 year ago
- Not using `ports` directive if theres only web traffic for a container.<br>
1 year ago
Theres an expectation of running a reverse proxy which makes mapping ports
1 year ago
to a docker host unnecessary. Instead `expose` is used which is basically
1 year ago
just documentation.<br>
- For persistent storage bind mount `./whatever_data` is used.
No volumes, nor static path somewhere... just relative path next to compose file.
1 year ago
- no version is declared in compose, as the practice was
[deprecated](https://nickjanetakis.com/blog/docker-tip-51-which-docker-compose-api-version-should-you-use)
4 years ago
1 year ago
# Requirements
4 years ago
1 year ago
**Basic linux and basic docker-compose knowledge.**
The shit here is pretty hand holding and detailed, but it still should not be
your first time running a docker container.
4 years ago
3 years ago
# Some extra info
4 years ago
1 year ago
### Caddy
1 year ago
Kinda the core of the setup is Caddy reverse proxy.</br>
It's described in most details, it's really amazingly simple but robust software.
1 year ago
All guides have reverse proxy section with Caddyfile config for them.
---
### Docker network
You really want to create a custom docker bridge network and use it.
`docker network create caddy_net`
It can be named whatever, but what it does over default is that it provides
[automatic DNS resolution](https://docs.docker.com/network/bridge/)
between containers. Meaning one can exec in to caddy container and ping another
container on that custom docker network by its hostname.
So config files can just use hostnames and they will work.
---
4 years ago
1 year ago
### .env
4 years ago
3 years ago
Often the `.env` file is used as `env_file`,
which can be a bit difficult concept at a first glance.
4 years ago
4 years ago
`env_file: .env`
* `.env` - actual name of a file that is used only by compose.</br>
4 years ago
It is used automatically just by being in the directory
4 years ago
with the `docker-compose.yml`</br>
1 year ago
Variables in it are available during the building of a container,
4 years ago
but unless named in the `environment:` option, they are not available
1 year ago
once the container is running.
4 years ago
* `env_file` - an option in compose that defines an existing external file.</br>
Variables in this file will be available in the running container,
but not during building of the container.
4 years ago
3 years ago
So a compose file having `env_file: .env` mixes these two together.
4 years ago
3 years ago
Benefit is that you do not need to make changes at multiple places.
Adding variables or changing a name in `.env` does not require you
to also go in to compose to add/change it there... also the compose file
looks much cleaner, less cramped.
4 years ago
4 years ago
Only issue is that **all** variables from the `.env` file are available in
all containers that use this `env_file: .env` method.</br>
1 year ago
That can lead to potential issues if a container picks up environment
variable that is intended for a different container of the stack.
4 years ago
4 years ago
In the setups here it works and is tested, but if you start to use this
everywhere without understanding it, you can encounter issues.
4 years ago
So first troubleshooting step should be abandoning `.env` and write out
3 years ago
the variables directly in the compose file only under containers that want them.
4 years ago
4 years ago
---
3 years ago
### Docker images latest tag
4 years ago
1 year ago
Most of the time the images are without any tag,
which defaults to `latest` tag being used.</br>
4 years ago
This is [frowned upon](https://vsupalov.com/docker-latest-tag/),
1 year ago
and you should put there the current tags once things are going.
It will make updates easier when you know you can go back to a working version
with backups and knowing image version.<br>
4 years ago
4 years ago
---
4 years ago
### Cloudflare
1 year ago
For managing DNS records. The free tier provides lot of management options and
3 years ago
benefits. Like proxy between your domain and your server, so no one
4 years ago
can get your public IP just from your domain name. Or 5 firewall rules that allow
you to geoblock whole world except your country.
[How to move to cloudflare.](https://support.cloudflare.com/hc/en-us/articles/205195708-Changing-your-domain-nameservers-to-Cloudflare)
4 years ago
---
### ctop
[official site](https://github.com/bcicen/ctop)
![ctop-look](https://i.imgur.com/nGAd1MQ.png)
1 year ago
htop like utility for quick containers management.
4 years ago
It is absofuckinglutely amazing in how simple yet effective it is.
1 year ago
* hardware use overview, so you know which container uses how much cpu, ram, bandwidth, IO,...
4 years ago
* detailed info on a container, it's IP, published and exposed ports, when it was created,..
1 year ago
* quick management, quick exec in to a container, check logs, stop it,...
4 years ago
1 year ago
Written in Go, so its super fast and installation is trivial when it is a single binary.<br>
download `linux-amd64` version; make it executable with chmod +x; move it to `/usr/bin/`;
now you can ctop anywhere.
---
### Sendinblue
Services often need ability to send emails, for notification, registration,
password reset and such... Sendinblue is free, offers 300 mails a day
and is easy to setup.
```
EMAIL_HOST=smtp-relay.sendinblue.com
EMAIL_PORT=587
EMAIL_HOST_USER=whoever_example@gmail.com>
EMAIL_HOST_PASSWORD=xcmpwik-c31d9eykwewf2342df2fwfj04-FKLzpHgMjGqP23
EMAIL_USE_TLS=1
```
3 years ago
1 year ago
---
### Archlinux as a docker host
My go-to is archlinux as I know it the best.
Usually in a virtual machine with snapshots before updates.
For Arch installation I had [this notes](arch_linux_host_install/)
on how to install and what to do afterwards.<br>
But after [archinstall script](https://wiki.archlinux.org/title/archinstall)
started to be included with arch ISO I switched to that.<br>
For after the install setup I created
[Ansible-Arch repo](https://github.com/DoTheEvo/ansible-arch) that gets shit
done in few minutes without danger of forgetting something.<br>
Ansible is really easy to use and very easy to read and understand playbooks,
so it might be worth the time to check out the concept to setup own ansible scripts.
The best aspect of having such repo is that it is a dedicated place where
one can write solution to issues encountered,
1 year ago
or enable freshly discovered feature for all future deployments.
1 year ago
---
1 year ago
### Other guides
1 year ago
1 year ago
* [StarWhiz/docker_deployment_notes](https://github.com/StarWhiz/docker_deployment_notes)
- got inspired and wrote in similar way setup for various services
* [BaptisteBdn/docker-selfhosted-apps](https://github.com/BaptisteBdn/docker-selfhosted-apps)
- many services using traefik for reverse proxy
* [Awesome Docker Compose Examples](https://github.com/Haxxnet/Compose-Examples)
1 year ago
1 year ago
---
1 year ago
1 year ago
### For docker noobs
3 years ago
1 year ago
First, docker is easy. Like really.<br>
3 years ago
1 year ago
Second, there are two main uses.
3 years ago
1 year ago
* A developer who daily works on an app and docker eases everything about it, from testing to deployment
* A self-hosting / devops approach, where you just want to get a service running
This whole repo is obviously about the second use. So be careful that you wont
spend time on resources used to educate the developers. I mean if you get through
that you will know docker better. But theres always danger that after sinking
4 hours in to learning it, one cant even get nginx web server up and working.
And my personal preference in learning is getting something up as fast as possible
and then tinker with it and try to understand it.
So to solve this, when googling for guides, look for *docker compose*
rather than just docker tutorials and notice if they are talking fundamentals or
deployment.
* [This](https://youtu.be/DM65_JyGxCo) one is pretty good. That entire channel
has good stuff worth looking.
3 years ago
1 year ago
Will add stuff as I encounter it.