From 33fdfdfc9000d482078abbcd09ca3e0a0d8c441b Mon Sep 17 00:00:00 2001 From: TiynGER Date: Wed, 10 Mar 2021 21:30:32 +0100 Subject: [PATCH] restructuring: reevaluating the docker headers --- wiki/airsonic.md | 14 +++++----- wiki/bare-git.md | 10 +++---- wiki/bind.md | 12 ++++----- wiki/cloudflare-ddns.md | 2 +- wiki/cups.md | 16 +++++------ wiki/databases.md | 9 +++++++ wiki/dovecot.md | 8 ++---- wiki/file-synchronization.md | 4 +-- wiki/flask.md | 10 +++---- wiki/foldingathome.md | 12 ++++----- wiki/gitea.md | 52 +++++++++--------------------------- wiki/golinks.md | 16 +++++------ wiki/gopher-proxy.md | 10 +++---- wiki/gopher-server.md | 12 ++++----- wiki/hastebin.md | 12 ++++----- wiki/homer.md | 12 ++++----- wiki/jellyfin.md | 16 +++++------ wiki/mariadb.md | 30 +++++++++++++++++++++ wiki/mordhau.md | 14 +++++----- wiki/mysql.md | 34 +++++++++++++++++++++++ wiki/nginx.md | 8 +++--- wiki/onedrive.md | 10 +++---- wiki/openvpn.md | 12 ++++----- wiki/owncloud.md | 47 +++++++++----------------------- wiki/pinedocs.md | 10 +++---- wiki/plex.md | 12 ++++----- wiki/portainer.md | 20 ++++++-------- wiki/prologic-todo.md | 10 +++---- wiki/radicale.md | 14 +++++----- wiki/samba.md | 12 ++++----- wiki/searx.md | 10 +++---- wiki/syncthing.md | 12 ++++----- wiki/teamspeak.md | 12 ++++----- wiki/yourls.md | 36 ++++++------------------- 34 files changed, 240 insertions(+), 290 deletions(-) create mode 100644 wiki/databases.md create mode 100644 wiki/mariadb.md create mode 100644 wiki/mysql.md diff --git a/wiki/airsonic.md b/wiki/airsonic.md index 9cab7c3..48bb164 100644 --- a/wiki/airsonic.md +++ b/wiki/airsonic.md @@ -4,13 +4,11 @@ Airsonic is a free and open-source personal media streamer. It is a fork of [Subsonic](https://www.subsonic.org) and thus is compatible with most of its clients. -## Setup Server - -### Docker +## Setup server with Docker The official container and documentation was made by [linuxserver](https://hub.docker.com/r/linuxserver/airsonic). -#### Environment-variables +### Environment-variables Set the following variables with the -e tag. @@ -20,7 +18,7 @@ Set the following variables with the -e tag. | `PGID` | GroupID | | | `TZ` | Timezone | | -#### Volumes +### Volumes Set the following volumes with the -v tag. @@ -33,7 +31,7 @@ Set the following volumes with the -v tag. | `media_audiobooks` | `/audiobooks` | Location for audiobooks | | `media_podcasts` | `/podcasts` | location for podcasts | -#### Ports +### Ports Set the following ports with the -p tag. @@ -41,7 +39,7 @@ Set the following ports with the -p tag. | -------------- | ------------------------ | -------- | ----------- | | `4040` | `4040` | TCP | WebUI | -#### Rebuild +### Rebuild ```shell #!/bin/sh @@ -63,7 +61,7 @@ docker run --name=airsonic \ -d linuxserver/airsonic ``` -## Setup Client +## Client As already mentioned it is possible to use a bunch of different clients because the server is compatible with most of the Subsonic clients. diff --git a/wiki/bare-git.md b/wiki/bare-git.md index 68c6394..86aecb3 100644 --- a/wiki/bare-git.md +++ b/wiki/bare-git.md @@ -1,12 +1,10 @@ # Bare Git -## Setup Server - -### Docker +## Setup server with Docker The official container and documentation was made by [jkarlos](https://hub.docker.com/r/jkarlos/git-server-docker). -#### Volumes +### Volumes Set the following volumes with the -v tag. @@ -15,7 +13,7 @@ Set the following volumes with the -v tag. | `git-server_repos` | `/git-server/repos` | storage for git repos | | `git-server_keys` | `/git-server/keys` | storage for user ssh keys | -#### Ports +### Ports Set the following ports with the -p tag. @@ -23,7 +21,7 @@ Set the following ports with the -p tag. | -------------- | ------------------------ | -------- | ------------------------------------- | | `22` | `2222` | TCP | ssh port for accessing the git server | -#### Rebuild +### Rebuild ```shell #!/bin/sh diff --git a/wiki/bind.md b/wiki/bind.md index f9b65ac..8000c6f 100644 --- a/wiki/bind.md +++ b/wiki/bind.md @@ -1,12 +1,10 @@ # Bind -## Setup Server - -### Docker +## Setup with Docker The official container and documentation was made by [ventz](https://hub.docker.com/r/ventz/bind). -#### Volumes +### Volumes Set the following volumes with the -v tag. @@ -15,7 +13,7 @@ Set the following volumes with the -v tag. | `bind_cache` | `/var/cache/bind` | cache for dns | | `bind_etc` | `/etc/bind` | configuration for dns | -#### Ports +### Ports Set the following ports with the -p tag. @@ -24,7 +22,7 @@ Set the following ports with the -p tag. | `53` | `53` | TCP | dns protocol port | | `53` | `53` | UDP | dns protocol port | -#### Additional +### Additional There are some special variables to set. @@ -32,7 +30,7 @@ There are some special variables to set. | ------- | ------------------------------------------------------- | | `--dns` | set two of these flags for specific dns forward servers | -#### Rebuild +### Rebuild ```shell #!/bin/sh diff --git a/wiki/cloudflare-ddns.md b/wiki/cloudflare-ddns.md index fe6af3a..81d990a 100644 --- a/wiki/cloudflare-ddns.md +++ b/wiki/cloudflare-ddns.md @@ -4,7 +4,7 @@ If you have a dynamic IP address, you will need to update your domain on cloudfl regularly to ensure you're mapping onto the right address. This service will do that for you. -## Docker +## Setup with Docker The official container and documentation was made by [oznu](https://github.com/oznu/docker-cloudflare-ddns). diff --git a/wiki/cups.md b/wiki/cups.md index eb3f5d2..bf3cbe6 100644 --- a/wiki/cups.md +++ b/wiki/cups.md @@ -1,12 +1,10 @@ # Cups -## Setup Server - -### Docker +## Setup Server with Docker The official container and documentation was made by [olbat](https://hub.docker.com/r/olbat/cupsd). -#### Volumes +### Volumes Set the following volumes with the -v tag. @@ -15,7 +13,7 @@ Set the following volumes with the -v tag. | `cups` | `/etc/cups` | configuration for printers, etc | | `/var/run/dbus` | `/var/run/dbus` | connection to host dbus | -#### Ports +### Ports Set the following ports with the -p tag. @@ -23,11 +21,11 @@ Set the following ports with the -p tag. | -------------- | ------------------------ | -------- | ----------------- | | `631` | `631` | TCP | cups server webui | -#### Additional +### Additional The default username is `print`, the default password is `print`. -#### Rebuild +### Rebuild ```shell #!/bin/sh @@ -43,7 +41,9 @@ docker run --name cups \ -d olbat/cupsd:latest ``` -## Client Setup +## Client + +For Linux computers follow the guide below: - Install the cups-client package (in Arch Linux it is included in `cups`) - Edit `/etc/cups/client.conf` and insert `ServerName :631` diff --git a/wiki/databases.md b/wiki/databases.md new file mode 100644 index 0000000..4455b05 --- /dev/null +++ b/wiki/databases.md @@ -0,0 +1,9 @@ +# Databases + +Databases are data collections of a computer system. +Most prominent type of database are SQL databases. + +## Database management systems (DBMS) + +- [MySQL](./mysql.md) is a relational DBMS +- [MariaDB](./mariadb.md) is a relational DBMS that is a fork of MySQL diff --git a/wiki/dovecot.md b/wiki/dovecot.md index 5a4ae7f..7ff1eff 100644 --- a/wiki/dovecot.md +++ b/wiki/dovecot.md @@ -1,14 +1,10 @@ # Dovecot -## Setup Server - -### Docker +## Setup with Docker The official container and documentation was made by [tvial](https://hub.docker.com/r/tvial/docker-mailserver). It contains dovecot, antispam, antivirus, ssl, etc. -#### Configuration - The configuration is done automatically using scripts by tvial. First you need to download the essential setup files. @@ -33,7 +29,7 @@ And finally generate the DCIM keys and rebuild once again. Afterwards you're ready to go by once again running the `rebuild.sh` file. -#### Rebuild +### Rebuild ```shell #!/bin/sh diff --git a/wiki/file-synchronization.md b/wiki/file-synchronization.md index 7509c27..05611ed 100644 --- a/wiki/file-synchronization.md +++ b/wiki/file-synchronization.md @@ -4,7 +4,7 @@ Tools to synchronize data and so called clouds are pretty handy to use files on different machines. There are tools with a main server and there are tools that don't need them. -## Synchronizing with main server +## Synchronizing with server The biggest advantage of having a main server contain your data is that - as long as the server is online - @@ -17,7 +17,7 @@ If you are talking about a cloud, this is this. - [Onedrive](onedrive.md) is a very popular piece of software despite being proprietary. You can not self-host it, but you can run a dockerized client. -## Synchronizing without main server +## Synchronizing without server If you can bare the difficulties ascending due to the mentioned above problems, this is probably a more diff --git a/wiki/flask.md b/wiki/flask.md index 74c49b0..58e0024 100644 --- a/wiki/flask.md +++ b/wiki/flask.md @@ -1,12 +1,10 @@ # Flask -## Setup Server - -### Docker +## Setup with Docker The original container and documentation are made by [tiynger](https://hub.docker.com/r/tiynger/pythonflask). -#### Volumes +### Volumes Set the following volumes with the -v tag. @@ -14,7 +12,7 @@ Set the following volumes with the -v tag. | ----------- | --------------- | ------------------------------- | | `app` | `/flask` | directory for flask application | -#### Ports +### Ports Set the following volumes with the -p tag. @@ -22,7 +20,7 @@ Set the following volumes with the -p tag. | -------------- | --------------------- | -------- | ----------- | | `5000` | `80` | TCP | HTTP port | -#### Rebuild +### Rebuild ```shell #!/bin/sh diff --git a/wiki/foldingathome.md b/wiki/foldingathome.md index 19a22c2..df37c2d 100644 --- a/wiki/foldingathome.md +++ b/wiki/foldingathome.md @@ -1,12 +1,10 @@ # Folding-at-home -## Setup - -### Docker +## Setup with Docker The official container and documentation was made by [johnktims](https://hub.docker.com/r/johnktims/folding-at-home). -#### Ports +### Ports Set the following ports with the -p tag. @@ -14,7 +12,7 @@ Set the following ports with the -p tag. | -------------- | ------------------------ | -------- | ----------- | | `7396` | `7396` | TCP | WebUI | -#### Additional +### Additional There are some special variables to set. @@ -24,14 +22,14 @@ There are some special variables to set. | `--power` | set the default power to fold at home | | `--team` | set your teamid to contribute points | -##### GPU +#### GPU To add a nvidia gpu add the `nvidia-docker-toolkit` or the recommended software for your gpu. After that you can set you gpu to fold aswell by adding `--gpus=all`. GPU support is also mentioned in [the docker entry](docker.md). -#### Rebuild +### Rebuild ```shell #!/bin/sh diff --git a/wiki/gitea.md b/wiki/gitea.md index c44e0d3..776d3e0 100644 --- a/wiki/gitea.md +++ b/wiki/gitea.md @@ -9,13 +9,14 @@ If you want to use all features in addition to the basic client described in [git.md](git.md) but don't want to use the web-interface all the time you can get [tea](https://gitea.com/gitea/tea) the official cli-tool for gitea. -## Setup Server +## Setup Server with Docker -### Docker +The Server consists of 2 Docker containers, one is the gitea main server and one +is a database. +In addition to the main container you need to connect a [mySQL container](./mysql.md) +to it. -#### Gitea - -##### Environment-variables +### Environment-variables Set the following environment-variables in the `environment:` section of the docker-compose file. @@ -30,7 +31,7 @@ docker-compose file. | `DB_USER` | Username for the database | | | `DB_PASSWD` | Password for the database | | -##### Volumes +### Volumes Set the following volumes in the `volumes:` section of the docker-compose file. @@ -40,7 +41,7 @@ Set the following volumes in the `volumes:` section of the docker-compose file. | `/etc/timezone` | `/etc/timezone:ro` | link timezone | | `/etc/localtime` | `/etc/localtime` | link localtime | -##### Ports +### Ports Set the following ports in the `ports:` section. @@ -49,7 +50,7 @@ Set the following ports in the `ports:` section. | `3000` | `3000` | TCP | WebUI | | `22` | `222` | TCP | ssh port of git server | -##### Networks +### Networks Set the following networks in the `networks:` section of the docker-compose file. @@ -57,7 +58,7 @@ Set the following networks in the `networks:` section of the docker-compose file | ------- | --------------------- | | `gitea` | connect db with gitea | -##### Dependencies +### Dependencies Set the following dependencies in the `depends_on:` section of the docker-compose file. @@ -66,37 +67,8 @@ docker-compose file. | ---- | -------------------- | | `db` | Ensure db is running | -#### MySql - -##### Environment-variables - -Set the following environment-variables in the `environment:` section of the -docker-compose file. - -| Name | Usage | Default | -| --------------------- | ----------------------------- | ------- | -| `MYSQL_ROOT_PASSWORD` | set the mysql admin password | | -| `MYSQL_USER` | set the mysql username | | -| `MYSQL_PASSWORD` | set the mysql user password | | -| `MYSQL_Database` | specify mysql database to use | | - -##### Volumes - -Set the following volumes in the `volumes:` section of the docker-compose file. - -| Volume-Name | Container mount | Description | -| ----------- | ---------------- | ------------------------- | -| `mysql` | `/var/lib/mysql` | storage for owncloud data | - -##### Networks - -Set the following networks in the `networks:` section of the docker-compose file. - -| Name | Usage | -| ------- | --------------------- | -| `gitea` | connect db with gitea | -#### Rebuild +### Rebuild ```shell #!/bin/sh @@ -104,7 +76,7 @@ docker-compose down docker-compose up -d ``` -#### Docker-Compose.yml +### Docker-Compose.yml ```yml version: "2" diff --git a/wiki/golinks.md b/wiki/golinks.md index 650ab77..03e587e 100644 --- a/wiki/golinks.md +++ b/wiki/golinks.md @@ -3,11 +3,9 @@ [Golinks](https://github.com/prologic/golinks) is a web app that can create and use bookmarks and run different searches by prefixes. -## Setup +## Setup Server with Docker -### Docker - -#### Volumes +### Volumes Set the following volumes with the -v tag. @@ -15,7 +13,7 @@ Set the following volumes with the -v tag. | ----------- | --------------- | -------------------------- | | `golinks` | `/search.db` | database with all commands | -#### Ports +### Ports Set the following ports with the -p tag. @@ -23,7 +21,7 @@ Set the following ports with the -p tag. | -------------- | ------------------------ | -------- | ----------- | | `8000` | `8000` | TCP | WebUI | -#### Rebuild +### Rebuild ```shell #!/bin/sh @@ -32,7 +30,7 @@ docker pull prologic/golinks:latest docker-compose up -d ``` -#### Docker-Compose.yml +### Docker-Compose.yml ```yml version: "3.1" @@ -54,7 +52,9 @@ volumes: driver: local ``` -### Setup in Firefox +## Client + +### Firefox Add Golinks as a new search engine for firefox and set it as main search for the address bar as described in [the Firefox article](./firefox.md). diff --git a/wiki/gopher-proxy.md b/wiki/gopher-proxy.md index 67dfcd6..52772dc 100644 --- a/wiki/gopher-proxy.md +++ b/wiki/gopher-proxy.md @@ -1,12 +1,10 @@ # Gopherproxy -## Setup Proxy - -### Docker +## Setup with Docker The official container and documentation was made by [prologic](https://hub.docker.com/r/prologic/gopherproxy). -#### Ports +### Ports Set the following ports with the -p tag. @@ -14,7 +12,7 @@ Set the following ports with the -p tag. | -------------- | ------------------------ | -------- | ---------------------------------------- | | `8000` | `8000` | TCP | port to proxy the gopher site as http to | -#### Additional +### Additional There are some special variables to set. @@ -22,7 +20,7 @@ There are some special variables to set. | ------ | ------------------------------------------------------------- | | `-uri` | define the gopher site to proxy (just 'domain.tld' is enough) | -#### Rebuild +### Rebuild ```shell #!/bin/sh diff --git a/wiki/gopher-server.md b/wiki/gopher-server.md index a24ab77..04138a0 100644 --- a/wiki/gopher-server.md +++ b/wiki/gopher-server.md @@ -1,12 +1,10 @@ # Gopher Server -## Setup Server - -### Docker +## Setup with Docker The official container and documentation was made by [tiynger](https://hub.docker.com/r/tiynger/gopherserver). -#### Environment-variables +### Environment-variables Set the following variables with the -e tag. @@ -14,7 +12,7 @@ Set the following variables with the -e tag. | ------------- | --------------------------------------------------- | ----------- | | `SERVER_NAME` | set this to your IP/Domain (no "gopher://" needed!) | `localhost` | -#### Volumes +### Volumes Set the following volumes with the -v tag. @@ -22,7 +20,7 @@ Set the following volumes with the -v tag. | -------------- | --------------- | ----------------------------- | | `gopherwebdir` | `/var/gopher` | directory for the gopher page | -#### Ports +### Ports Set the following ports with the -p tag. @@ -30,7 +28,7 @@ Set the following ports with the -p tag. | -------------- | ------------------------ | -------- | ---------------------------- | | `70` | `70` | TCP | port for the gopher-protocol | -#### Rebuild +### Rebuild ```shell #!/bin/sh diff --git a/wiki/hastebin.md b/wiki/hastebin.md index 828056d..97420f0 100644 --- a/wiki/hastebin.md +++ b/wiki/hastebin.md @@ -1,12 +1,10 @@ # Hastebin -## Setup Server - -### Docker +## Setup with Docker The official container and documentation was made by [rlister](https://hub.docker.com/r/rlister/hastebin). -#### Environment-variables +### Environment-variables Set the following variables with the -e tag. @@ -14,7 +12,7 @@ Set the following variables with the -e tag. | -------------- | ----------------------- | ------- | | `STORAGE_TYPE` | Type to store the datas | `file` | -#### Volumes +### Volumes Set the following volumes with the -v tag. @@ -22,7 +20,7 @@ Set the following volumes with the -v tag. | ----------- | --------------- | -------------------------- | | `hastebin` | `/app/data` | storage directory for data | -#### Ports +### Ports Set the following ports with the -p tag. @@ -30,7 +28,7 @@ Set the following ports with the -p tag. | -------------- | ------------------------ | -------- | ----------- | | `7777` | `7777` | TCP | WebUI | -#### Rebuild +### Rebuild ```shell #!/bin/sh diff --git a/wiki/homer.md b/wiki/homer.md index 9519c1c..1604ab7 100644 --- a/wiki/homer.md +++ b/wiki/homer.md @@ -1,12 +1,10 @@ # Homer -## Setup Server - -### Docker +## Setup with Docker The official container and documentation was made by [b4bz](https://hub.docker.com/r/b4bz/homer). -#### Volumes +### Volumes Set the following volumes with the -v tag. @@ -15,7 +13,7 @@ Set the following volumes with the -v tag. | `/current/dir/config.yml` | `/www/config.yml` | configuration file for static page | | `homer` | `/www/assets` | storage for icons, etc | -#### Ports +### Ports Set the following ports with the -p tag. @@ -23,7 +21,7 @@ Set the following ports with the -p tag. | -------------- | ------------------------ | -------- | ----------- | | `8080` | `8080` | TCP | WebUI | -#### Rebuild +### Rebuild ```shell #!/bin/sh @@ -38,7 +36,7 @@ docker run --name homer \ -d b4bz/homer:latest ``` -#### Configuration +### Configuration This is a sample config.yml: diff --git a/wiki/jellyfin.md b/wiki/jellyfin.md index e9dfde6..17cb820 100644 --- a/wiki/jellyfin.md +++ b/wiki/jellyfin.md @@ -3,14 +3,12 @@ [Jellyfin](https://jellyfin.ord) is a suite for multimedia streaming. It includes a web-interface. -## Setup Server - -### Docker +## Setup with Docker The official container and documentation was made by [linuxserver](https://hub.docker.com/linuxserver/jellyfin). This docker-rebuild is made up by a `docker-compose.yml` file. -#### Environment-variables +### Environment-variables Set the following environment-variables in the `environment:` section of the docker-compose file. @@ -20,7 +18,7 @@ Set the following environment-variables in the `environment:` section of the doc | `PGID` | Groupid to run the container | | | `TZ` | specify the timezone | | -#### Volumes +### Volumes Set the following volumes in the `volumes:` section of the docker-compose file. @@ -38,7 +36,7 @@ it is recommended to use them as external volumes (volumes section: To use the rebuild the volumes have to exist before creating the container (`docker volume create media_movies` and tvshows accordingly). -#### Ports +### Ports Set the following ports in the `ports:` section. @@ -46,7 +44,7 @@ Set the following ports in the `ports:` section. | -------------- | ------------------------ | -------- | ----------- | | `8096` | `8096` | TCP | WebUI | -#### Rebuild +### Rebuild ```shell #!/bin/sh @@ -55,7 +53,7 @@ docker pull linuxserver/jellyfin:latest docker-compose up -d ``` -#### Docker-Compose.yml +### Docker-Compose.yml ```yml version: "2" @@ -87,7 +85,7 @@ volumes: external: true ``` -### Add IP-TV +## Add IP-TV You can add IP-TV under `Live TV` in the administration panel. To include a m3u IP-TV stream just put the file on the server or copy its URL diff --git a/wiki/mariadb.md b/wiki/mariadb.md new file mode 100644 index 0000000..3f3dae3 --- /dev/null +++ b/wiki/mariadb.md @@ -0,0 +1,30 @@ +# MariaDB + +[MariaDB](https://www.mariadb.com) is an open-source database management system +forked from [mySQL](./mysql.md). + +## Setup Server with Docker + +The official container and documentation was made by [mariadb](https://hub.docker.com/_/mariadb). +The Docker container is mainly used in combination with other containers. +To achieve this in the easiest way use a docker-compose file + +### Environment-variables + +Set the following environment-variables in the `environment:` section of the +docker-compose file. + +| Name | Usage | Default | +| --------------------- | ----------------------------- | ------- | +| `MYSQL_ROOT_PASSWORD` | set the mysql admin password | | +| `MYSQL_USER` | set the mysql username | | +| `MYSQL_PASSWORD` | set the mysql user password | | +| `MYSQL_Database` | specify mysql database to use | | + +### Volumes + +Set the following volumes in the `volumes:` section of the docker-compose file. + +| Volume-Name | Container mount | Description | +| ----------- | ---------------- | ------------------------- | +| `mysql` | `/var/lib/mysql` | storage for owncloud data | diff --git a/wiki/mordhau.md b/wiki/mordhau.md index b930bca..8c9fa7a 100644 --- a/wiki/mordhau.md +++ b/wiki/mordhau.md @@ -1,12 +1,10 @@ # Mordhau -## Setup Server - -### Docker +## Setup with Docker The official container and documentation was made by [tetricz](https://hub.docker.com/r/tetricz/mordhau-server). -#### Environment-variables +### Environment-variables Set the following variables with the -e tag. @@ -25,7 +23,7 @@ Set the following variables with the -e tag. | `SERVER_PASSWORD` | set a password | | | `ADMIN_PASSWORD` | set an admin password | | -#### Volumes +### Volumes Set the following volumes with the -v tag. @@ -34,7 +32,7 @@ Set the following volumes with the -v tag. | `mordhau` | `/serverdata/mordhau` | storage for mordhau server relevant data | | `mordhau_steamcmd` | `/serverdata/steamcmd` | storage for steam related data | -#### Ports +### Ports Set the following ports with the -p tag. | Container Port | Recommended outside port | Protocol | Description | @@ -43,7 +41,7 @@ Set the following ports with the -p tag. | `15000` | `15000` | UDP | mordhau internal | | `27015` | `27015` | UDP | mordhau internal | -#### Start +### Start ```shell #!/bin/sh @@ -71,7 +69,7 @@ docker run --name=mordhau \ tetricz/mordhau-server ``` -#### Stop +### Stop ```shell #/bin/sh diff --git a/wiki/mysql.md b/wiki/mysql.md new file mode 100644 index 0000000..f6e9b3d --- /dev/null +++ b/wiki/mysql.md @@ -0,0 +1,34 @@ +# MySQL + +[MySQL](https://www.mysql.com) is an open-source database management system. + +## Setup with Docker + +The official container and documentation was made by [MySQL](https://hub.docker.com/_/mysql). +The Docker container is mainly used in combination with other containers. +To achieve this in the easiest way use a docker-compose file + +### Environment-variables + +Set the following environment-variables in the `environment:` section of the +docker-compose file. + +| Name | Usage | Default | +| --------------------- | ----------------------------- | ------- | +| `MYSQL_ROOT_PASSWORD` | set the mysql admin password | | +| `MYSQL_USER` | set the mysql username | | +| `MYSQL_PASSWORD` | set the mysql user password | | +| `MYSQL_Database` | specify mysql database to use | | + +### Volumes + +Set the following volumes in the `volumes:` section of the docker-compose file. + +| Volume-Name | Container mount | Description | +| ----------- | ---------------- | ------------------------- | +| `mysql` | `/var/lib/mysql` | storage for owncloud data | + +### Networks + +You can set networks in the `networks:` part of a docker-compose file to connect +the database with other docker containers. diff --git a/wiki/nginx.md b/wiki/nginx.md index a43d6a9..2adc9d7 100644 --- a/wiki/nginx.md +++ b/wiki/nginx.md @@ -1,8 +1,6 @@ # Nginx -## Setup Server - -### Docker +## Docker The easiest way to configure and run nginx is [ncdt](https://github.com/nasourso/nginx-certbot-docker-tui) by nasourso. @@ -14,7 +12,7 @@ You can just run the script and it will install all needed dependencies. After that just go ahead and start the container. You can then configure reverse proxies by adding websites. -#### Block remote port access +### Block remote port access If you configured a reverse proxy to a port chances are you don't want the port to be accessed outside of the proxy. @@ -25,7 +23,7 @@ This can be changed at the forwarded docker-service by replacing for example This forces the docker container to only expose the port in the docker bridge network, effectively banning remote access. -#### Rebuild +### Rebuild ```shell #!/bin/sh diff --git a/wiki/onedrive.md b/wiki/onedrive.md index cca4739..dca68b0 100644 --- a/wiki/onedrive.md +++ b/wiki/onedrive.md @@ -1,12 +1,10 @@ # Onedrive -## Setup Mirror - -### Docker +## Setup with Docker The official container and documentation was made by [oznu](https://hub.docker.com/r/oznu/onedrive). -#### Environment-variables +### Environment-variables Set the following variables with the -e tag. @@ -15,7 +13,7 @@ Set the following variables with the -e tag. | `PUID` | UserID | | | `PGID` | GroupID | | -#### Volumes +### Volumes Set the following volumes with the -v tag. @@ -24,7 +22,7 @@ Set the following volumes with the -v tag. | `onedrive_config` | `/config` | configuration storage for the server connection | | `onedrive_doc` | `/documents` | storage for downloaded documents | -#### Rebuild +### Rebuild ```shell #!/bin/sh diff --git a/wiki/openvpn.md b/wiki/openvpn.md index 32f661c..4b9c60e 100644 --- a/wiki/openvpn.md +++ b/wiki/openvpn.md @@ -1,12 +1,10 @@ # OpenVPN -## Setup Server - -### Docker +## Setup Server with Docker The official container and documentation was made by [kylemanna](https://hub.docker.com/r/kylemanna/openvpn). -#### Volumes +### Volumes Set the following volumes with the -v tag. @@ -14,7 +12,7 @@ Set the following volumes with the -v tag. | ----------- | --------------- | ------------------------ | | `ovpn` | `/etc/openvpn` | storage for openvpn data | -#### Ports +### Ports Set the following ports with the -p tag. @@ -22,7 +20,7 @@ Set the following ports with the -p tag. | -------------- | ------------------------ | -------- | ------------ | | `1194` | `1194` | UDP | openvpn port | -#### Additional +### Additional There are some special variables to set. @@ -30,7 +28,7 @@ There are some special variables to set. | ----------- | ---------------------- | | `--cap-add` | add linux capabilities | -#### Rebuild +### Rebuild ```shell #!/bin/sh diff --git a/wiki/owncloud.md b/wiki/owncloud.md index b3b14e7..18718f8 100644 --- a/wiki/owncloud.md +++ b/wiki/owncloud.md @@ -1,16 +1,14 @@ # Owncloud -## Setup Server - -### Docker +## Setup Server with Docker The official container and documentation was made by [owncloud](https://hub.docker.com/_/owncloud). This docker-rebuild is made up by a `docker-compose.yml` file. The services in this files are explained seperately. +The main Docker container needs a database in form of a [MariaDB](./mariadb.md) +Docker container. -#### Owncloud - -##### Volumes +### Server: Volumes Set the following volumes in the `volumes:` section of the docker-compose file. @@ -19,7 +17,7 @@ Set the following volumes in the `volumes:` section of the docker-compose file. | `owncloud` | `/var/www/html` | storage for owncloud plugins | | `config` | `/var/www/html/config` | storage for owncloud config | -##### Ports +### Server: Ports Set the following ports in the `ports:` section. @@ -27,26 +25,7 @@ Set the following ports in the `ports:` section. | -------------- | ------------------------ | -------- | ----------- | | `80` | `80` | TCP | WebUI | -#### Maria DB - -##### Environment-variables - -Set the following environment-variables in the `environment:` section of the -docker-compose file. - -| Name | Usage | Default | -| --------------------- | ---------------------------- | ------- | -| `MYSQL_ROOT_PASSWORD` | set the mysql admin password | | - -##### Volumes - -Set the following volumes in the `volumes:` section of the docker-compose file. - -| Volume-Name | Container mount | Description | -| ----------- | ---------------- | ------------------------- | -| `mariadb` | `/var/lib/mysql` | storage for owncloud data | - -#### Rebuild +### Server: Rebuild ```shell #!/bin/sh @@ -56,7 +35,7 @@ docker pull mariadb docker-compose up -d ``` -#### Docker-Compose.yml +### Server: Docker-Compose.yml ```yml version: "3.1" @@ -88,13 +67,11 @@ volumes: driver: local ``` -## Setup Client - -### Docker +## Setup Client with Docker The original container and documentation are made by [tiynger](https://hub.docker.com/r/tiynger/owncloudclient) -#### Environment-variables +### Client: Environment-variables Set the following variables with the -e tag. @@ -104,7 +81,7 @@ Set the following variables with the -e tag. | `PASSWORD` | password of OwnCloud server | `admin` | | `URL` | url of OwnCloud server (dont forget the http(s)://) | `localhost` | -#### Additional +### Client: Additional There are some special variables to set. @@ -112,7 +89,7 @@ There are some special variables to set. | -------------------- | ---------------------------------------------------------- | | `--opt-log max-size` | prevent log file from growing to large (`50m` recommended) | -#### Volumes +### Client: Volumes Set the following volumes with the -v tag. @@ -120,7 +97,7 @@ Set the following volumes with the -v tag. | ----------- | --------------- | ----------------------------------- | | `data` | `/data` | directory for the owncloud contents | -#### Rebuild +### Client: Rebuild ```shell #!/bin/sh diff --git a/wiki/pinedocs.md b/wiki/pinedocs.md index 7b4ffb0..b16fa63 100644 --- a/wiki/pinedocs.md +++ b/wiki/pinedocs.md @@ -1,12 +1,10 @@ # Pinedocs -## Setup Server - -### Docker +## Setup with Docker The official container and documentation was made by [xy2z](https://hub.docker.com/r/xy2z/pinedocs). -#### Volumes +### Volumes Set the following volumes with the -v tag. @@ -14,7 +12,7 @@ Set the following volumes with the -v tag. | ----------- | --------------- | -------------------- | | `pinedocs` | `/data` | storage for pinedocs | -#### Ports +### Ports Set the following ports with the -p tag. @@ -22,7 +20,7 @@ Set the following ports with the -p tag. | -------------- | ------------------------ | -------- | ----------- | | `80` | `80` | TCP | WebUI | -#### Rebuild +### Rebuild ```shell #!/bin/sh diff --git a/wiki/plex.md b/wiki/plex.md index 3d7e1cd..2464577 100644 --- a/wiki/plex.md +++ b/wiki/plex.md @@ -1,12 +1,10 @@ # Plex -## Setup Tunnel - -### Docker +## Setup Tunnel with Docker The official container and documentation was made by [nasourso](https://hub.docker.com/r/nasourso/pltu). -#### Volumes +### Volumes Set the following volumes with the -v tag. @@ -14,7 +12,7 @@ Set the following volumes with the -v tag. | ----------- | --------------- | --------------------------------------------------- | | `pltu` | `/cert` | storage for openvpn certificate of server with plex | -#### Ports +### Ports Set the following ports with the -p tag. @@ -22,7 +20,7 @@ Set the following ports with the -p tag. | -------------- | ------------------------ | -------- | ----------- | | `80` | `32400` | TCP | Plex webUI | -#### Additional +### Additional There are some special variables to set. @@ -30,7 +28,7 @@ There are some special variables to set. | -------------- | ------------------------ | | `--privileged` | is needed due to openvpn | -#### Rebuild +### Rebuild ```shell #!/bin/sh diff --git a/wiki/portainer.md b/wiki/portainer.md index b9b0cbc..6ae7b54 100644 --- a/wiki/portainer.md +++ b/wiki/portainer.md @@ -1,12 +1,10 @@ # Portainer -## Setup Server - -### Docker +## Setup Server with Docker The official container and documentation was made by [portainer](https://hub.docker.com/r/portainer/portainer). -#### Volumes +### Server: Volumes Set the following volumes with the -v tag. @@ -15,7 +13,7 @@ Set the following volumes with the -v tag. | `portainer` | `/data` | configuration directory | | `/var/run/docker.sock` | `/var/run/docker.sock` | connection to local docker containers and volumes | -#### Ports +### Server: Ports Set the following ports with the -p tag. @@ -23,7 +21,7 @@ Set the following ports with the -p tag. | -------------- | ------------------------ | -------- | ----------- | | `9000` | `9000` | TCP | WebUI | -#### Rebuild +### Server: Rebuild ```shell #!/bin/sh @@ -38,13 +36,11 @@ docker run --name portainer \ -d portainer/portainer ``` -## Setup Agent - -### Docker +## Setup Agent with Docker The official container and documentation was made by [portainer](https://hub.docker.com/r/portainer/agent). -#### Volumes +### Agent: Volumes Set the following volumes with the -v tag. @@ -53,7 +49,7 @@ Set the following volumes with the -v tag. | `/var/run/docker.sock` | `/var/run/docker.sock` | connect your running docker containers | | `/var/lib/docker/volumes` | `/var/lib/docker/volumes` | connect running docker volumes | -#### Ports +### Agent: Ports Set the following ports with the -p tag. @@ -61,7 +57,7 @@ Set the following ports with the -p tag. | -------------- | ------------------------ | -------- | -------------------- | | `9001` | `9001` | TCP | Portainer agent port | -#### Rebuild +### Agent: Rebuild ```shell #!/bin/sh diff --git a/wiki/prologic-todo.md b/wiki/prologic-todo.md index 2dcbb6e..6456d57 100644 --- a/wiki/prologic-todo.md +++ b/wiki/prologic-todo.md @@ -1,12 +1,10 @@ # Todo-List -## Setup Server - -### Docker +## Setup with Docker The official container and documentation was made by [prologic](https://hub.docker.com/r/prologic/todo). -#### Volumes +### Volumes Set the following volumes with the -v tag. @@ -14,7 +12,7 @@ Set the following volumes with the -v tag. | ----------- | ---------------------- | ---------------------- | | `todo` | `/go/src/todo/todo.db` | Database for todo list | -#### Ports +### Ports Set the following ports with the -p tag. @@ -22,7 +20,7 @@ Set the following ports with the -p tag. | -------------- | ------------------------ | -------- | ----------- | | `8000` | `8000` | TCP | WebUI | -#### Rebuild +### Rebuild ```shell #!/bin/sh diff --git a/wiki/radicale.md b/wiki/radicale.md index 1373c4a..507f8fd 100644 --- a/wiki/radicale.md +++ b/wiki/radicale.md @@ -1,15 +1,13 @@ # Radicale -## Setup Server - -### Docker +## Setup with Docker The official container and documentation was made by [tomsquest](https://hub.docker.com/r/tomsquest/docker-radicale). The `latest` tag at the moment of writing this readme was corrupted. The last usable tag was used therefore to guarantee best performance for all users. -#### Volumes +### Volumes Set the following volumes with the -v tag. @@ -18,7 +16,7 @@ Set the following volumes with the -v tag. | `radicale_data` | `/data` | storage for caldav | | `radicale_config` | `/config` | storage for radicale config | -#### Ports +### Ports Set the following ports with the -p tag. @@ -26,7 +24,7 @@ Set the following ports with the -p tag. | -------------- | ------------------------ | -------- | ------------- | | `5232` | `5232` | TCP | WebUI, caldav | -#### Additional +### Additional There are some special variables to set. @@ -34,7 +32,7 @@ There are some special variables to set. | ------------- | ---------------------------------------------------------------------- | | `--read-only` | make radicale read-only, caldav can still be changed and used normally | -#### Rebuild +### Rebuild ```shell #/bin/sh @@ -50,7 +48,7 @@ docker run --name radicale \ -d tomsquest/docker-radicale:2.1.11.4 ``` -#### Configuration +## Configuration After installation there are a few crucial steps to take to secure your calendars with a login. diff --git a/wiki/samba.md b/wiki/samba.md index cc5a520..f91c2de 100644 --- a/wiki/samba.md +++ b/wiki/samba.md @@ -1,12 +1,10 @@ # Samba -## Setup Server - -### Docker +## Setup Server with Docker The official container and documentation was made by [dperson](https://hub.docker.com/r/samba). -#### Volumes +### Volumes Set the following volumes with the -v tag. @@ -19,7 +17,7 @@ Set the following volumes with the -v tag. | `samba_etc` | `/etc` | etc directory of samba server | | `samba_log` | `/var/log/samba` | storage for samba logs | -#### Ports +### Ports Set the following ports with the -p tag. @@ -28,7 +26,7 @@ Set the following ports with the -p tag. | `139` | `139` | TCP | Samba internal | | `445` | `445` | TCP | Samba internal | -#### Additional +### Additional There are some special variables to set. @@ -38,7 +36,7 @@ There are some special variables to set. | `-w \` | define workgroup | | `-s \(;browse;readonly;guest;users;admins;writelist;comment)` | define shares | -#### Rebuild +### Rebuild ```shell #!/bin/sh diff --git a/wiki/searx.md b/wiki/searx.md index d8022ae..59595c1 100644 --- a/wiki/searx.md +++ b/wiki/searx.md @@ -2,13 +2,11 @@ [Searx](https://searx.me) is a free metasearch engine. -## Setup - -### Docker +## Setup with Docker The official container and documentation was made by [searx](https://hub.docker.com/r/searx/searx). -#### Volumes +### Volumes Set the following volumes with the -v tag. @@ -17,7 +15,7 @@ Set the following volumes with the -v tag. | `searx_etc` | `/etc/searx` | storage for etc | | `searx_log` | `/var/log/uwsgi` | storage for logs | -#### Ports +### Ports Set the following ports with the -p tag. @@ -25,7 +23,7 @@ Set the following ports with the -p tag. | -------------- | ------------------------ | -------- | ----------- | | `8080` | `8080` | TCP | WebUI | -#### Rebuild +### Rebuild ```shell #!/bin/sh diff --git a/wiki/syncthing.md b/wiki/syncthing.md index 21d7d09..128440e 100644 --- a/wiki/syncthing.md +++ b/wiki/syncthing.md @@ -1,12 +1,10 @@ # Syncthing -## Setup - -### Docker +## Setup with Docker The official container and documentation was made by [linuxserver](https://hub.docker.com/r/linuxserver/syncthing). -#### Environment-variables +### Environment-variables Set the following variables with the -e tag. @@ -17,7 +15,7 @@ Set the following variables with the -e tag. | `TZ` | Timezone | | | `UMASK_SET` | setting usermask | | -#### Volumes +### Volumes Set the following volumes with the -v tag. @@ -25,7 +23,7 @@ Set the following volumes with the -v tag. | ------------------ | --------------- | ----------------------------------------------- | | `syncthing_config` | `/config` | storage for config and possible downloaded data | -#### Ports +### Ports Set the following ports with the -p tag. @@ -35,7 +33,7 @@ Set the following ports with the -p tag. | `22000` | `22000` | TCP | Syncthing internal | | `21027` | `21027` | UDP | Syncthing internal | -#### Rebuild +### Rebuild ```shell #!/bin/sh diff --git a/wiki/teamspeak.md b/wiki/teamspeak.md index f695869..0549a6a 100644 --- a/wiki/teamspeak.md +++ b/wiki/teamspeak.md @@ -1,12 +1,10 @@ # Teamspeak3 -## Setup Server - -### Docker +## Setup Server with Docker The official container and documentation was made by [teamspeak](https://hub.docker.com/_/teamspeak). -#### Environment-variables +### Environment-variables Set the following variables with the -e tag. @@ -14,7 +12,7 @@ Set the following variables with the -e tag. | ------------------- | ---------------------------- | ------- | | `TS3SERVER_LICENSE` | accept the license agreement | | -#### Volumes +### Volumes Set the following volumes with the -v tag. @@ -22,7 +20,7 @@ Set the following volumes with the -v tag. | ------------ | ---------------- | --------------------------- | | `teamspeak3` | `/var/ts3server` | storage for ts3-server data | -#### Ports +### Ports Set the following ports with the -p tag. @@ -32,7 +30,7 @@ Set the following ports with the -p tag. | `10011` | `10011` | TCP | ts3-intern | | `30033` | `30033` | TCP | ts3-intern | -#### Rebuild +### Rebuild ```shell #!/bin/sh diff --git a/wiki/yourls.md b/wiki/yourls.md index 1af3014..504045f 100644 --- a/wiki/yourls.md +++ b/wiki/yourls.md @@ -1,14 +1,12 @@ # YOURLS -## Setup Server - -### Docker +## Setup with Docker The official container and documentation was made by [yourls](https://hub.docker.com/_/yourls). +In addition to the main container you need to connect a [mySQL container](./mysql.md) +to it. -#### YOURLS - -##### Environment-variables +### Environment-variables Set the following variables with the -e tag. @@ -19,7 +17,7 @@ Set the following variables with the -e tag. | `YOURLS_USER` | username for yourls admin | | | `YOURLS_PASS` | password for yourls admin | | -##### Volumes +### Volumes Set the following volumes with the -v tag. @@ -27,7 +25,7 @@ Set the following volumes with the -v tag. | ----------- | --------------- | -------------------- | | `yourls` | `/var/www/html` | yourls specific html | -##### Ports +### Ports Set the following ports with the -p tag. @@ -35,25 +33,7 @@ Set the following ports with the -p tag. | -------------- | ------------------------ | -------- | ----------------- | | `80` | `80` | TCP | dns protocol port | -#### MySQL - -##### Environment-variables - -Set the following variables with the -e tag. - -| Name | Usage | Default | -| --------------------- | ----------------- | ------- | -| `MYSQL_ROOT_PASSWORD` | database password | | - -##### Volumes - -Set the following volumes with the -v tag. - -| Volume-Name | Container mount | Description | -| ----------- | ----------------- | ------------------- | -| `mysql` | `/var/cache/bind` | database for yourls | - -#### Rebuild +### Rebuild ```shell #!/bin/sh @@ -61,7 +41,7 @@ docker-compose down docker-compose up -d ``` -#### Docker-Compose.yml +### Docker-Compose.yml ```yml version: "3.1"