mirror of https://github.com/tiyn/wiki
TiynGER
3 weeks ago
commit
546b52e217
@ -0,0 +1 @@
|
||||
*.pdf
|
||||
@ -0,0 +1,53 @@
|
||||
# /maintainer/ - /name/
|
||||
|
||||
This is a [Docker](/wiki/docker.md) container for a /service/ server.
|
||||
The official container and documentation was made by
|
||||
[/maintainer/]().
|
||||
This docker-rebuild is made up by a `docker-compose.yml` file.
|
||||
In addition to the main container you need to connect a
|
||||
[/additional containers needed/]() to it.
|
||||
|
||||
## Set-up
|
||||
|
||||
Create the files `rebuild.sh`, `.env` and `docker-compose.yml` at the same
|
||||
place.
|
||||
Change the settings according to your needs and run `./rebuild.sh` afterwards.
|
||||
|
||||
### Environment-variables
|
||||
|
||||
Set the following variables with the -e tag.
|
||||
|
||||
| Name | Usage | Default |
|
||||
| ---------- | ------------- | ------- |
|
||||
| `/name/` | /description/ | |
|
||||
|
||||
### Ports
|
||||
|
||||
Set the following ports in the `ports:` section.
|
||||
|
||||
| Container Port | Recommended outside port | Protocol | Description |
|
||||
| -------------- | ------------------------ | --------- | ------------- |
|
||||
| `/port/` | `/port/` | /TCP/UDP/ | /description/ |
|
||||
|
||||
### Volumes
|
||||
|
||||
Set the following volumes with the -v tag.
|
||||
|
||||
| Outside mount/volume name | Container mount | Description |
|
||||
| ------------------------- | --------------- | ------------- |
|
||||
| `/volume name/` | `/mount point/` | /description/ |
|
||||
|
||||
### rebuild.sh
|
||||
|
||||
```sh
|
||||
```
|
||||
|
||||
### .env
|
||||
|
||||
```sh
|
||||
```
|
||||
|
||||
### docker-compose.yml
|
||||
|
||||
```yml
|
||||
```
|
||||
@ -0,0 +1,39 @@
|
||||
# /maintainer/ - /name/
|
||||
|
||||
This is a [Docker](/wiki/docker.md) container for a /service/ server.
|
||||
The official container and documentation was made by
|
||||
[/maintainer/]().
|
||||
|
||||
## Set-up
|
||||
|
||||
Create the file `rebuild.sh`.
|
||||
Change the settings according to your needs and run `./rebuild.sh` afterwards.
|
||||
|
||||
## Environment-variables
|
||||
|
||||
Set the following variables with the -e tag.
|
||||
|
||||
| Name | Usage | Default |
|
||||
| ---------- | ------------- | ------- |
|
||||
| `/name/` | /description/ | |
|
||||
|
||||
## Ports
|
||||
|
||||
Set the following ports in the `ports:` section.
|
||||
|
||||
| Container Port | Recommended outside port | Protocol | Description |
|
||||
| -------------- | ------------------------ | --------- | ------------- |
|
||||
| `/port/` | `/port/` | /TCP/UDP/ | /description/ |
|
||||
|
||||
## Volumes
|
||||
|
||||
Set the following volumes with the -v tag.
|
||||
|
||||
| Outside mount/volume name | Container mount | Description |
|
||||
| ------------------------- | --------------- | ------------- |
|
||||
| `/volume name/` | `/mount point/` | /description/ |
|
||||
|
||||
## rebuild.sh
|
||||
|
||||
```sh
|
||||
```
|
||||
@ -0,0 +1,13 @@
|
||||
# /name/
|
||||
|
||||
[/name/]() is a /description.
|
||||
|
||||
## Setup
|
||||
|
||||
The /name/ program can be installed [/via GitHub/]().
|
||||
Alternatively many linux package managers package /name/ in the `/package/`
|
||||
package.
|
||||
|
||||
## Usage
|
||||
|
||||
/basic description for usage/
|
||||
@ -0,0 +1,20 @@
|
||||
# IR Remote
|
||||
|
||||
[IR Remote](https://gitlab.com/divested-mobile/irremote) is a free and open-source App developed
|
||||
for [Android](/wiki/android.md) systems.
|
||||
It can use a [smartphone](/wiki/smart_devices.md#smartphones-and-tablet-computers) that is capable
|
||||
of sending [infrared](/wiki/infrared.md) signals to be used as an
|
||||
[infrared remote control](/wiki/infrared.md#remote-controls)
|
||||
|
||||
## Setup
|
||||
|
||||
On [Android](/wiki/android.md) IR Remote is available on the
|
||||
[F-Droid app store](/wiki/android/f-droid.md) in a package called
|
||||
[IR Remote](https://f-droid.org/de/packages/us.spotco.ir_remote/).
|
||||
|
||||
## Usage
|
||||
|
||||
IR Remote features many preset remote controls for devices of major brands.
|
||||
For devices not included in these presets the infrared codes can be searched on the web.
|
||||
The [infrared article](/wiki/infrared.md) features a
|
||||
[list of available resources](/wiki/infrared.md#remote-controls).
|
||||
@ -0,0 +1,13 @@
|
||||
# Launcher
|
||||
|
||||
A launcher is the software that controls the home screen and app drawer on an
|
||||
[Android](/wiki/android.md) phone.
|
||||
|
||||
## Software Options
|
||||
|
||||
This section lists various possible launchers.
|
||||
|
||||
- [Kvaesitso](https://kvaesitso.mm20.de/) is a free and open-source launcher.
|
||||
It is available on [F-Droid](/wiki/android/f-droid.md) from its
|
||||
[repository](https://f-droid.org/de/packages/de.mm20.launcher2.release/).
|
||||
It focusses on a search but also has the option to label apps with tags.
|
||||
@ -0,0 +1,22 @@
|
||||
# LineageOS
|
||||
|
||||
[LineageOS](https://lineageos.org/) - or short Lineage - is a custom
|
||||
[Android](/wiki/android.md)-ROM and operating system for
|
||||
[Smartphones and Tablets](/wiki/smart_devices.md#smartphones-and-tablet-computers) with mostly free
|
||||
and open-source software.
|
||||
It was formerly known as CyanogenMod.
|
||||
|
||||
## Compatible Devices and Installation
|
||||
|
||||
Lineage is only available on specific devices that feature a maintained build of LineageOS.
|
||||
A list of compatible devices sorted by vendor can be found on the
|
||||
[official wiki](https://wiki.lineageos.org/devices/).
|
||||
|
||||
For installation navigate to the [official wiki](https://wiki.lineageos.org/devices/) and select
|
||||
the device LineageOS should be installed on.
|
||||
A guide will be available to help users in the process of installation.
|
||||
The device page also features any build file needed for the setup.
|
||||
If Google Services should be installed on the device close attention has to be payed in the guide
|
||||
section called "Installing Add-Ons".
|
||||
The Google Apps packages for Lineage can be downloaded from the
|
||||
[corresponding wiki page](https://wiki.lineageos.org/gapps/).
|
||||
@ -0,0 +1,9 @@
|
||||
# Bibliographic Software
|
||||
|
||||
A bibliographic software is software that manages a database of citation or bibliographic records.
|
||||
It produces citations for the stored records that are used in scholarly research.
|
||||
|
||||
## Software Solutions
|
||||
|
||||
- [Papis](/wiki/linux/papis.md) is a [command-line based](/wiki/linux/shell.md) for
|
||||
[Linux](/wiki/linux.md) bibliography manager that can be used for LaTeX using the BibTeX format.
|
||||
@ -0,0 +1,14 @@
|
||||
# Chameleon
|
||||
|
||||
[Chameleon](https://addons.mozilla.org/en-GB/firefox/addon/chameleon-ext/) is a
|
||||
[Firefox](/wiki/firefox.md) [add-on](/wiki/firefox.md#list-of-useful-firefox-add-ons) that spoofs
|
||||
your browser profile including user agent and screen size.
|
||||
It also can be used to change the [IP address](/wiki/ip_address.md)
|
||||
|
||||
## Spoofing the IP Address
|
||||
|
||||
This add-on can also be used to avoid [geo-blocking](/wiki/ip_address.md#geo-blocking) by selecting
|
||||
IP ranges in the `Headers` tab.
|
||||
The following are example ranges that work well for specific countries.
|
||||
|
||||
- Brazil: `124.81.64.0` to `124.81.127.255`
|
||||
@ -0,0 +1,23 @@
|
||||
# Discord
|
||||
|
||||
[Discord](https://discord.com/) is an social platform that combines voice and video conferences as
|
||||
well as instant messaging chats.
|
||||
|
||||
## Usage
|
||||
|
||||
This section addresses various features of Discord.
|
||||
|
||||
### Disable Automatic Update Checks
|
||||
|
||||
By default Discord performs an automatic check to see if it is up to date.
|
||||
On [Linux](/wiki/linux.md)-based systems it can be disabled by adding `"SKIP_HOST_UPDATE": true` to
|
||||
the `~/.config/discord/settings.json` file.
|
||||
|
||||
### Setting Up a Music Bot
|
||||
|
||||
For Discord there are various bots capable of playing music.
|
||||
The following is a list of bots featured in this wiki that can do this.
|
||||
|
||||
- [Sinusbot](/wiki/sinusbot.md) is a self-hosted bot for Discord that can play music and sounds.
|
||||
It's closed-source and free of charge.
|
||||
It also features [Teamspeak](/wiki/teamspeak.md) support.
|
||||
@ -0,0 +1,67 @@
|
||||
# alexjustesen - speedtest-tracker
|
||||
|
||||
This is a [Docker](/wiki/docker.md) container for a selfhosted internet speed
|
||||
tracker.
|
||||
The official container and documentation was made by
|
||||
[alexjustesen](https://github.com/alexjustesen/speedtest-tracker).
|
||||
|
||||
## Set-up
|
||||
|
||||
Create the file `rebuild.sh`.
|
||||
Change the settings according to your needs and run `./rebuild.sh` afterwards.
|
||||
It is important to set a correct app key as described in
|
||||
[the following section](#environment-variables).
|
||||
|
||||
### Environment-variables
|
||||
|
||||
Set the following variables with the -e tag.
|
||||
|
||||
| Name | Usage | Default |
|
||||
| -------------------- | -------------------------------------------------------------------------------------------------- | --------------- |
|
||||
| `APP_KEY` | This is used for encryption and can be generated by `echo -n 'base64:'; openssl rand -base64 32;` | |
|
||||
| `DB_CONNECTION` | Database connection type | |
|
||||
| `PGID` | Group ID | |
|
||||
| `PUID` | User ID | |
|
||||
| `APP_TIMEZONE` | Timezone of the app | `Europe/London` |
|
||||
| `DISPLAY_TIMEZONE` | Timezone of the display | `Europe/London` |
|
||||
| `SPEEDTEST_SCHEDULE` | Cron-formatted schedule for speedtest (`6 */6 * * *`: 6 minutes after every 6th hour) | |
|
||||
|
||||
### Volumes
|
||||
|
||||
Set the following volumes with the -v tag.
|
||||
|
||||
| Outside mount/volume name | Container mount | Description |
|
||||
| ------------------------- | --------------- | -------------------- |
|
||||
| `speedtest_config` | `/config` | storage for config |
|
||||
| `speedtest_keys` | `/config/keys` | storage for ssl keys |
|
||||
|
||||
### Ports
|
||||
|
||||
Set the following ports with the -p tag.
|
||||
|
||||
| Container Port | Recommended outside port | Protocol | Description |
|
||||
| -------------- | ------------------------ | -------- | ------------------------- |
|
||||
| `80` | `8765` | TCP | WebUI |
|
||||
| `443` | `` | TCP | SSL-encrypted WebUI |
|
||||
|
||||
### rebuild.sh
|
||||
|
||||
```sh
|
||||
#!/bin/sh
|
||||
docker stop speedtest
|
||||
docker rm speedtest
|
||||
docker pull lscr.io/linuxserver/speedtest-tracker:latest
|
||||
docker run --name speedtest \
|
||||
--restart unless-stopped \
|
||||
-p 8765:80 \
|
||||
-e PUID=1000 \
|
||||
-e PGID=1000 \
|
||||
-e APP_KEY="<generate>" \
|
||||
-e DB_CONNECTION=sqlite \
|
||||
-e SPEEDTEST_SCHEDULE="6 */6 * * *" \
|
||||
-e APP_TIMEZONE="Europe/Berlin" \
|
||||
-e DISPLAY_TIMEZONE="Europe/Berlin" \
|
||||
-v speedtest_config:/config \
|
||||
-v speedtest_keys:/config/keys \
|
||||
-d lscr.io/linuxserver/speedtest-tracker:latest
|
||||
```
|
||||
@ -0,0 +1,72 @@
|
||||
# coturn - coturn
|
||||
|
||||
This is a [Docker](/wiki/docker.md) container for a TURN/STUN server.
|
||||
A server like this can be used in a [Matrix](../matrix.md) server configuration.
|
||||
The official container and documentation was made by
|
||||
[coturn](https://github.com/coturn/coturn).
|
||||
This docker-rebuild is made up by a `docker-compose.yml` file.
|
||||
|
||||
## Set-up
|
||||
|
||||
Create the files `rebuild.sh`, `data/matrix/coturn/turnserver.conf` and `docker-compose.yml` at the
|
||||
same place.
|
||||
Change the settings according to your needs and run `./rebuild.sh` afterwards.
|
||||
For the `data/matrix/coturn/turnserver.conf` file change the values for `static-auth-secret`,
|
||||
`realm`, `cli-password` and `external-ip`.
|
||||
For the passwords [OpenSSL](/wiki/linux/openssl.md#password-generator) can be used to create a
|
||||
sufficiently random password.
|
||||
The value of `external-ip` consists of the local IP (left side) and the public IP (right side).
|
||||
To get the local IP the command `ip route get 1` can be used.
|
||||
For the public IP the command `curl api.ipify.org` can be used.
|
||||
|
||||
|
||||
### Ports
|
||||
|
||||
Set the following ports in the `ports:` section.
|
||||
|
||||
| Container Port | Recommended outside port | Protocol | Description |
|
||||
| -------------- | ------------------------ | -------- | ----------- |
|
||||
| `3478` | `3478` | TCP/UDP | TURN/STUN |
|
||||
| `5349` | `5349` | TCP/UDP | TURN/STUN |
|
||||
| `49152-65535` | `49152-65535` | UDP | TURN/STUN |
|
||||
|
||||
### rebuild.sh
|
||||
|
||||
```sh
|
||||
#!/bin/sh
|
||||
docker-compose down
|
||||
docker pull coturn/coturn:latest
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
### docker-compose.yml
|
||||
|
||||
```yml
|
||||
version: "2"
|
||||
services:
|
||||
coturn:
|
||||
image: "instrumentisto/coturn:latest"
|
||||
restart: "unless-stopped"
|
||||
volumes:
|
||||
- "./data/matrix/coturn/turnserver.conf:/etc/coturn/turnserver.conf"
|
||||
ports:
|
||||
- "49160-49200:49160-49200/udp"
|
||||
- "3478:3478"
|
||||
- "5349:5349"
|
||||
```
|
||||
|
||||
### data/matrix/coturn/turnserver.conf
|
||||
|
||||
```txt
|
||||
use-auth-secret
|
||||
static-auth-secret=SomeSecretPasswordForMatrix
|
||||
realm=matrix.example.com
|
||||
listening-port=3478
|
||||
tls-listening-port=5349
|
||||
min-port=49160
|
||||
max-port=49200
|
||||
verbose
|
||||
allow-loopback-peers
|
||||
cli-password=SomePasswordForCLI
|
||||
external-ip=192.168.0.2/123.123.123.123
|
||||
```
|
||||
@ -0,0 +1,97 @@
|
||||
# massivedecks - client
|
||||
|
||||
This is a [Docker](/wiki/docker.md) container for a [Massive Deecks](/wiki/games/massive_decks.md)
|
||||
client.
|
||||
Due to ease of use this entry will also feature the server container.
|
||||
The official container and documentation was made by
|
||||
[Lattyware](https://github.com/Lattyware/massivedecks).
|
||||
This docker-rebuild is made up by a `docker-compose.yml` file.
|
||||
In addition to the client and server containers a [postgres container](/wiki/docker/postgres.md)
|
||||
needs to be connected.
|
||||
|
||||
## Set-up
|
||||
|
||||
Create the files `rebuild.sh`, `.env` and `docker-compose.yml` at the same
|
||||
place.
|
||||
Make sure to set `POSTGRES_PASSWORD`.
|
||||
Change the settings according to your needs and run `./rebuild.sh` afterwards.
|
||||
|
||||
### Ports
|
||||
|
||||
Set the following ports in the `ports:` section.
|
||||
|
||||
| Container Port | Recommended outside port | Protocol | Description |
|
||||
| -------------- | ------------------------ | -------- | ----------- |
|
||||
| `8080` | `8080` | TCP | WebUI |
|
||||
|
||||
### Environment-variables
|
||||
|
||||
Set the following environment-variables in the `environment:` section of the
|
||||
docker-compose file.
|
||||
|
||||
| Name | Usage | Default |
|
||||
| ----------- | ----------------------- | ----------------- |
|
||||
| `NODE_ENV` | Setting the environment | `production` |
|
||||
|
||||
### rebuild.sh
|
||||
|
||||
```sh
|
||||
#!/bin/sh
|
||||
docker-compose down
|
||||
docker pull postgres:14
|
||||
docker pull ghcr.io/lattyware/massivedecks/server:latest-release
|
||||
docker pull ghcr.io/lattyware/massivedecks/client:latest-release
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
### docker-compose.yml
|
||||
|
||||
```yml
|
||||
version: "3.3"
|
||||
services:
|
||||
storage:
|
||||
image: "postgres:14"
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
- POSTGRES_USER=massivedecks
|
||||
- POSTGRES_PASSWORD=<password>
|
||||
networks:
|
||||
- internal
|
||||
volumes:
|
||||
- storage-volume:/var/lib/postgresql/data
|
||||
|
||||
server:
|
||||
image: "ghcr.io/lattyware/massivedecks/server:latest-release"
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
- NODE_ENV=production
|
||||
depends_on:
|
||||
- storage
|
||||
networks:
|
||||
- internal
|
||||
configs:
|
||||
- source: md_server_config
|
||||
target: /md/config.json5
|
||||
|
||||
client:
|
||||
image: "ghcr.io/lattyware/massivedecks/client:latest-release"
|
||||
restart: unless-stopped
|
||||
depends_on:
|
||||
- server
|
||||
networks:
|
||||
- internal
|
||||
ports:
|
||||
- "8080:8080"
|
||||
|
||||
networks:
|
||||
internal:
|
||||
external: false
|
||||
|
||||
volumes:
|
||||
storage-volume:
|
||||
driver: local
|
||||
|
||||
configs:
|
||||
md_server_config:
|
||||
external: true
|
||||
```
|
||||
@ -0,0 +1,116 @@
|
||||
# sinusbot - docker
|
||||
|
||||
This is a [Docker](/wiki/docker.md) container for a [Sinusbot](/wiki/sinusbot.md).
|
||||
The Server consists of a single Docker container.
|
||||
|
||||
## Set-up
|
||||
|
||||
Create the files `rebuild.sh` and `docker-compose.yml` at the same place.
|
||||
|
||||
The `docker-compose.yml` file includes a network section.
|
||||
This is only needed if the [Teamspeak](/wiki/teamspeak.md) server is set up on the same machine.
|
||||
If it is not the network `teamspeak` may be removed.
|
||||
If it Teamspeak and Sinusbot are set up on the same machine make sure to include the `teamspeak`
|
||||
network in the [Teamspeak Docker container](/wiki/docker/teamspeak.md) and set an alias.
|
||||
Include the follwing lines in your teamspeak `docker-compose.yml` file under the `teamspeak3`
|
||||
service.
|
||||
|
||||
```yml
|
||||
networks:
|
||||
teamspeak:
|
||||
aliases:
|
||||
- ts3.docker.local
|
||||
```
|
||||
|
||||
Add the following lines at the end of the `docker-compose.yml` or add it to the definition of
|
||||
already existing networks.
|
||||
|
||||
```yml
|
||||
networks:
|
||||
teamspeak:
|
||||
external: true
|
||||
```
|
||||
|
||||
Finally make sure to create the external network `teamspeak` before starting the containers.
|
||||
This can be done by running the following command.
|
||||
|
||||
```sh
|
||||
docker network create teamspeak
|
||||
```
|
||||
|
||||
The Teamspeak server can then be found by Sinusbot under host `ts3.docker.local` and port `9987`.
|
||||
|
||||
Change the other settings according to your needs and run `./rebuild.sh` afterwards.
|
||||
|
||||
### Environment-variables
|
||||
|
||||
Set the following environment-variables in the `environment:` section of the
|
||||
docker-compose file.
|
||||
|
||||
| Name | Usage | Default |
|
||||
| ----------- | ------------------------------ | ------- |
|
||||
| `UID` | User userid to run gitea | |
|
||||
| `GID` | User groupid to run gitea | |
|
||||
|
||||
### Volumes
|
||||
|
||||
Set the following volumes in the `volumes:` section of the docker-compose file.
|
||||
|
||||
| Outside mount/volume name | Container mount | Description |
|
||||
| ------------------------- | ----------------------- | ------------------------------------- |
|
||||
| `sinusbot_scripts` | `/opt/sinusbot/scripts` | storage for the sinusbot scripts |
|
||||
| `sinusbot_data` | `/opt/sinusbot/data` | storage for the most of sinusbot data |
|
||||
|
||||
### Ports
|
||||
|
||||
Set the following ports in the `ports:` section.
|
||||
|
||||
| Container Port | Recommended outside port | Protocol | Description |
|
||||
| -------------- | ------------------------ | -------- | ---------------------- |
|
||||
| `8087` | `8087` | TCP | WebUI |
|
||||
|
||||
### Networks
|
||||
|
||||
Set the following networks in the `networks:` section of the docker-compose file.
|
||||
|
||||
| Name | Usage |
|
||||
| ----------- | ---------------------------- |
|
||||
| `teamspeak` | connect with local teamspeak |
|
||||
|
||||
|
||||
### rebuild.sh
|
||||
|
||||
```sh
|
||||
#!/bin/sh
|
||||
docker-compose down
|
||||
docker pull sinusbot/docker:latest
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
### docker-compose.yml
|
||||
|
||||
```yml
|
||||
version: "3.3"
|
||||
services:
|
||||
sinusbot:
|
||||
image: "sinusbot/docker:latest"
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
- UID=1000
|
||||
- GID=1000
|
||||
networks:
|
||||
- teamspeak
|
||||
volumes:
|
||||
- sinusbot_scripts:/opt/sinusbot/scripts
|
||||
- sinusbot_data:/opt/sinusbot/data
|
||||
|
||||
networks:
|
||||
teamspeak:
|
||||
external: true
|
||||
|
||||
volumes:
|
||||
sinusbot_scripts:
|
||||
driver: local
|
||||
sinusbot_data:
|
||||
driver: local
|
||||
```
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in new issue