diff --git a/README.md b/README.md index d398eb1..e7f1926 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,3 @@ # Wiki -This is a repository for guides and tips for using various software, operating system and tech related stuff. - -| File/Folder | Description | -| --------------- | ---------------------------------------------------------------- | -| arch-linux | guides on setup and recommended software for arch linux | -| docker | various setup and rebuild scripts and guides for used containers | +This is a wiki for guides and tips for using various software, operating system and tech related stuff. diff --git a/applications/airsonic.md b/applications/airsonic.md new file mode 100644 index 0000000..19644c6 --- /dev/null +++ b/applications/airsonic.md @@ -0,0 +1,60 @@ +# Airsonic + +## Setup Server + +### Docker + +The official container and documentation was made by [linuxserver](https://hub.docker.com/r/linuxserver/airsonic). + +#### Environment-variables + +Set the following variables with the -e tag. + +| Name | Usage | Default | +| ---- | -------- | ------- | +| PUID | UserID | | +| PGID | GroupID | | +| TZ | Timezone | | + +#### Volumes + +Set the following volumes with the -v tag. + +| Volume-Name | Container mount | Description | +| ---------------- | --------------- | ----------------------- | +| airsonic\_config | /config | Configuration files | +| airsonic\_media | /media | Various other media | +| media\_playlists | /playlists | Location for playlists | +| media\_music | /music | Location for music | +| media\_audiobooks | /audiobooks | Location for audiobooks | +| media\_podcasts | /podcasts | location for podcasts | + +#### Ports + +Set the following ports with the -p tag. + +| Container Port | Recommended outside port | Protocol | Description | +| -------------- | ------------------------ | -------- | ----------- | +| 4040 | 4040 | TCP | WebUI | + +#### Rebuild + +``` +#!/bin/sh +docker stop airsonic +docker rm airsonic +docker pull linuxserver/airsonic +docker run --name=airsonic \ + --restart unless-stopped \ + -p 4040:4040 \ + -v airsonic_config:/config \ + -v airsonic_media:/media \ + -v media_playlists:/playlists \ + -v media_music:/music \ + -v media_audiobooks:/audiobooks \ + -v media_podcasts:/podcasts \ + -e PUID=0 \ + -e PGID=0 \ + -e TZ=Europe/Berlin \ + -d linuxserver/airsonic +``` diff --git a/docker/bind/description.md b/applications/bind.md similarity index 64% rename from docker/bind/description.md rename to applications/bind.md index 5de92f5..f33f434 100644 --- a/docker/bind/description.md +++ b/applications/bind.md @@ -1,16 +1,22 @@ # Bind -This is a dockerized version of a bind server. + +## Setup Server + +### 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. | Volume-Name | Container mount | Description | | ---------------- | --------------- | ----------------------- | -| bind_cache | /var/cache/bind | cache for dns | -| bind_etc | /etc/bind | configuration for dns | +| 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. | Container Port | Recommended outside port | Protocol | Description | @@ -18,9 +24,27 @@ 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. | Flag | Usage | | ----- | ------------------------------------------------------- | | --dns | set two of these flags for specific dns forward servers | + +#### Rebuild + +``` +#!/bin/sh +docker stop bind +docker rm bind +docker pull ventz/bind:latest +docker run --name bind \ + --restart unless-stopped \ + --dns=1.1.1.1 --dns=8.8.8.8 \ + -p 53:53/udp \ + -p 53:53 \ + -v bind_cache:/var/cache/bind \ + -v bind_etc:/etc/bind \ + -d ventz/bind:latest +``` diff --git a/docker/cups/description.md b/applications/cups.md similarity index 64% rename from docker/cups/description.md rename to applications/cups.md index 0d8da8b..7ddec93 100644 --- a/docker/cups/description.md +++ b/applications/cups.md @@ -1,8 +1,13 @@ # Cups -This is a dockerized version of a cups server. + +## Setup Server + +### 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. | Volume-Name | Container mount | Description | @@ -10,12 +15,30 @@ 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. | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ------------------ | | 631 | 631 | TCP | cups server webui | -## Additional -The default username is ```print```, the default password is ```print```. +#### Additional + +The default username is `print`, the default password is `print`. + +#### Rebuild + +``` +#!/bin/sh +docker stop cups +docker rm cups +docker pull olbat/cupsd:latest +docker run --name cups \ + --restart unless-stopped \ + --net=host \ + -p 631:631 \ + -v /var/run/dbus:/var/run/dbus \ + -v cups:/etc/cups/ \ + -d olbat/cupsd:latest +``` diff --git a/docker/docker-mailserver/description.md b/applications/dovecot.md similarity index 55% rename from docker/docker-mailserver/description.md rename to applications/dovecot.md index 65be778..e1469a7 100644 --- a/docker/docker-mailserver/description.md +++ b/applications/dovecot.md @@ -1,8 +1,14 @@ -# Docker-mailserver -This is a dockerized version of a mail server. +# Dovecot + +## Setup Server + +### 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 -## Configuration The configuration is done automatically using scripts by tvial. First you need to download the essential setup files. @@ -16,14 +22,23 @@ curl -o .env https://raw.githubusercontent.com/tomav/docker-mailserver/master/.e curl -o env-mailserver https://raw.githubusercontent.com/tomav/docker-mailserver/master/env-mailserver.dist ``` -After that you need to edit the ```.env``` and the ```env-mailserver``` files to configure the mailserver. +After that you need to edit the `.env` and the `env-mailserver` files to configure the mailserver. -You then need to start the container with the ```rebuild.sh``` and add email accounts using the following command. +You then need to start the container with the `rebuild.sh` and add email accounts using the following command. -```./setup.sh email add ()``` +`./setup.sh email add ()` And finally generate the DCIM keys and rebuild once again. -```./setup.sh config dkim``` +`./setup.sh config dkim` -Afterwards you're ready to go by once again running the ```rebuild.sh``` file. +Afterwards you're ready to go by once again running the `rebuild.sh` file. + +#### Rebuild + +``` +#!/bin/sh +docker-compose down +docker pull tvial/docker-mailserver:latest +docker-compose up -d +``` diff --git a/docker/python-flask/description.md b/applications/flask.md similarity index 64% rename from docker/python-flask/description.md rename to applications/flask.md index fc22201..d5e1906 100644 --- a/docker/python-flask/description.md +++ b/applications/flask.md @@ -1,17 +1,35 @@ -# DockerPythonFlask -This is a dockerized version of a Python3 Flask Server. +# Flask + +## Setup Server + +### 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. | Volume-Name | Container mount | Description | | ----------- | --------------- | ------------------------------- | | app | /flask | directory for flask application | -## Ports +#### Ports Set the following volumes with the -p tag. | Container-Port | Recommed outside port | Protocol | Description | | -------------- | --------------------- | -------- | ----------- | | 5000 | 80 | TCP | HTTP port | + +#### Rebuild + +``` +#!/bin/sh +docker stop python-flask +docker rm python-flask +docker pull tiynger/pythonflask:latest +docker run --name python-flask \ + --restart unless-stopped \ + -p "5000:5000" \ + -v python-flask:/flask \ + -d tiynger/pythonflask:latest +``` diff --git a/docker/foldingathome/description.md b/applications/foldingathome.md similarity index 57% rename from docker/foldingathome/description.md rename to applications/foldingathome.md index c1f0653..5b5a9ab 100644 --- a/docker/foldingathome/description.md +++ b/applications/foldingathome.md @@ -1,15 +1,19 @@ # Folding-at-home -This is a dockerized version of a folding-at-home server. + +## Setup + +### 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. | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | 7396 | 7396 | TCP | WebUI | -## Additional +#### Additional There are some special variables to set. | Flag | Usage | @@ -18,6 +22,23 @@ There are some special variables to set. | --power | set the default power to fold at home | | --team | set your teamid to contribute points | -### 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 +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`. + +#### Rebuild + +``` +#!/bin/sh +docker stop folding-at-home +docker rm folding-at-home +docker pull johnktims/folding-at-home +docker run --name folding-at-home \ + --restart unless-stopped \ + -it \ + -p 7396:7396 \ + -d johnktims/folding-at-home \ + --user=default \ + --power=full \ + --team=000000 +``` diff --git a/applications/git.md b/applications/git.md new file mode 100644 index 0000000..6fccae1 --- /dev/null +++ b/applications/git.md @@ -0,0 +1,178 @@ +# Git + +## Setup Server + +### Docker + +#### Bare (No webinterface) + +The official container and documentation was made by [jkarlos](https://hub.docker.com/r/jkarlos/git-server-docker). + +##### Volumes +Set the following volumes with the -v tag. + +| Volume-Name | Container mount | Description | +| ---------------- | ----------------- | --------------------------- | +| git-server-repos | /git-server/repos | storage for git repos | +| git-server-keys | /git-server/keys | storage for user ssh keys | + +##### Ports +Set the following ports with the -p tag. + +| Container Port | Recommended outside port | Protocol | Description | +| -------------- | ------------------------ | -------- | ------------------------------------- | +| 22 | 2222 | TCP | ssh port for accessing the git server | + +##### Rebuild + +``` +#!/bin/sh +docker stop git-server +docker rm git-server +docker pull jkarlos/git-server-docker:latest +docker run --name git-server \ + --restart unless-stopped \ + -p 2222:22 \ + -v git-server_repos:/git-server/repos \ + -v git-server_keys:/git-server/keys \ + -d jkarlos/git-server-docker +``` + +#### Gitea (Webinterface) + +The official container and documentation was made by [gitea](https://hub.docker.com/gitea/gitea). +This docker-rebuild is made up by a `docker-compose.yml` file. +The services in this files are explained seperately. + +##### Gitea + +###### Environment-variables +Set the following environment-variables in the `environment:` section of the docker-compose file. + +| Name | Usage | Default | +| ------------------- | ------------------------------ | ------- | +| USER\_UID | User userid to run gitea | | +| USER\_GID | User groupid to run gitea | | +| DB\_TYPE | Specify database type | | +| DB\_HOST | Specify database host and port | | +| DB\_NAME | Specify Name of the database | | +| DB\_USER | Username for the database | | +| DB\_PASSWD | Password for the database | | + + +###### Volumes +Set the following volumes in the `volumes:` section of the docker-compose file. + +| Volume-Name | Container mount | Description | +| ---------------- | ---------------------- | ------------------------------ | +| data | /data | storage for data of git server | +| /etc/timezone | /etc/timezone:ro | link timezone | +| /etc/localtime | /etc/localtime | link localtime | + +###### Ports +Set the following ports in the `ports:` section. + +| Container Port | Recommended outside port | Protocol | Description | +| -------------- | ------------------------ | -------- | ---------------------- | +| 3000 | 3000 | TCP | WebUI | +| 22 | 222 | TCP | ssh port of git server | + +###### Networks +Set the following networks in the `networks:` section of the docker-compose file. + +| Name | Usage | +| ----- | --------------------- | +| gitea | connect db with gitea | + +###### Dependencies +Set the following dependencies in the `depends_on:` section of the docker-compose file. + +| Name | Usage | +| ----- | --------------------- | +| 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 + +``` +#!/bin/sh +docker-compose down +docker-compose up -d +``` + +##### Docker-Compose.yml + +``` +version: "2" + +networks: + gitea: + external: false + +services: + server: + image: gitea/gitea:latest + environment: + - USER_UID=1000 + - USER_GID=1000 + - DB_TYPE=mysql + - DB_HOST=db:3306 + - DB_NAME=gitea + - DB_USER=gitea + - DB_PASSWD=gitea + restart: unless-stopped + networks: + - gitea + volumes: + - data:/data + - /etc/timezone:/etc/timezone:ro + - /etc/localtime:/etc/localtime:ro + ports: + - "3000:3000" + - "222:22" + depends_on: + - db + db: + image: mysql:5.7 + restart: unless-stopped + environment: + - MYSQL_ROOT_PASSWORD=gitea + - MYSQL_USER=gitea + - MYSQL_PASSWORD=gitea + - MYSQL_DATABASE=gitea + networks: + - gitea + volumes: + - mysql:/var/lib/mysql + +volumes: + data: + driver: local + mysql: + driver: local +``` diff --git a/applications/gopher.md b/applications/gopher.md new file mode 100644 index 0000000..568b335 --- /dev/null +++ b/applications/gopher.md @@ -0,0 +1,77 @@ +# Gopherproxy + +## Setup Proxy + +### Docker + +The official container and documentation was made by [prologic](https://hub.docker.com/r/prologic/gopherproxy). + +#### Ports +Set the following ports with the -p tag. + +| Container Port | Recommended outside port | Protocol | Description | +| -------------- | ------------------------ | -------- | ---------------------------------------- | +| 8000 | 8000 | TCP | port to proxy the gopher site as http to | + +#### Additional +There are some special variables to set. + +| Flag | Usage | +| ---- | ------------------------------------------------------------- | +| -uri | define the gopher site to proxy (just 'domain.tld' is enough) | + +#### Rebuild + +``` +#!/bin/sh +docker stop gopheroverhttp +docker rm gopheroverhttp +docker pull prologic/gopherproxy +docker run --name gopheroverhttp \ + --restart unless-stopped \ + -p 8000:8000 \ + -d prologic/gopherproxy \ + -uri 'domain.tld' +``` + +## Setup Server + +### Docker + +The official container and documentation was made by [tiynger](https://hub.docker.com/r/tiynger/gopherserver). + +#### Environment-variables +Set the following variables with the -e tag. + +| Name | Usage | Default | +| ------------- | --------------------------------------------------- | --------- | +| SERVER\_NAME | set this to your IP/Domain (no "gopher://" needed!) | localhost | + +#### Volumes +Set the following volumes with the -v tag. + +| Volume-Name | Container mount | Description | +| -------------------- | --------------- | ----------------------------- | +| gopherwebdir | /var/gopher | directory for the gopher page | + +#### Ports +Set the following ports with the -p tag. + +| Container port | Recommended outside port | Protocol | Description | +| -------------- | ------------------------ | ---------- | ---------------------------- | +| 70 | 70 | TCP | port for the gopher-protocol | + +#### Rebuild + +``` +#!/bin/sh +docker stop gopherserver +docker rm gopherserver +docker pull tiynger/gopherserver +docker run --name gopherserver \ + --restart unless-stopped \ + -p 70:70 \ + -v gopherserver:/var/gopher \ + -e SERVER_NAME='domain.tld' \ + -d tiynger/gopherserver +``` diff --git a/docker/hastebin/description.md b/applications/hastebin.md similarity index 70% rename from docker/hastebin/description.md rename to applications/hastebin.md index 395a05f..7508949 100644 --- a/docker/hastebin/description.md +++ b/applications/hastebin.md @@ -1,24 +1,43 @@ # Hastebin -This is a dockerized version of a hastebin server. + +## Setup Server + +### 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. | Name | Usage | Default | | ------------ | ----------------------- | ------- | | STORAGE_TYPE | Type to store the datas | file | -## Volumes +#### Volumes Set the following volumes with the -v tag. | Volume-Name | Container mount | Description | | ---------------- | --------------- | -------------------------- | | hastebin | /app/data | storage directory for data | -## Ports +#### Ports Set the following ports with the -p tag. | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | 7777 | 7777 | TCP | WebUI | + +#### Rebuild + +``` +#!/bin/sh +docker stop hastebin +docker rm hastebin +docker pull rlister/hastebin:latest +docker run --name hastebin \ + --restart unless-stopped \ + -p 7777:7777 \ + -v hastebin:/app/data \ + -e STORAGE_TYPE=file \ + -d rlister/hastebin:latest +``` diff --git a/applications/homer.md b/applications/homer.md new file mode 100644 index 0000000..64b4827 --- /dev/null +++ b/applications/homer.md @@ -0,0 +1,70 @@ +# Homer + +## Setup Server + +### Docker + +The official container and documentation was made by [b4bz](https://hub.docker.com/r/b4bz/homer). + +#### Volumes +Set the following volumes with the -v tag. + +| Volume-Name | Container mount | Description | +| ------------------------ | --------------- | ---------------------------------- | +| /current/dir/config.yml | /www/config.yml | configuration file for static page | +| homer | /www/assets | storage for icons, etc | + +#### Ports +Set the following ports with the -p tag. + +| Container Port | Recommended outside port | Protocol | Description | +| -------------- | ------------------------ | -------- | ----------- | +| 8080 | 8080 | TCP | WebUI | + +#### Rebuild + +``` +#!/bin/sh +docker stop homer +docker rm homer +docker pull b4bz/homer:latest +docker run --name homer \ + --restart unless-stopped \ + -p 8080:8080 \ + -v /root/docker/homer/config.yml:/www/config.yml \ + -v homer:/www/assets \ + -d b4bz/homer:latest +``` + +#### Configuration + +This is a sample config.yml: + +``` +title: "tmp" +subtitle: "tmp" +logo: "tmp" +footer: "" + +message: + style: "" + title: "tmp" + content: "tmp" + +links: + - name: "tmp" + icon: "tmp" + url: "tmp" + target: '_blank' + +services: + - name: "tmp" + icon: "tmp" + items: + - name: "tmp" + logo: "tmp" + subtitle: "tmp" + tag: "tmp" + url: "tmp" + target: '_blank' +``` diff --git a/applications/jellyfin.md b/applications/jellyfin.md new file mode 100644 index 0000000..161324c --- /dev/null +++ b/applications/jellyfin.md @@ -0,0 +1,79 @@ +# Jellyfin + +## Setup Server + +### 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 +Set the following environment-variables in the `environment:` section of the docker-compose file. + +| Name | Usage | Default | +| ------------------- | ---------------------------- | ------- | +| PUID | Userid to run the container | | +| PGID | Groupid to run the container | | +| TZ | specify the timezone | | + +#### Volumes +Set the following volumes in the `volumes:` section of the docker-compose file. + +| Volume-Name | Container mount | Description | +| ---------------- | ---------------------- | ------------------------------------ | +| config | /config | storage for config files of jellyfin | +| media\_movies | /data/movies | storage for movies | +| media\_tvshows | /data/tvshows | storage for tvshows | +| transcode | /transcode | tmp storage to transcode | + +Because it is useful to have the possibility to use the `media_movies` and `media_tvshows` in multiple containers, +it is recommended to use them as external volumes (volumes section: `external: true` instead of `driver: local`). +To use the rebuild the volumes have to exist before creating the container (`docker volume create media_movies` and tvshows accordingly). + +#### Ports +Set the following ports in the `ports:` section. + +| Container Port | Recommended outside port | Protocol | Description | +| -------------- | ------------------------ | -------- | ----------- | +| 8096 | 8096 | TCP | WebUI | + +#### Rebuild + +``` +#!/bin/sh +docker-compose down +docker pull linuxserver/jellyfin:latest +docker-compose up -d +``` + +#### Docker-Compose.yml + +``` +version: "2" +services: + jellyfin: + image: linuxserver/jellyfin + container_name: jellyfin + environment: + - PUID=1000 + - PGID=1000 + - TZ=Europe/Berlin + volumes: + - config:/config + - media_movies:/data/movies + - media_tvshows:/data/tvshows + - transcode:/transcode + ports: + - 8096:8096 + restart: unless-stopped + +volumes: + config: + driver: local + transcode: + driver: local + media_movies: + external: true + media_tvshows: + external: true +``` diff --git a/arch-linux/applications/calendar.md b/applications/khal.md similarity index 95% rename from arch-linux/applications/calendar.md rename to applications/khal.md index 696a340..419e9b8 100644 --- a/arch-linux/applications/calendar.md +++ b/applications/khal.md @@ -1,12 +1,16 @@ -# Calendar +# Khal `khal` is a calendar you can use in your terminal. To sync calendars you'll need `vdirsyncer` aswell. -## Installation and configuration +## Setup + +### Arch-Linux - `pacman -S khal vdirsyncer` - Install needed packages +### Configuration + - To configure vdirsyncer edit a file in `~/.config/vdirsyncer/config`. ``` diff --git a/arch-linux/applications/contacts.md b/applications/khard.md similarity index 90% rename from arch-linux/applications/contacts.md rename to applications/khard.md index c72c305..ae2ba44 100644 --- a/arch-linux/applications/contacts.md +++ b/applications/khard.md @@ -1,11 +1,16 @@ -# Contacts +# Khard `khard` is a adressbook that runs in your terminal. To sync the data using CardDAV you'll need `vdirsyncer` aswell. -## Installation and configuration +## Setup + +### Arch Linux - `pacman -S khard vdirsyncer` - Install needed programs + +### Configuration + - Edit the `~/.config/vdirsyncer/config`. - Insert the following lines: ``` @@ -37,7 +42,7 @@ To sync the data using CardDAV you'll need `vdirsyncer` aswell. - `cp /usr/share/doc/khard/khard.conf.example ~/.config/khard/khard.conf` - Copy the example configuration - Adjust `khard.conf` to your needs -## Mutt +#### Mutt It is possible to use your khard-addressbook in mutt. -To see how it works check out the [Mutt](/#arch/mail.md). +To see how it works check out the [Mutt](/#application/neomutt.md). diff --git a/docker/mordhau-server/description.md b/applications/mordhau.md similarity index 51% rename from docker/mordhau-server/description.md rename to applications/mordhau.md index 2f9018a..5752f8d 100644 --- a/docker/mordhau-server/description.md +++ b/applications/mordhau.md @@ -1,35 +1,39 @@ -# Mordhau-server -This is a dockerized version of a mordhau server. +# Mordhau + +## Setup Server + +### 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. | Name | Usage | Default | | ---- | ---------------------------------------------------- | ------- | | QUERYPORT | port for query mordhau | | -| GAME_PORT | port for mordhau game | | +| GAME\_PORT | port for mordhau game | | | BEACONPORT | port for mordhau beacon | | -| STEAM_CONNECT | set to tell if you want to connect to steam | | +| STEAM\_CONNECT | set to tell if you want to connect to steam | | | STEAMID64 | set the serve owner steamid | | | UID | users userid to run | | | GID | users groupid to run | | -| GAME_MODE | specify mordhau game mode | | -| PLAYER_COUNT | set a playercount limit | | -| SERVER_NAME | set a servername | | -| SERVER_PASSWORD | set a password | | -| ADMIN_PASSWORD | set an admin password | | +| GAME\_MODE | specify mordhau game mode | | +| PLAYER\_COUNT | set a playercount limit | | +| SERVER\_NAME | set a servername | | +| SERVER\_PASSWORD | set a password | | +| ADMIN\_PASSWORD | set an admin password | | -## Volumes +#### Volumes Set the following volumes with the -v tag. | Volume-Name | Container mount | Description | | ---------------- | -------------------- | ---------------------------------------- | | mordhau | /serverdata/mordhau | storage for mordhau server relevant data | -| mordhau_steamcmd | /serverdata/steamcmd | storage for steam related 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 | | -------------- | ------------------------ | -------- | ----------------- | @@ -37,3 +41,39 @@ Set the following ports with the -p tag. | 15000 | 15000 | UDP | mordhau internal | | 27015 | 27015 | UDP | mordhau internal | +#### Start + +``` +#!/bin/sh + +docker pull tetricz/mordhau-server +docker run --name=mordhau \ + --restart=unless-stopped \ + -p 27015:27015/udp \ + -p 7777:7777/udp \ + -p 15000:15000/udp \ + -v mordhau:/serverdata/mordhau \ + -v mordhau_steamcmd:/serverdata/steamcmd \ + -e QUERYPORT=27015 \ + -e GAME_PORT=7777 \ + -e BEACONPORT=15000 \ + -e STEAM_CONNECT=True \ + -e STEAMID64="tmp" \ + -e UID=99 \ + -e GID=100 \ + -e GAME_MODE=SKM \ + -e PLAYER_COUNT="16" \ + -e SERVER_NAME="tmp" \ + -e SERVER_PASSWORD="tmp" \ + -e ADMIN_PASSWORD="tmp" \ + tetricz/mordhau-server +``` + +#### Stop + +``` +#/bin/sh + +docker stop mordhau +docker rm mordhau +``` diff --git a/arch-linux/applications/mail.md b/applications/neomutt.md similarity index 92% rename from arch-linux/applications/mail.md rename to applications/neomutt.md index 77d3689..112cb04 100644 --- a/arch-linux/applications/mail.md +++ b/applications/neomutt.md @@ -1,14 +1,16 @@ -# Mutt +# NeoMutt Neomutt is a mail program that runs in your terminal. It can be easily configured using mutt-wizard. -## Installation +## Setup + +### Arch-Linux - `yay -S neomutt isync msmtp pass` - Install all dependecies - Install mutt-wizard from [github](https://github.com/LukeSmithxyz/mutt-wizard) (AUR is not up to date) -## Using mutt-wizard +#### Using mutt-wizard After installation you're able to use the following commands, that will guide you through configuration. @@ -24,7 +26,9 @@ After installation you're able to use the following commands, that will guide yo `mw cron` toggle a cronjob to sync mail -## Use khard in mutt +## Usage + +## Khard in NeoMutt - Edit `~/.config/mutt/muttrc` - Append the following lines. diff --git a/docker/nginx/description.md b/applications/nginx.md similarity index 82% rename from docker/nginx/description.md rename to applications/nginx.md index 3a0124b..7bfa0ec 100644 --- a/docker/nginx/description.md +++ b/applications/nginx.md @@ -1,5 +1,9 @@ # Nginx +## Setup Server + +### Docker + The easiest way to configure and run nginx is [ncdt](https://github.com/nasourso/nginx-certbot-docker-tui) by nasourso. So the first step is downloading it. @@ -9,11 +13,19 @@ 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. Especially if you set up a authentication over nginx the open port will avoid the authentication. This can be changed at the forwarded docker-service by replacing for example `-p 7000:7000` with `-p 172.17.0.1:7000:7000`. This forces the docker container to only expose the port in the docker bridge network, effectively banning remote access. +#### Rebuild +``` +#!/bin/sh +docker-compose down +docker pull nginx:latest +docker pull certbot/certbot:latest +docker-compose up -d +``` diff --git a/applications/onedrive.md b/applications/onedrive.md new file mode 100644 index 0000000..e1646f0 --- /dev/null +++ b/applications/onedrive.md @@ -0,0 +1,39 @@ +# Onedrive + +## Setup Mirror + +### Docker + +The official container and documentation was made by [oznu](https://hub.docker.com/r/oznu/onedrive). + +#### Environment-variables +Set the following variables with the -e tag. + +| Name | Usage | Default | +| ---- | -------- | ------- | +| PUID | UserID | | +| PGID | GroupID | | + +#### Volumes +Set the following volumes with the -v tag. + +| Volume-Name | Container mount | Description | +| ---------------- | --------------- | ----------------------------------------------- | +| onedrive\_config | /config | configuration storage for the server connection | +| onedrive\_doc | /documents | storage for downloaded documents | + +#### Rebuild + +``` +#!/bin/sh +docker stop onedrive +docker rm onedrive +docker pull oznu/onedrive:latest +docker run --name onedrive \ + --restart unless-stopped \ + -v onedrive_config:/config \ + -v onedrive_doc:/documents \ + -e PUID=$(id -u) \ + -e PGID=$(id -g) \ + -d oznu/onedrive:latest +``` diff --git a/docker/openvpn/description.md b/applications/openvpn.md similarity index 71% rename from docker/openvpn/description.md rename to applications/openvpn.md index d546503..8da449c 100644 --- a/docker/openvpn/description.md +++ b/applications/openvpn.md @@ -1,24 +1,43 @@ # OpenVPN -This is a dockerized version of a OpenVPN server. + +## Setup Server + +### 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. | Volume-Name | Container mount | Description | | ---------------- | --------------- | ------------------------ | | ovpn | /etc/openvpn | storage for openvpn data | -## Ports +#### Ports Set the following ports with the -p tag. | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ------------ | | 1194 | 1194 | UDP | openvpn port | -## Additional +#### Additional There are some special variables to set. | Flag | Usage | | --------- | ---------------------- | | --cap-add | add linux capabilities | + +#### Rebuild + +``` +#!/bin/sh +docker stop openvpn +docker rm openvpn +docker pull kylemanna/openvpn +docker run --name openvpn \ + --restart unless-stopped \ + --cap-add=NET_ADMIN \ + -p 1194:1194/udp \ + -v ovpn:/etc/openvpn \ + -d kylemanna/openvpn +``` diff --git a/applications/owncloud.md b/applications/owncloud.md new file mode 100644 index 0000000..a335f29 --- /dev/null +++ b/applications/owncloud.md @@ -0,0 +1,123 @@ +# Owncloud + +## Setup Server + +### 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. + +#### Owncloud + +##### Volumes +Set the following volumes in the `volumes:` section of the docker-compose file. + +| Volume-Name | Container mount | Description | +| ---------------- | ---------------------- | ---------------------------- | +| owncloud | /var/www/html | storage for owncloud plugins | +| config | /var/www/html/config | storage for owncloud config | + +#### Ports +Set the following ports in the `ports:` section. + +| Container Port | Recommended outside port | Protocol | Description | +| -------------- | ------------------------ | -------- | ----------- | +| 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 + +``` +#!/bin/sh +docker-compose down +docker pull owncloud +docker pull mariadb +docker-compose up -d +``` + +#### Docker-Compose.yml + +``` +version: '3.1' + +services: + + owncloud: + image: owncloud + restart: unless-stopped + ports: + - 80:80 + volumes: + - owncloud:/var/www/html + - config:/var/www/html/config + + mariadb: + image: mariadb + restart: unless-stopped + environment: + MYSQL_ROOT_PASSWORD: pass + volumes: + - mariadb:/var/lib/mysql + +volumes: + owncloud: + driver: local + mariadb: + driver: local + config: + driver: local +``` + +## Setup Client + +### Docker + +The original container and documentation are made by [tiynger](https://hub.docker.com/r/tiynger/owncloudclient) + +#### Environment-variables +Set the following variables with the -e tag. + +| Name | Usage | Default | +| ----------- | --------------------------------------------------- | --------- | +| USER | username of OwnCloud server | admin | +| PASSWORD | password of OwnCloud server | admin | +| URL | url of OwnCloud server (dont forget the http(s)://) | localhost | + +#### Volumes +Set the following volumes with the -v tag. + +| Volume-Name | Container mount | Description | +| ----------- | --------------- | ----------------------------------- | +| data | /data | directory for the owncloud contents | + +#### Rebuild + +``` +#!/bin/sh +docker stop owncloudcli +docker rm owncloudcli +docker pull tiynger/owncloudclient +docker run --name owncloudcli \ + --restart unless-stopped \ + -v owncloudcli:/data \ + -e USER='user' \ + -e PASSWORD='password' \ + -e URL='https://subdomain.domain.tld' \ + -d tiynger/owncloudclient +``` diff --git a/docker/pinedocs/description.md b/applications/pinedocs.md similarity index 70% rename from docker/pinedocs/description.md rename to applications/pinedocs.md index 41c7958..731b9db 100644 --- a/docker/pinedocs/description.md +++ b/applications/pinedocs.md @@ -1,18 +1,35 @@ # Pinedocs -This is a dockerized version of a pinedocs site. + +## Setup Server + +### 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. | Volume-Name | Container mount | Description | | ---------------- | --------------- | ----------------------- | | pinedocs | /data | storage for pinedocs | -## Ports +#### Ports Set the following ports with the -p tag. | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | 80 | 80 | TCP | WebUI | +#### Rebuild + +``` +#!/bin/sh +docker stop pinedocs +docker rm pinedocs +docker pull xy2z/pinedocs +docker run --name pinedocs \ + --restart unless-stopped \ + -p 80:80 \ + -v pinedocs:/data \ + -d xy2z/pinedocs +``` diff --git a/docker/pltu/description.md b/applications/plex.md similarity index 74% rename from docker/pltu/description.md rename to applications/plex.md index 9b44cf1..8909c8d 100644 --- a/docker/pltu/description.md +++ b/applications/plex.md @@ -1,24 +1,43 @@ -# PLTU -This is a dockerized version of a plex vpn tunnel. +# Plex + +## Setup Tunnel + +### 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. | Volume-Name | Container mount | Description | | ---------------- | --------------- | --------------------------------------------------- | | pltu | /cert | storage for openvpn certificate of server with plex | -## Ports +#### Ports Set the following ports with the -p tag. | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | 80 | 32400 | TCP | Plex webUI | -## Additional +#### Additional There are some special variables to set. | Flag | Usage | | ------------ | ------------------------ | | --privileged | is needed due to openvpn | + +#### Rebuild + +``` +#!/bin/sh +docker stop pltu +docker rm pltu +docker pull nasourso/pltu:latest +docker run --name pltu \ + --restart unless-stopped \ + --privileged \ + -p 32400:80 \ + -v pltu:/cert/ \ + -d nasourso/pltu:latest +``` diff --git a/applications/portainer.md b/applications/portainer.md new file mode 100644 index 0000000..a1b8025 --- /dev/null +++ b/applications/portainer.md @@ -0,0 +1,74 @@ +# Portainer + +## Setup Server + +### Docker + +The official container and documentation was made by [portainer](https://hub.docker.com/r/portainer/portainer). + +#### Volumes +Set the following volumes with the -v tag. + +| Volume-Name | Container mount | Description | +| -------------------- | -------------------- | ------------------------------------------------- | +| portainer | /data | configuration directory | +| /var/run/docker.sock | /var/run/docker.sock | connection to local docker containers and volumes | + +#### Ports +Set the following ports with the -p tag. + +| Container Port | Recommended outside port | Protocol | Description | +| -------------- | ------------------------ | -------- | ----------- | +| 9000 | 9000 | TCP | WebUI | + +#### Rebuild + +``` +#!/bin/sh +docker stop portainer +docker rm portainer +docker pull portainer/portainer:latest +docker run --name portainer \ + --restart unless-stopped \ + -p 9000:9000 \ + -v /var/run/docker.sock:/var/run/docker.sock \ + -v portainer:/data \ + -d portainer/portainer +``` + +## Setup Agent + +### Docker + +The official container and documentation was made by [portainer](https://hub.docker.com/r/portainer/agent). + +#### Volumes +Set the following volumes with the -v tag. + +| Volume-Name | Container mount | Description | +| ----------------------- | ----------------------- | -------------------------------------- | +| /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 +Set the following ports with the -p tag. + +| Container Port | Recommended outside port | Protocol | Description | +| -------------- | ------------------------ | -------- | -------------------- | +| 9001 | 9001 | TCP | Portainer agent port | + +#### Rebuild + +``` +#!/bin/sh +docker stop portainer_agent +docker rm portainer_agent +docker pull portainer/agent:latest +docker run --name portainer_agent \ + -p 9001:9001 \ + --restart unless-stopped \ + -v /var/run/docker.sock:/var/run/docker.sock \ + -v /var/lib/docker/volumes:/var/lib/docker/volumes \ + -d portainer/agent:latest +``` + diff --git a/docker/docker-radicale/config b/applications/radicale.md similarity index 52% rename from docker/docker-radicale/config rename to applications/radicale.md index 4bae1bc..aa85f06 100644 --- a/docker/docker-radicale/config +++ b/applications/radicale.md @@ -1,3 +1,57 @@ +# Radicale + +## Setup Server + +### 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 +Set the following volumes with the -v tag. + +| Volume-Name | Container mount | Description | +| ---------------- | --------------- | --------------------------- | +| radicale\_data | /data | storage for caldav | +| radicale\_config | /config | storage for radicale config | + +#### Ports +Set the following ports with the -p tag. + +| Container Port | Recommended outside port | Protocol | Description | +| -------------- | ------------------------ | -------- | ------------- | +| 5232 | 5232 | TCP | WebUI, caldav | + +#### Additional +There are some special variables to set. + +| Flag | Usage | +| ----------- | ---------------------------------------------------------------------- | +| --read-only | make radicale read-only, caldav can still be changed and used normally | + +#### Rebuild + +``` +#/bin/sh +docker stop radicale +docker rm radicale +docker pull tomsquest/docker-radicale:2.1.11.4 +docker run --name radicale \ + --restart unless-stopped \ + --read-only \ + -p 5232:5232 \ + -v radicale_data:/data \ + -v radicale_config:/config \ + -d tomsquest/docker-radicale:2.1.11.4 +``` + +#### Configuration +After installation there are a few crucial steps to take to secure your calendars with a login. +It is important to change the config file which can be found in the docker volume with name `radicale_config` to match the `config`-file. + +``` # -*- mode: conf -*- # vim:ft=cfg @@ -131,3 +185,15 @@ type = internal # Additional HTTP headers #Access-Control-Allow-Origin = * +``` + +Following this you need to make sure there is a password file in the docker volume `radicale_data` called `users`. +The password will be encrypted using `bcrypt`. +Steps to create a file with a user and password: +- You will have to install the package which includes `htpasswd`; for debian based distributions this is `apt install apache2-utils` +- `cd /var/lib/docker/volumes/radicale\_data/\_data` - go to the volume +- `touch ./users` - create a file called users +- `htpasswd -B ./users username` - add user with name and password to the file (change `username` to your desired username) + +Now you can go to the exposed port and login with your chosen username and password. +If you only added one user you shouldn't be able to login with any other data than your username and password. diff --git a/applications/samba.md b/applications/samba.md new file mode 100644 index 0000000..721664b --- /dev/null +++ b/applications/samba.md @@ -0,0 +1,61 @@ +# Samba + +## Setup Server + +### Docker + +The official container and documentation was made by [dperson](https://hub.docker.com/r/samba). + +#### Volumes +Set the following volumes with the -v tag. + +| Volume-Name | Container mount | Description | +| ---------------- | --------------- | ------------------------------ | +| samba\_nas | /nas | storage for samba data | +| samba\_lib | /var/lib/samba | storage for samba lib | +| samba\_cache | /var/cache/samba | storage for samba cache | +| samba\_run | /run/samba | run entries for samba | +| samba\_etc | /etc | etc directory of samba server | +| samba\_log | /var/log/samba | storage for samba logs | + +#### Ports +Set the following ports with the -p tag. + +| Container Port | Recommended outside port | Protocol | Description | +| -------------- | ------------------------ | -------- | -------------- | +| 139 | 139 | TCP | Samba internal | +| 445 | 445 | TCP | Samba internal | + +#### Additional +There are some special variables to set. + +| Flag | Usage | +| --------------------------------------------------------------------- | ---------------- | +| -u \(;ID;group;GID) | define user | +| -w \ | define workgroup | +| -s \(;browse;readonly;guest;users;admins;writelist;comment) | define shares | + +#### Rebuild + +``` +#!/bin/sh +docker stop samba +docker rm samba +docker pull dperson/samba +docker run --name samba \ + --restart unless-stopped \ + -p 139:139 \ + -p 445:445 \ + -v samba_nas:/nas \ + -v samba_lib:/var/lib/samba \ + -v samba_cache:/var/cache/samba \ + -v samba_run:/run/samba \ + -v samba_etc:/etc \ + -v samba_log:/var/log/samba \ + -d dperson/samba -p \ + -u "user1;pass1" \ + -u "user2;pass2" \ + -s "public;/nas/public" \ + -s "user1private;/nas/user1;no;no;no;user1;user1" \ + -s "user2private;/nas/user2;no;no;no;user2;user2" +``` diff --git a/arch-linux/applications/tablecalculation.md b/applications/sc-im.md similarity index 95% rename from arch-linux/applications/tablecalculation.md rename to applications/sc-im.md index 4a29b9b..0b69cee 100644 --- a/arch-linux/applications/tablecalculation.md +++ b/applications/sc-im.md @@ -1,8 +1,10 @@ -# Tablecalculation +# SC-IM `sc-im` is a program to view and edit tables especially in csv-format. -## Installation +## Setup + +### Arch-Linux - `yay -S sc-im` - Install sc-im - `sc-im .csv` - Edit files diff --git a/arch-linux/applications/shell.md b/applications/shells.md similarity index 90% rename from arch-linux/applications/shell.md rename to applications/shells.md index a6acab2..d7505eb 100644 --- a/arch-linux/applications/shell.md +++ b/applications/shells.md @@ -1,12 +1,14 @@ -# Shell +# Shells + +## Change /bin/sh + +### Arch-Linux The Shell in Arch-Linux is made up by a POSIX compliant mode of bash. Problem with that is the speed. A shell like dash would be much faster. This is a guide on how to persistently change the symlink /bin/sh from bash to dash. -## Setup - - `yay -S dash` - Install dash - `sudo ln -sfT /bin/dash /bin/sh` - link /bin/sh to dash - `sudo vim /usr/share/libalpm/hooks/bash-update.hook` - setup a hook to avoid bash resetting the symlink diff --git a/docker/syncthing/description.md b/applications/syncthing.md similarity index 65% rename from docker/syncthing/description.md rename to applications/syncthing.md index 47c000b..09b55e1 100644 --- a/docker/syncthing/description.md +++ b/applications/syncthing.md @@ -1,8 +1,12 @@ # Syncthing -This is a dockerized version of a syncthing server. + +## Setup + +### 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. | Name | Usage | Default | @@ -10,16 +14,16 @@ Set the following variables with the -e tag. | PUID | UserID | | | PGID | GroupID | | | TZ | Timezone | | -| UMASK_SET | setting usermask | | +| UMASK\_SET | setting usermask | | -## Volumes +#### Volumes Set the following volumes with the -v tag. | Volume-Name | Container mount | Description | | ---------------- | --------------- | ----------------------------------------------- | -| syncthing_config | /config | storage for config and possible downloaded data | +| syncthing\_config | /config | storage for config and possible downloaded data | -## Ports +#### Ports Set the following ports with the -p tag. | Container Port | Recommended outside port | Protocol | Description | @@ -28,3 +32,22 @@ Set the following ports with the -p tag. | 22000 | 22000 | TCP | Syncthing internal | | 21027 | 21027 | UDP | Syncthing internal | +#### Rebuild + +``` +#!/bin/sh +docker stop syncthing +docker rm syncthing +docker pull linuxserver/syncthing +docker run --name syncthing \ + --restart unless-stopped \ + -p 8384:8384 \ + -p 22000:22000 \ + -p 21027:21027/udp \ + -v syncthing_config:/config \ + -e PUID=0 \ + -e PGID=0 \ + -e TZ=Europe/Berlin \ + -e UMASK_SET=022 \ + -d linuxserver/syncthing +``` diff --git a/docker/teamspeak/description.md b/applications/teamspeak.md similarity index 67% rename from docker/teamspeak/description.md rename to applications/teamspeak.md index de56ede..887ce33 100644 --- a/docker/teamspeak/description.md +++ b/applications/teamspeak.md @@ -1,22 +1,26 @@ # Teamspeak3 -This is a dockerized version of a teamspeak3 server. + +## Setup Server + +### 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. | Name | Usage | Default | | ----------------- | ---------------------------- | ------- | -| TS3SERVER_LICENSE | accept the license agreement | | +| TS3SERVER\_LICENSE | accept the license agreement | | -## Volumes +#### Volumes Set the following volumes with the -v tag. | Volume-Name | Container mount | Description | | ---------------- | --------------- | --------------------------- | | teamspeak3 | /var/ts3server | storage for ts3-server data | -## Ports +#### Ports Set the following ports with the -p tag. | Container Port | Recommended outside port | Protocol | Description | @@ -25,3 +29,19 @@ Set the following ports with the -p tag. | 10011 | 10011 | TCP | ts3-intern | | 30033 | 30033 | TCP | ts3-intern | +#### Rebuild + +``` +#!/bin/sh +docker stop teamspeak3 +docker rm teamspeak3 +docker pull teamspeak:latest +docker run --name teamspeak3 \ + --restart unless-stopped \ + -p 9987:9987/udp \ + -p 10011:10011 \ + -p 30033:30033 \ + -v teamspeak3:/var/ts3server \ + -e TS3SERVER_LICENSE=accept \ + -d teamspeak:latest +``` diff --git a/docker/todo/description.md b/applications/todo-list.md similarity index 64% rename from docker/todo/description.md rename to applications/todo-list.md index 93a2ef5..4deca1b 100644 --- a/docker/todo/description.md +++ b/applications/todo-list.md @@ -1,18 +1,37 @@ -# Todo -This is a dockerized todo-list webui. -The official container and documentation was made by [prologic](https://hub.docker.com/r/pologic/todo). +# Todo-List + +## Setup Server + +### 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. | Volume-Name | Container mount | Description | | ---------------- | -------------------- | ----------------------- | | todo | /go/src/todo/todo.db | Database for todo list | -## Ports +#### Ports + Set the following ports with the -p tag. | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | 8000 | 8000 | TCP | WebUI | +#### Rebuild + +``` +#!/bin/sh +docker stop todo +docker rm todo +docker pull prologic/todo +docker run --name todo \ + -p 8000:8000 \ + --restart unless-stopped \ + -v todo:/go/src/todo/todo.db \ + -d prologic/todo +``` diff --git a/arch-linux/applications/wine.md b/applications/wine.md similarity index 94% rename from arch-linux/applications/wine.md rename to applications/wine.md index 8ce38bd..adf03c1 100644 --- a/arch-linux/applications/wine.md +++ b/applications/wine.md @@ -2,7 +2,9 @@ Wine is a compatibility layer to run windows programs on linux machines. -## Installation and Configuration +## Setup + +### Arch-Linux - Enable multilib support in pacman - `vim /etc/pacman.conf` - Uncomment the following lines @@ -11,6 +13,9 @@ Wine is a compatibility layer to run windows programs on linux machines. Include = /etc/pacman.d/mirrorlist ``` - `pacman -S wine winetricks` - Install wine and configuration helper + +### Configuration + - Set the global variable `WINEPREFIX` to your liking, standard is `$HOME/.wine` - `winetricks` - run the installation of basic windows dependencies to the wine directory - Move the program you want to run to `$WINEPREFIX/drive_c/` diff --git a/arch-linux/installation.md b/arch-installation/installation.md similarity index 96% rename from arch-linux/installation.md rename to arch-installation/installation.md index be0673d..2516416 100644 --- a/arch-linux/installation.md +++ b/arch-installation/installation.md @@ -102,14 +102,14 @@ This will improve the download speed. ## 7. Starting base installation - `pacstrap /mnt base base-devel dosfstools gptfdisk lvm2 linux linux-firmware networkmanager vim` - Installation of main system with needed tools -- `pacstrap /mnt wpa_supplicant wireless_tools` - (optional) installation of wireless tools +- `pacstrap /mnt wpa\_supplicant wireless\_tools` - (optional) installation of wireless tools - `genfstab -Up /mnt > /mnt/etc/fstab` - creation of fstab - `arch-chroot /mnt` - Switch into the newly installed system - `echo ArchLinux > /etc/hostname` - Assign hostname. ```ArchLinux``` can be changed for any name of your preference. ## 8. Set Region and Language -- `echo LANG=en_US.UTF-8 > /etc/locale.conf` - Assign system Language to be english (you can use other languages, look into the ```/etc/locale.conf``` for a list of all available languages) +- `echo LANG=en\_US.UTF-8 > /etc/locale.conf` - Assign system Language to be english (you can use other languages, look into the ```/etc/locale.conf``` for a list of all available languages) - `vim /etc/locale.gen` - Assigning system language by uncomment the lines depending on your needs. In this example: ``` @@ -171,7 +171,7 @@ If the system is installed in a virtual environment or a system with deactivated - Log in as ```root``` user - `systemctl enable NetworkManager.service` - Activate NetworkManager -- `systemctl enable wpa_supplicant.service` - (Optional) activate wpa_supplicant +- `systemctl enable wpa\_supplicant.service` - (Optional) activate wpa_supplicant - `systemctl start NetworkManager.service` - Start NetworkManager The device should connect to the internet if it is connected via LAN. diff --git a/arch-linux/devices/thinkpad_x220.md b/arch-installation/thinkpad_x220.md similarity index 100% rename from arch-linux/devices/thinkpad_x220.md rename to arch-installation/thinkpad_x220.md diff --git a/arch-linux/README.md b/arch-linux/README.md deleted file mode 100644 index d46128b..0000000 --- a/arch-linux/README.md +++ /dev/null @@ -1,10 +0,0 @@ -# Arch Linux -These markdown entries are some guides i am using personally for installing the base system. -There are some additional software recommendations aswell. -Due to my personal preference most of them are commandline applications. - -| File/Folder | Description | -| --------------- | ------------------------------------------------------- | -| applications | Various software recommendations and setups | -| devices | Arch Linux setup for special devices | -| installation.md | This is a guide on my go to installation for Arch Linux | diff --git a/arch-linux/applications/README.md b/arch-linux/applications/README.md deleted file mode 100644 index d994b7d..0000000 --- a/arch-linux/applications/README.md +++ /dev/null @@ -1,12 +0,0 @@ -# Applications - -These are guides on how to set up and configure special programs for Arch Linux, but could be translatable to other ones aswell. - -| File/Folder | Description | -| ------------------- | ------------------------------------------------------------------------------------- | -| calendar.md | My favourite calendar program setup and configuration | -| contacts.md | My favourite contacts program setup and configuration | -| mail.md | My favourite mail program setup and configuration | -| shell.md | /bin/sh is bloated with bash, use dash instead | -| tablecalculation.md | My favourite tablecalculation program setup and configuration | -| wine.md | My favourite way to run windows programs and games with basic setup and configuration | diff --git a/arch-linux/devices/README.md b/arch-linux/devices/README.md deleted file mode 100644 index a8f96e0..0000000 --- a/arch-linux/devices/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# Devices - -These devices i did an Arch Linux setup and configuration on and had some extra things to get everything working. - -| File/Folder | Description | -| ---------------- | -------------------------------------------------------------------------- | -| thinkpad_x220.md | Special installation and configuration additions to a Lenovo Thinkpad X220 | diff --git a/docker/README.md b/docker/README.md deleted file mode 100644 index ccafeee..0000000 --- a/docker/README.md +++ /dev/null @@ -1,38 +0,0 @@ -# Docker -Here you can find a bunch of rebuild shell scripts to automatically stop, remove, update and rebuild containers (or if they dont exist just build them). - -| File/Folder | Description | -| ----------------- | ----------------------------------------------- | -| airsonic | music streaming service | -| bind | dns service | -| cups | print service | -| docker-mailserver | mail service | -| docker-radicale | caldav service | -| folding-at-home | give your cpu power to fight disease | -| gitea | github-like git service | -| git-server-docker | git-server without gui | -| gopherproxy | show a given gopherhole over http | -| gopherserver | service to run a gopherhole | -| hastebin | pastebin alternative | -| homer | static website | -| jellyfin | video streaming service | -| mordhau-server | server for steamgame mordhau | -| nginx | reverse proxy for http(s) | -| onedrive | onedrive client | -| openvpn | vpn service | -| owncloud | server app for owncloud | -| owncloudclient | client app for owncloud | -| pinedocs | view files, good for documentation or wiki | -| pltu | vpn tunnel to a plex service | -| portainer | docker monitoring web-gui | -| portainer-agent | docker agent to connect to existing portainer | -| python-flask | python flask webdev framework | -| samba | shared network storage | -| syncthing | decentralized synchronization tool | -| teamspeak | teamspeak3 server | -| todo | simple todo webgui | - -## Dependencies -These scripts only require ```sh``` and a standard ```docker``` install. -Some of them need the additional ```docker-compose``` package to work, they will have corresponding files in their folders. -If there is more to the configuration than just running the script and following a guided configuration, there is a guide aswell. diff --git a/docker/airsonic/description.md b/docker/airsonic/description.md deleted file mode 100644 index fbc5626..0000000 --- a/docker/airsonic/description.md +++ /dev/null @@ -1,32 +0,0 @@ -# Airsonic -This is a dockerized version of a airsonic server. -The official container and documentation was made by [linuxserver](https://hub.docker.com/r/linuxserver/airsonic). - -## Environment-variables -Set the following variables with the -e tag. - -| Name | Usage | Default | -| ---- | -------- | ------- | -| PUID | UserID | | -| PGID | GroupID | | -| TZ | Timezone | | - -## Volumes -Set the following volumes with the -v tag. - -| Volume-Name | Container mount | Description | -| ---------------- | --------------- | ----------------------- | -| airsonic_config | /config | Configuration files | -| airsonic_media | /media | Various other media | -| media_playlists | /playlists | Location for playlists | -| media_music | /music | Location for music | -| media_audiobooks | /audiobooks | Location for audiobooks | -| media_podcasts | /podcasts | location for podcasts | - -## Ports -Set the following ports with the -p tag. - -| Container Port | Recommended outside port | Protocol | Description | -| -------------- | ------------------------ | -------- | ----------- | -| 4040 | 4040 | TCP | WebUI | - diff --git a/docker/airsonic/rebuild.sh b/docker/airsonic/rebuild.sh deleted file mode 100755 index 0544c92..0000000 --- a/docker/airsonic/rebuild.sh +++ /dev/null @@ -1,17 +0,0 @@ -#!/bin/sh -docker stop airsonic -docker rm airsonic -docker pull linuxserver/airsonic -docker run --name=airsonic \ - --restart unless-stopped \ - -p 4040:4040 \ - -v airsonic_config:/config \ - -v airsonic_media:/media \ - -v media_playlists:/playlists \ - -v media_music:/music \ - -v media_audiobooks:/audiobooks \ - -v media_podcasts:/podcasts \ - -e PUID=0 \ - -e PGID=0 \ - -e TZ=Europe/Berlin \ - -d linuxserver/airsonic diff --git a/docker/bind/rebuild.sh b/docker/bind/rebuild.sh deleted file mode 100755 index d03d85c..0000000 --- a/docker/bind/rebuild.sh +++ /dev/null @@ -1,12 +0,0 @@ -#!/bin/sh -docker stop bind -docker rm bind -docker pull ventz/bind:latest -docker run --name bind \ - --restart unless-stopped \ - --dns=1.1.1.1 --dns=8.8.8.8 \ - -p 53:53/udp \ - -p 53:53 \ - -v bind_cache:/var/cache/bind \ - -v bind_etc:/etc/bind \ - -d ventz/bind:latest diff --git a/docker/cups/rebuild.sh b/docker/cups/rebuild.sh deleted file mode 100755 index 368ffa4..0000000 --- a/docker/cups/rebuild.sh +++ /dev/null @@ -1,11 +0,0 @@ -#!/bin/sh -docker stop cups -docker rm cups -docker pull olbat/cupsd:latest -docker run --name cups \ - --restart unless-stopped \ - --net=host \ - -p 631:631 \ - -v /var/run/dbus:/var/run/dbus \ - -v cups:/etc/cups/ \ - -d olbat/cupsd:latest diff --git a/docker/docker-mailserver/rebuild.sh b/docker/docker-mailserver/rebuild.sh deleted file mode 100755 index 018bde2..0000000 --- a/docker/docker-mailserver/rebuild.sh +++ /dev/null @@ -1,4 +0,0 @@ -#!/bin/sh -docker-compose down -docker pull tvial/docker-mailserver:latest -docker-compose up -d diff --git a/docker/docker-radicale/description.md b/docker/docker-radicale/description.md deleted file mode 100644 index 34996c1..0000000 --- a/docker/docker-radicale/description.md +++ /dev/null @@ -1,43 +0,0 @@ -# Docker-radicale -This is a dockerized version of a radicale server. -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 -Set the following volumes with the -v tag. - -| Volume-Name | Container mount | Description | -| ---------------- | --------------- | --------------------------- | -| radicale\_data | /data | storage for caldav | -| radicale\_config | /config | storage for radicale config | - -## Ports -Set the following ports with the -p tag. - -| Container Port | Recommended outside port | Protocol | Description | -| -------------- | ------------------------ | -------- | ------------- | -| 5232 | 5232 | TCP | WebUI, caldav | - -## Additional -There are some special variables to set. - -| Flag | Usage | -| ----------- | ---------------------------------------------------------------------- | -| --read-only | make radicale read-only, caldav can still be changed and used normally | - -## Setup -After installation there are a few crucial steps to take to secure your calendars with a login. -It is important to change the config file which can be found in the docker volume with name `radicale_config` to match the `config`-file. - -Following this you need to make sure there is a password file in the docker volume `radicale_data` called `users`. -The password will be encrypted using `bcrypt`. -Steps to create a file with a user and password: -- You will have to install the package which includes `htpasswd`; for debian based distributions this is `apt install apache2-utils` -- `cd /var/lib/docker/volumes/radicale\_data/\_data` - go to the volume -- `touch ./users` - create a file called users -- `htpasswd -B ./users username` - add user with name and password to the file (change `username` to your desired username) - -Now you can go to the exposed port and login with your chosen username and password. -If you only added one user you shouldn't be able to login with any other data than your username and password. diff --git a/docker/docker-radicale/rebuild.sh b/docker/docker-radicale/rebuild.sh deleted file mode 100755 index 2e21a61..0000000 --- a/docker/docker-radicale/rebuild.sh +++ /dev/null @@ -1,11 +0,0 @@ -#/bin/sh -docker stop radicale -docker rm radicale -docker pull tomsquest/docker-radicale:2.1.11.4 -docker run --name radicale \ - --restart unless-stopped \ - --read-only \ - -p 5232:5232 \ - -v radicale_data:/data \ - -v radicale_config:/config \ - -d tomsquest/docker-radicale:2.1.11.4 diff --git a/docker/foldingathome/rebuild.sh b/docker/foldingathome/rebuild.sh deleted file mode 100755 index 25cfd1d..0000000 --- a/docker/foldingathome/rebuild.sh +++ /dev/null @@ -1,12 +0,0 @@ -#!/bin/sh -docker stop folding-at-home -docker rm folding-at-home -docker pull johnktims/folding-at-home -docker run --name folding-at-home \ - --restart unless-stopped \ - -it \ - -p 7396:7396 \ - -d johnktims/folding-at-home \ - --user=default \ - --power=full \ - --team=000000 diff --git a/docker/git-server-docker/description.md b/docker/git-server-docker/description.md deleted file mode 100644 index cf0c687..0000000 --- a/docker/git-server-docker/description.md +++ /dev/null @@ -1,19 +0,0 @@ -# git-server-docker -This is a dockerized version of a git server. -The official container and documentation was made by [jkarlos](https://hub.docker.com/r/jkarlos/git-server-docker). - -## Volumes -Set the following volumes with the -v tag. - -| Volume-Name | Container mount | Description | -| ---------------- | ----------------- | --------------------------- | -| git-server-repos | /git-server/repos | storage for git repos | -| git-server-keys | /git-server/keys | storage for user ssh keys | - -## Ports -Set the following ports with the -p tag. - -| Container Port | Recommended outside port | Protocol | Description | -| -------------- | ------------------------ | -------- | ------------------------------------- | -| 22 | 2222 | TCP | ssh port for accessing the git server | - diff --git a/docker/git-server-docker/rebuild.sh b/docker/git-server-docker/rebuild.sh deleted file mode 100755 index 23040c6..0000000 --- a/docker/git-server-docker/rebuild.sh +++ /dev/null @@ -1,10 +0,0 @@ -#!/bin/sh -docker stop git-server -docker rm git-server -docker pull jkarlos/git-server-docker:latest -docker run --name git-server \ - --restart unless-stopped \ - -p 2222:22 \ - -v git-server_repos:/git-server/repos \ - -v git-server_keys:/git-server/keys \ - -d jkarlos/git-server-docker diff --git a/docker/gitea/description.md b/docker/gitea/description.md deleted file mode 100644 index 256ade5..0000000 --- a/docker/gitea/description.md +++ /dev/null @@ -1,78 +0,0 @@ -# Gitea -This is a dockerized version of an gitea server. -The official container and documentation was made by [gitea](https://hub.docker.com/gitea/gitea). -This docker-rebuild is made up by a ```docker-compose.yml``` file. -The services in this files are explained seperately. - -## Gitea - -### Environment-variables -Set the following environment-variables in the ```environment:``` section of the docker-compose file. - -| Name | Usage | Default | -| ------------------- | ------------------------------ | ------- | -| USER_UID | User userid to run gitea | | -| USER_GID | User groupid to run gitea | | -| DB_TYPE | Specify database type | | -| DB_HOST | Specify database host and port | | -| DB_NAME | Specify Name of the database | | -| DB_USER | Username for the database | | -| DB_PASSWD | Password for the database | | - - -### Volumes -Set the following volumes in the ```volumes:``` section of the docker-compose file. - -| Volume-Name | Container mount | Description | -| ---------------- | ---------------------- | ------------------------------ | -| data | /data | storage for data of git server | -| /etc/timezone | /etc/timezone:ro | link timezone | -| /etc/localtime | /etc/localtime | link localtime | - -### Ports -Set the following ports in the ```ports:``` section. - -| Container Port | Recommended outside port | Protocol | Description | -| -------------- | ------------------------ | -------- | ---------------------- | -| 3000 | 3000 | TCP | WebUI | -| 22 | 222 | TCP | ssh port of git server | - -### Networks -Set the following networks in the ```networks:`` section of the docker-compose file. - -| Name | Usage | -| ----- | --------------------- | -| gitea | connect db with gitea | - -### Dependencies -Set the following dependencies in the ```depends_on:``` section of the docker-compose file. - -| Name | Usage | -| ----- | --------------------- | -| 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 | diff --git a/docker/gitea/docker-compose.yml b/docker/gitea/docker-compose.yml deleted file mode 100644 index 2c4ed30..0000000 --- a/docker/gitea/docker-compose.yml +++ /dev/null @@ -1,47 +0,0 @@ -version: "2" - -networks: - gitea: - external: false - -services: - server: - image: gitea/gitea:latest - environment: - - USER_UID=1000 - - USER_GID=1000 - - DB_TYPE=mysql - - DB_HOST=db:3306 - - DB_NAME=gitea - - DB_USER=gitea - - DB_PASSWD=gitea - restart: unless-stopped - networks: - - gitea - volumes: - - data:/data - - /etc/timezone:/etc/timezone:ro - - /etc/localtime:/etc/localtime:ro - ports: - - "3000:3000" - - "222:22" - depends_on: - - db - db: - image: mysql:5.7 - restart: unless-stopped - environment: - - MYSQL_ROOT_PASSWORD=gitea - - MYSQL_USER=gitea - - MYSQL_PASSWORD=gitea - - MYSQL_DATABASE=gitea - networks: - - gitea - volumes: - - mysql:/var/lib/mysql - -volumes: - data: - driver: local - mysql: - driver: local diff --git a/docker/gitea/rebuild.sh b/docker/gitea/rebuild.sh deleted file mode 100755 index e25ba58..0000000 --- a/docker/gitea/rebuild.sh +++ /dev/null @@ -1,3 +0,0 @@ -#!/bin/sh -docker-compose down -docker-compose up -d diff --git a/docker/gopherproxy/description.md b/docker/gopherproxy/description.md deleted file mode 100644 index ace3280..0000000 --- a/docker/gopherproxy/description.md +++ /dev/null @@ -1,17 +0,0 @@ -# Gopherproxy -This is a dockerized version of a gopherproxy server. -The official container and documentation was made by [prologic](https://hub.docker.com/r/prologic/gopherproxy). - -## Ports -Set the following ports with the -p tag. - -| Container Port | Recommended outside port | Protocol | Description | -| -------------- | ------------------------ | -------- | ---------------------------------------- | -| 8000 | 8000 | TCP | port to proxy the gopher site as http to | - -## Additional -There are some special variables to set. - -| Flag | Usage | -| ---- | ------------------------------------------------------------- | -| -uri | define the gopher site to proxy (just 'domain.tld' is enough) | diff --git a/docker/gopherproxy/rebuild.sh b/docker/gopherproxy/rebuild.sh deleted file mode 100755 index 77e38ba..0000000 --- a/docker/gopherproxy/rebuild.sh +++ /dev/null @@ -1,9 +0,0 @@ -#!/bin/sh -docker stop gopheroverhttp -docker rm gopheroverhttp -docker pull prologic/gopherproxy -docker run --name gopheroverhttp \ - --restart unless-stopped \ - -p 8000:8000 \ - -d prologic/gopherproxy \ - -uri 'domain.tld' diff --git a/docker/gopherserver/description.md b/docker/gopherserver/description.md deleted file mode 100644 index e0295ea..0000000 --- a/docker/gopherserver/description.md +++ /dev/null @@ -1,24 +0,0 @@ -# Gopherserver -This is a dockerized version of a gopher server. -The official container and documentation was made by [tiynger](https://hub.docker.com/r/tiynger/gopherserver). - -## Environment-variables -Set the following variables with the -e tag. - -| Name | Usage | Default | -| ------------- | --------------------------------------------------- | --------- | -| SERVER_NAME | set this to your IP/Domain (no "gopher://" needed!) | localhost | - -## Volumes -Set the following volumes with the -v tag. - -| Volume-Name | Container mount | Description | -| -------------------- | --------------- | ----------------------------- | -| gopherwebdir | /var/gopher | directory for the gopher page | - -## Ports -Set the following ports with the -p tag. - -| Container port | Recommended outside port | Protocol | Description | -| -------------- | ------------------------ | ---------- | ---------------------------- | -| 70 | 70 | TCP | port for the gopher-protocol | diff --git a/docker/gopherserver/rebuild.sh b/docker/gopherserver/rebuild.sh deleted file mode 100755 index 5241a67..0000000 --- a/docker/gopherserver/rebuild.sh +++ /dev/null @@ -1,10 +0,0 @@ -#!/bin/sh -docker stop gopherserver -docker rm gopherserver -docker pull tiynger/gopherserver -docker run --name gopherserver \ - --restart unless-stopped \ - -p 70:70 \ - -v gopherserver:/var/gopher \ - -e SERVER_NAME='domain.tld' \ - -d tiynger/gopherserver diff --git a/docker/hastebin/rebuild.sh b/docker/hastebin/rebuild.sh deleted file mode 100755 index 9c8ce0e..0000000 --- a/docker/hastebin/rebuild.sh +++ /dev/null @@ -1,10 +0,0 @@ -#!/bin/sh -docker stop hastebin -docker rm hastebin -docker pull rlister/hastebin:latest -docker run --name hastebin \ - --restart unless-stopped \ - -p 7777:7777 \ - -v hastebin:/app/data \ - -e STORAGE_TYPE=file \ - -d rlister/hastebin:latest diff --git a/docker/homer/config.yml b/docker/homer/config.yml deleted file mode 100644 index d261a4a..0000000 --- a/docker/homer/config.yml +++ /dev/null @@ -1,26 +0,0 @@ -title: "tmp" -subtitle: "tmp" -logo: "tmp" -footer: "" - -message: - style: "" - title: "tmp" - content: "tmp" - -links: - - name: "tmp" - icon: "tmp" - url: "tmp" - target: '_blank' - -services: - - name: "tmp" - icon: "tmp" - items: - - name: "tmp" - logo: "tmp" - subtitle: "tmp" - tag: "tmp" - url: "tmp" - target: '_blank' diff --git a/docker/homer/description.md b/docker/homer/description.md deleted file mode 100644 index 5c323e9..0000000 --- a/docker/homer/description.md +++ /dev/null @@ -1,18 +0,0 @@ -# Homer -This is a dockerized version of a homer server. -The official container and documentation was made by [b4bz](https://hub.docker.com/r/b4bz/homer). - -## Volumes -Set the following volumes with the -v tag. - -| Volume-Name | Container mount | Description | -| ------------------------ | --------------- | ---------------------------------- | -| /current/dir/config.yml | /www/config.yml | configuration file for static page | -| homer | /www/assets | storage for icons, etc | - -## Ports -Set the following ports with the -p tag. - -| Container Port | Recommended outside port | Protocol | Description | -| -------------- | ------------------------ | -------- | ----------- | -| 8080 | 8080 | TCP | WebUI | diff --git a/docker/homer/rebuild.sh b/docker/homer/rebuild.sh deleted file mode 100755 index c7d3979..0000000 --- a/docker/homer/rebuild.sh +++ /dev/null @@ -1,11 +0,0 @@ -#!/bin/sh -docker stop homer -docker rm homer -docker pull b4bz/homer:latest -docker run --name homer \ - --restart unless-stopped \ - -p 8080:8080 \ - -v /root/docker/homer/config.yml:/www/config.yml \ - -v homer:/www/assets \ - -d b4bz/homer:latest - diff --git a/docker/jellyfin/description.md b/docker/jellyfin/description.md deleted file mode 100644 index 65ac09c..0000000 --- a/docker/jellyfin/description.md +++ /dev/null @@ -1,36 +0,0 @@ -# Jellyfin -This is a dockerized version of an jellyfin server. -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. - -## Jellyfin - -### Environment-variables -Set the following environment-variables in the ```environment:``` section of the docker-compose file. - -| Name | Usage | Default | -| ------------------- | ---------------------------- | ------- | -| PUID | Userid to run the container | | -| PGID | Groupid to run the container | | -| TZ | specify the timezone | | - -### Volumes -Set the following volumes in the ```volumes:``` section of the docker-compose file. - -| Volume-Name | Container mount | Description | -| ---------------- | ---------------------- | ------------------------------------ | -| config | /config | storage for config files of jellyfin | -| media_movies | /data/movies | storage for movies | -| media_tvshows | /data/tvshows | storage for tvshows | -| transcode | /transcode | tmp storage to transcode | - -Because it is useful to have the possibility to use the ```media_movies``` and ```media_tvshows``` in multiple containers, -it is recommended to use them as external volumes (volumes section: ```external: true``` instead of ```driver: local```). -To use the rebuild the volumes have to exist before creating the container (```docker volume create media_movies``` and tvshows accordingly). - -### Ports -Set the following ports in the ```ports:``` section. - -| Container Port | Recommended outside port | Protocol | Description | -| -------------- | ------------------------ | -------- | ----------- | -| 8096 | 8096 | TCP | WebUI | diff --git a/docker/jellyfin/docker-compose.yaml b/docker/jellyfin/docker-compose.yaml deleted file mode 100644 index c8fdb55..0000000 --- a/docker/jellyfin/docker-compose.yaml +++ /dev/null @@ -1,27 +0,0 @@ -version: "2" -services: - jellyfin: - image: linuxserver/jellyfin - container_name: jellyfin - environment: - - PUID=1000 - - PGID=1000 - - TZ=Europe/Berlin - volumes: - - config:/config - - media_movies:/data/movies - - media_tvshows:/data/tvshows - - transcode:/transcode - ports: - - 8096:8096 - restart: unless-stopped - -volumes: - config: - driver: local - transcode: - driver: local - media_movies: - external: true - media_tvshows: - external: true diff --git a/docker/jellyfin/rebuild.sh b/docker/jellyfin/rebuild.sh deleted file mode 100755 index 7c648fb..0000000 --- a/docker/jellyfin/rebuild.sh +++ /dev/null @@ -1,4 +0,0 @@ -#!/bin/sh -docker-compose down -docker pull linuxserver/jellyfin:latest -docker-compose up -d diff --git a/docker/mordhau-server/start.sh b/docker/mordhau-server/start.sh deleted file mode 100755 index 711a3c4..0000000 --- a/docker/mordhau-server/start.sh +++ /dev/null @@ -1,23 +0,0 @@ -#!/bin/sh - -docker pull tetricz/mordhau-server -docker run --name=mordhau \ - --restart=unless-stopped \ - -p 27015:27015/udp \ - -p 7777:7777/udp \ - -p 15000:15000/udp \ - -v mordhau:/serverdata/mordhau \ - -v mordhau_steamcmd:/serverdata/steamcmd \ - -e QUERYPORT=27015 \ - -e GAME_PORT=7777 \ - -e BEACONPORT=15000 \ - -e STEAM_CONNECT=True \ - -e STEAMID64="tmp" \ - -e UID=99 \ - -e GID=100 \ - -e GAME_MODE=SKM \ - -e PLAYER_COUNT="16" \ - -e SERVER_NAME="tmp" \ - -e SERVER_PASSWORD="tmp" \ - -e ADMIN_PASSWORD="tmp" \ - tetricz/mordhau-server diff --git a/docker/mordhau-server/stop.sh b/docker/mordhau-server/stop.sh deleted file mode 100755 index cd2de1d..0000000 --- a/docker/mordhau-server/stop.sh +++ /dev/null @@ -1,4 +0,0 @@ -#/bin/sh - -docker stop mordhau -docker rm mordhau diff --git a/docker/nginx/rebuild.sh b/docker/nginx/rebuild.sh deleted file mode 100755 index 8f20d3d..0000000 --- a/docker/nginx/rebuild.sh +++ /dev/null @@ -1,5 +0,0 @@ -#!/bin/sh -docker-compose down -docker pull nginx:latest -docker pull certbot/certbot:latest -docker-compose up -d diff --git a/docker/onedrive/description.md b/docker/onedrive/description.md deleted file mode 100644 index 8d0832f..0000000 --- a/docker/onedrive/description.md +++ /dev/null @@ -1,19 +0,0 @@ -# Onedrive -This is a dockerized version of a onedrive client. -The official container and documentation was made by [oznu](https://hub.docker.com/r/oznu/onedrive). - -## Environment-variables -Set the following variables with the -e tag. - -| Name | Usage | Default | -| ---- | -------- | ------- | -| PUID | UserID | | -| PGID | GroupID | | - -## Volumes -Set the following volumes with the -v tag. - -| Volume-Name | Container mount | Description | -| ---------------- | --------------- | ----------------------------------------------- | -| onedrive_config | /config | configuration storage for the server connection | -| onedrive_doc | /documents | storage for downloaded documents | diff --git a/docker/onedrive/rebuild.sh b/docker/onedrive/rebuild.sh deleted file mode 100755 index 343cdaa..0000000 --- a/docker/onedrive/rebuild.sh +++ /dev/null @@ -1,11 +0,0 @@ -#!/bin/sh -docker stop onedrive -docker rm onedrive -docker pull oznu/onedrive:latest -docker run --name onedrive \ - --restart unless-stopped \ - -v onedrive_config:/config \ - -v onedrive_doc:/documents \ - -e PUID=$(id -u) \ - -e PGID=$(id -g) \ - -d oznu/onedrive:latest diff --git a/docker/openvpn/rebuild.sh b/docker/openvpn/rebuild.sh deleted file mode 100755 index b7475f2..0000000 --- a/docker/openvpn/rebuild.sh +++ /dev/null @@ -1,10 +0,0 @@ -#!/bin/sh -docker stop openvpn -docker rm openvpn -docker pull kylemanna/openvpn -docker run --name openvpn \ - --restart unless-stopped \ - --cap-add=NET_ADMIN \ - -p 1194:1194/udp \ - -v ovpn:/etc/openvpn \ - -d kylemanna/openvpn diff --git a/docker/owncloud/description.md b/docker/owncloud/description.md deleted file mode 100644 index 8e3ae14..0000000 --- a/docker/owncloud/description.md +++ /dev/null @@ -1,38 +0,0 @@ -# Owncloud -This is a dockerized version of an owncloud server. -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. - -## Owncloud - -### Volumes -Set the following volumes in the ```volumes:``` section of the docker-compose file. - -| Volume-Name | Container mount | Description | -| ---------------- | ---------------------- | ---------------------------- | -| owncloud | /var/www/html | storage for owncloud plugins | -| config | /var/www/html/config | storage for owncloud config | - -### Ports -Set the following ports in the ```ports:``` section. - -| Container Port | Recommended outside port | Protocol | Description | -| -------------- | ------------------------ | -------- | ----------- | -| 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 | diff --git a/docker/owncloud/docker-compose.yml b/docker/owncloud/docker-compose.yml deleted file mode 100644 index 489d3bd..0000000 --- a/docker/owncloud/docker-compose.yml +++ /dev/null @@ -1,28 +0,0 @@ -version: '3.1' - -services: - - owncloud: - image: owncloud - restart: unless-stopped - ports: - - 80:80 - volumes: - - owncloud:/var/www/html - - config:/var/www/html/config - - mariadb: - image: mariadb - restart: unless-stopped - environment: - MYSQL_ROOT_PASSWORD: pass - volumes: - - mariadb:/var/lib/mysql - -volumes: - owncloud: - driver: local - mariadb: - driver: local - config: - driver: local diff --git a/docker/owncloud/rebuild.sh b/docker/owncloud/rebuild.sh deleted file mode 100755 index 08680ed..0000000 --- a/docker/owncloud/rebuild.sh +++ /dev/null @@ -1,5 +0,0 @@ -#!/bin/sh -docker-compose down -docker pull owncloud -docker pull mariadb -docker-compose up -d diff --git a/docker/owncloudcli/description.md b/docker/owncloudcli/description.md deleted file mode 100644 index 7954896..0000000 --- a/docker/owncloudcli/description.md +++ /dev/null @@ -1,19 +0,0 @@ -# DockerOwncloudClient -This is a dockerized version of a OwnCloud Client. -The original container and documentation are made by [tiynger](https://hub.docker.com/r/tiynger/owncloudclient) - -## Environment-variables -Set the following variables with the -e tag. - -| Name | Usage | Default | -| ----------- | --------------------------------------------------- | --------- | -| USER | username of OwnCloud server | admin | -| PASSWORD | password of OwnCloud server | admin | -| URL | url of OwnCloud server (dont forget the http(s)://) | localhost | - -## Volumes -Set the following volumes with the -v tag. - -| Volume-Name | Container mount | Description | -| ----------- | --------------- | ----------------------------------- | -| data | /data | directory for the owncloud contents | diff --git a/docker/owncloudcli/rebuild.sh b/docker/owncloudcli/rebuild.sh deleted file mode 100755 index a8c33a9..0000000 --- a/docker/owncloudcli/rebuild.sh +++ /dev/null @@ -1,11 +0,0 @@ -#!/bin/sh -docker stop owncloudcli -docker rm owncloudcli -docker pull tiynger/owncloudclient -docker run --name owncloudcli \ - --restart unless-stopped \ - -v owncloudcli:/data \ - -e USER='user' \ - -e PASSWORD='password' \ - -e URL='https://subdomain.domain.tld' \ - -d tiynger/owncloudclient diff --git a/docker/pinedocs/rebuild.sh b/docker/pinedocs/rebuild.sh deleted file mode 100755 index b237f2a..0000000 --- a/docker/pinedocs/rebuild.sh +++ /dev/null @@ -1,9 +0,0 @@ -#!/bin/sh -docker stop pinedocs -docker rm pinedocs -docker pull xy2z/pinedocs -docker run --name pinedocs \ - --restart unless-stopped \ - -p 80:80 \ - -v pinedocs:/data \ - -d xy2z/pinedocs diff --git a/docker/pltu/rebuild.sh b/docker/pltu/rebuild.sh deleted file mode 100755 index a5a4f0b..0000000 --- a/docker/pltu/rebuild.sh +++ /dev/null @@ -1,10 +0,0 @@ -#!/bin/sh -docker stop pltu -docker rm pltu -docker pull nasourso/pltu:latest -docker run --name pltu \ - --restart unless-stopped \ - --privileged \ - -p 32400:80 \ - -v pltu:/cert/ \ - -d nasourso/pltu:latest diff --git a/docker/portainer-agent/description.md b/docker/portainer-agent/description.md deleted file mode 100644 index eb17619..0000000 --- a/docker/portainer-agent/description.md +++ /dev/null @@ -1,19 +0,0 @@ -# Portainer-agent -This is a dockerized portainer-agent. -The official container and documentation was made by [portainer](https://hub.docker.com/r/portainer/agent). - -## Volumes -Set the following volumes with the -v tag. - -| Volume-Name | Container mount | Description | -| ----------------------- | ----------------------- | -------------------------------------- | -| /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 -Set the following ports with the -p tag. - -| Container Port | Recommended outside port | Protocol | Description | -| -------------- | ------------------------ | -------- | -------------------- | -| 9001 | 9001 | TCP | Portainer agent port | - diff --git a/docker/portainer-agent/rebuild.sh b/docker/portainer-agent/rebuild.sh deleted file mode 100755 index 9ab700e..0000000 --- a/docker/portainer-agent/rebuild.sh +++ /dev/null @@ -1,10 +0,0 @@ -#!/bin/sh -docker stop portainer_agent -docker rm portainer_agent -docker pull portainer/agent:latest -docker run --name portainer_agent \ - -p 9001:9001 \ - --restart unless-stopped \ - -v /var/run/docker.sock:/var/run/docker.sock \ - -v /var/lib/docker/volumes:/var/lib/docker/volumes \ - -d portainer/agent:latest diff --git a/docker/portainer/description.md b/docker/portainer/description.md deleted file mode 100644 index 42220c4..0000000 --- a/docker/portainer/description.md +++ /dev/null @@ -1,18 +0,0 @@ -# Portainer -This is a dockerized version of portainer. -The official container and documentation was made by [portainer](https://hub.docker.com/r/portainer/portainer). - -## Volumes -Set the following volumes with the -v tag. - -| Volume-Name | Container mount | Description | -| -------------------- | -------------------- | ------------------------------------------------- | -| portainer | /data | configuration directory | -| /var/run/docker.sock | /var/run/docker.sock | connection to local docker containers and volumes | - -## Ports -Set the following ports with the -p tag. - -| Container Port | Recommended outside port | Protocol | Description | -| -------------- | ------------------------ | -------- | ----------- | -| 9000 | 9000 | TCP | WebUI | diff --git a/docker/portainer/rebuild.sh b/docker/portainer/rebuild.sh deleted file mode 100755 index 6d062b5..0000000 --- a/docker/portainer/rebuild.sh +++ /dev/null @@ -1,10 +0,0 @@ -#!/bin/sh -docker stop portainer -docker rm portainer -docker pull portainer/portainer:latest -docker run --name portainer \ - --restart unless-stopped \ - -p 9000:9000 \ - -v /var/run/docker.sock:/var/run/docker.sock \ - -v portainer:/data \ - -d portainer/portainer diff --git a/docker/python-flask/rebuild.sh b/docker/python-flask/rebuild.sh deleted file mode 100755 index fc92604..0000000 --- a/docker/python-flask/rebuild.sh +++ /dev/null @@ -1,9 +0,0 @@ -#!/bin/sh -docker stop python-flask -docker rm python-flask -docker pull tiynger/pythonflask:latest -docker run --name python-flask \ - --restart unless-stopped \ - -p "5000:5000" \ - -v python-flask:/flask \ - -d tiynger/pythonflask:latest diff --git a/docker/samba/description.md b/docker/samba/description.md deleted file mode 100644 index 61baa95..0000000 --- a/docker/samba/description.md +++ /dev/null @@ -1,33 +0,0 @@ -# Samba -This is a dockerized version of a samba server. -The official container and documentation was made by [dperson](https://hub.docker.com/r/samba). - -## Volumes -Set the following volumes with the -v tag. - -| Volume-Name | Container mount | Description | -| ---------------- | --------------- | ------------------------------ | -| samba_nas | /nas | storage for samba data | -| samba_lib | /var/lib/samba | storage for samba lib | -| samba_cache | /var/cache/samba | storage for samba cache | -| samba_run | /run/samba | run entries for samba | -| samba_etc | /etc | etc directory of samba server | -| samba_log | /var/log/samba | storage for samba logs | - -## Ports -Set the following ports with the -p tag. - -| Container Port | Recommended outside port | Protocol | Description | -| -------------- | ------------------------ | -------- | -------------- | -| 139 | 139 | TCP | Samba internal | -| 445 | 445 | TCP | Samba internal | - -##Additional -There are some special variables to set. - -| Flag | Usage | -| --------------------------------------------------------------------- | ---------------- | -| -u (;ID;group;GID) | define user | -| -w | define workgroup | -| -s (;browse;readonly;guest;users;admins;writelist;comment) | define shares | - diff --git a/docker/samba/rebuild.sh b/docker/samba/rebuild.sh deleted file mode 100755 index 659f0fb..0000000 --- a/docker/samba/rebuild.sh +++ /dev/null @@ -1,20 +0,0 @@ -#!/bin/sh -docker stop samba -docker rm samba -docker pull dperson/samba -docker run --name samba \ - --restart unless-stopped \ - -p 139:139 \ - -p 445:445 \ - -v samba_nas:/nas \ - -v samba_lib:/var/lib/samba \ - -v samba_cache:/var/cache/samba \ - -v samba_run:/run/samba \ - -v samba_etc:/etc \ - -v samba_log:/var/log/samba \ - -d dperson/samba -p \ - -u "user1;pass1" \ - -u "user2;pass2" \ - -s "public;/nas/public" \ - -s "user1private;/nas/user1;no;no;no;user1;user1" \ - -s "user2private;/nas/user2;no;no;no;user2;user2" diff --git a/docker/syncthing/rebuild.sh b/docker/syncthing/rebuild.sh deleted file mode 100755 index fe26e93..0000000 --- a/docker/syncthing/rebuild.sh +++ /dev/null @@ -1,15 +0,0 @@ -#!/bin/sh -docker stop syncthing -docker rm syncthing -docker pull linuxserver/syncthing -docker run --name syncthing \ - --restart unless-stopped \ - -p 8384:8384 \ - -p 22000:22000 \ - -p 21027:21027/udp \ - -v syncthing_config:/config \ - -e PUID=0 \ - -e PGID=0 \ - -e TZ=Europe/Berlin \ - -e UMASK_SET=022 \ - -d linuxserver/syncthing diff --git a/docker/teamspeak/rebuild.sh b/docker/teamspeak/rebuild.sh deleted file mode 100755 index 67ae743..0000000 --- a/docker/teamspeak/rebuild.sh +++ /dev/null @@ -1,12 +0,0 @@ -#!/bin/sh -docker stop teamspeak3 -docker rm teamspeak3 -docker pull teamspeak:latest -docker run --name teamspeak3 \ - --restart unless-stopped \ - -p 9987:9987/udp \ - -p 10011:10011 \ - -p 30033:30033 \ - -v teamspeak3:/var/ts3server \ - -e TS3SERVER_LICENSE=accept \ - -d teamspeak:latest diff --git a/docker/todo/rebuild.sh b/docker/todo/rebuild.sh deleted file mode 100755 index a162a1d..0000000 --- a/docker/todo/rebuild.sh +++ /dev/null @@ -1,9 +0,0 @@ -#!/bin/sh -docker stop todo -docker rm todo -docker pull prologic/todo -docker run --name todo \ - -p 8000:8000 \ - --restart unless-stopped \ - -v todo:/go/src/todo/todo.db \ - -d prologic/todo