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.

248 lines
9.8 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
7 months ago
* [kopia](kopia_backup/) - backup utility replacing borg
4 years ago
* [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
7 months ago
* [frigate](frigate/) - managing security cameras
1 year ago
* [jellyfin](jellyfin/) - video and music streaming
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
1 year ago
* [qbittorrent](qbittorrent/) - torrent client
4 years ago
* [portainer](portainer/) - docker management
1 year ago
* [prometheus_grafana_loki](prometheus_grafana_loki/) - monitoring
1 year ago
* [unifi](unifi/) - management utility for ubiquiti devices
* [snipeit](snipeit/) - IT inventory management
* [trueNAS scale](trueNASscale/) - network file sharing
7 months ago
* [uptime kuma](uptime-kuma/) - uptime alerting tool
* [squid](squid/) - anonymize forward proxy
4 years ago
* [wireguard](wireguard/) - the one and only VPN to ever consider
1 year ago
* [wg-easy](wg-easy/) - wireguard in docker with web gui
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
---
1 year ago
* ### [For Docker Noobs](#for-docker-noobs-1)
1 year ago
---
1 year ago
# Core concepts
4 years ago
1 year ago
- `docker-compose.yml` does **not** need any **editing** to get something up,
**changes** are to be done in the `.env` file.
1 year ago
- For **persistent** storage **bind mount** `./whatever_data` is used.
1 year ago
No volumes, nor static path somewhere... just relative path next to compose file.
1 year ago
- **No version** declaration at the beginning of **compose**, as the practice was
1 year ago
[**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
1 year ago
---
4 years ago
1 year ago
### Caddy reverse proxy
1 year ago
1 year ago
Kinda the heart of the setup is [Caddy reverse proxy](https://github.com/DoTheEvo/selfhosted-apps-docker/tree/master/caddy_v2).</br>
It's described in most details and all guides have reverse proxy section
with Caddyfile config specific for them.</br>
Caddy is really great at simplifying the mess of https certificates, where
you don't really have to deal with anything, while having a one simple,
readable config file.
1 year ago
1 year ago
But no problem if using [traefik](https://github.com/DoTheEvo/Traefik-v2-examples)
or nginx proxy manager. You just have to deal with proxy settings on your own,
1 year ago
and 90% of the time its just sending traffic to port 80 and nothing else.
1 year ago
---
### Docker network
1 year ago
You really want to create a custom named docker network and use it.
1 year ago
`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/)
1 year ago
between containers. Meaning one can exec in to a container and ping another
container by its hostname.<br>
This makes config files simpler and cleaner.
1 year ago
---
4 years ago
1 year ago
### .env
4 years ago
4 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
4 years ago
So a compose file having `env_file: .env` mixes these two together.
4 years ago
4 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.
1 year ago
So one of the troubleshooting steps might be abandoning `.env` and write out
4 years ago
the variables directly in the compose file only under containers that want them.
4 years ago
4 years ago
---
4 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
4 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.
---
7 months ago
### Brevo
1 year ago
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.
```
7 months ago
EMAIL_HOST=smtp-relay.brevo.com
1 year ago
EMAIL_PORT=587
7 months ago
EMAIL_HOST_USER=whoever_example@gmail.com
EMAIL_HOST_PASSWORD=xcmpwik-c31d9eykwef3342df2fwfj04-FKLzpHgMjGqP23
1 year ago
EMAIL_USE_TLS=1
```
4 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
4 years ago
4 months ago
* [Beginners speedrun to selfhosting](beginners-speedrun-selfhosting/)
4 weeks ago
* [How to setup Windows 11 as a Home Server/NAS](https://www.youtube.com/watch?v=5pZu35hTipo)
* [Docke rTechnical Deep Dive](https://medium.com/@furkan.turkal/how-does-docker-actually-work-the-hard-way-a-technical-deep-diving-c5b8ea2f0422)
4 years ago
1 month ago
---
4 years ago
4 months ago
### YouTube channels
1 year ago
4 months ago
Maybe list of some youtube channels to follow would not be bad idea.
1 year ago
4 months ago
* [Fireship](https://www.youtube.com/@Fireship/videos) - funny news and tips
* [TechnoTim](https://www.youtube.com/@TechnoTim/videos) - general homeserver selfhosting
* [Craft Computing](https://www.youtube.com/@CraftComputing/videos) - general homeserver, bit more focus on hw and building
* [Wolfgang's Channel](https://www.youtube.com/@WolfgangsChannel/videos) - general homeserver selfhosting, power consumption priority
4 weeks ago
* [Lawrence Systems](https://www.youtube.com/@LAWRENCESYSTEMS/videos) - general homeserver selfhosting
4 months ago
* [Christian Lempa](https://www.youtube.com/@christianlempa/videos) - general homeserver selfhosting
* [NASCompares](https://www.youtube.com/@nascompares) - Nas builds / home servers
4 weeks ago
* [Peter Brockie](https://www.youtube.com/@PeterBrockie/videos) - Nas builds / home servers
4 months ago
* [Awesome Open Source](https://www.youtube.com/@AwesomeOpenSource/videos)
\- open source software insight
* [Hardware Haven](https://www.youtube.com/@HardwareHaven/videos) - nas, servers, miniPCs focused
* [ServeTheHome](https://www.youtube.com/@ServeTheHomeVideo/videos) - hardware, miniPCs, switches,.
1 year ago