mirror of https://github.com/tiyn/wiki
TiynGER
2 years ago
commit
dd708095ad
@ -0,0 +1,31 @@
|
|||||||
|
# \*ARR
|
||||||
|
|
||||||
|
\*ARR application is a class of applications made as personal video recorders in
|
||||||
|
the usenet and [BitTorrent](/wiki/bittorrent.md) domain.
|
||||||
|
These applications include but are not limited to
|
||||||
|
[Sonarr](https://github.com/Sonarr/Sonarr) for
|
||||||
|
[TV shows](/wiki/movies_&_tv_shows.md),
|
||||||
|
[Radarr](https://github.com/Radarr/Radarr) for
|
||||||
|
[movies](/wiki/movies_&_tv_shows.md) and
|
||||||
|
[Lidarr](https://github.com/Lidarr/Lidarr) for [music](/wiki/audio.md).
|
||||||
|
|
||||||
|
## Setup
|
||||||
|
|
||||||
|
For the different applications there are different [Docker](/wiki/docker.md)
|
||||||
|
containers for setup:
|
||||||
|
[Linuxservers Sonarr image](/wiki/docker-images/linuxserver_-_sonarr.md),
|
||||||
|
[Linuxservers Radarr image](/wiki/docker-images/linuxserver_-_radarr.md) and
|
||||||
|
[Linuxservers Lidarr image](/wiki/docker-images/linuxserver_-_lidarr.md).
|
||||||
|
|
||||||
|
### Initial Configuration
|
||||||
|
|
||||||
|
For the initial configuration navigate to `System` and `Status`.
|
||||||
|
Afterwards check if there are any messages.
|
||||||
|
There are probably a few steps that need to be taken to complete the setup.
|
||||||
|
Set the `Download Clients` under `Settings`.
|
||||||
|
For this an instance of a [BitTorrent Client](/wiki/bittorrent.md#clients) can
|
||||||
|
be used.
|
||||||
|
Next an indexer needs to be added.
|
||||||
|
For this [Jackett](/wiki/jackett.md) can be used.
|
||||||
|
A guide to add Jackett indexers is featured in
|
||||||
|
[the Jackett entry](/wiki/jackett.md#adding-a-jackett-indexer-to-arr-applications).
|
||||||
@ -0,0 +1,49 @@
|
|||||||
|
# Airsonic-Advanced
|
||||||
|
|
||||||
|
[Airsonic-Advanced](https://github.com/airsonic-advanced/airsonic-advanced) is
|
||||||
|
a free and open-source personal media streamer used for
|
||||||
|
[music, podcasts and audiobooks](./audio.md).
|
||||||
|
It is a more modern implementation of [Airsonic](./airsonic.md) which in turn
|
||||||
|
is a fork of [Subsonic](./subsonic.md).
|
||||||
|
|
||||||
|
## Setup
|
||||||
|
|
||||||
|
The software can be setup via docker with the
|
||||||
|
[linuxserver image](./docker-images/linuxserver_-_airsonic-advanced.md).
|
||||||
|
|
||||||
|
### Initial configuration
|
||||||
|
|
||||||
|
The administration username after installation is `admin`.
|
||||||
|
The password is `admin` too.
|
||||||
|
After installing the server make sure to change this password.
|
||||||
|
If the password was changed there are two entries in the credentials table in
|
||||||
|
the credentials tab of the settings.
|
||||||
|
The first credential with id `0` uses the encoder plaintext which is
|
||||||
|
deprecated.
|
||||||
|
The second one with id `1` is the changed password which uses the encoder
|
||||||
|
bcrypt.
|
||||||
|
Make sure to delete the credential with id `0`.
|
||||||
|
This entry is not secure due to its encoder type.
|
||||||
|
When using clients as described in [the relating section](#clients) make sure
|
||||||
|
to set up the credentials according to the following instructions.
|
||||||
|
To make the clients log in work with the server store the Airsonic credentials
|
||||||
|
with a decodable encoder.
|
||||||
|
Select `Add credentials` and select `encrypted-AES-GCM` as encoder.
|
||||||
|
Type in the Airsonic password and confirm it and create the new credential.
|
||||||
|
Log in with the clients now works correctly.
|
||||||
|
|
||||||
|
### Clients
|
||||||
|
|
||||||
|
It is possible to use many different clients because the server is compatible
|
||||||
|
with all the Subsonic clients.
|
||||||
|
These can be found in the [Subsonic entry](./subsonic.md#clients).
|
||||||
|
|
||||||
|
## Scrobbling with Last.fm
|
||||||
|
|
||||||
|
To set up the scrobbling of music with Last.fm check
|
||||||
|
`Register what I'm playing at Last.fm` in the personal tab of the settings.
|
||||||
|
Following this the Last.fm credentials need to be added under the credentials
|
||||||
|
tab.
|
||||||
|
Select `Add credentials`, set the App to Last.fm and put in the Last.fm
|
||||||
|
password.
|
||||||
|
After the creation of credentials in this way the music will be scrobbled.
|
||||||
@ -1,17 +1,19 @@
|
|||||||
# Airsonic
|
# Airsonic
|
||||||
|
|
||||||
Airsonic is a free and open-source personal media streamer.
|
[Airsonic](https://github.com/airsonic/airsonic) is a free and open-source
|
||||||
It is a fork of [Subsonic](./subsonic.md) and thus is compatible with
|
personal media streamer used for [music,podcasts and audiobooks](./audio.md).
|
||||||
most of its clients.
|
It is a fork of [Subsonic](./subsonic.md).
|
||||||
|
Airsonic is not maintained anymore and therefore deprecated.
|
||||||
|
A more modern implementation of it is
|
||||||
|
[Airsonic-Advanced](./airsonic-advanced.md).
|
||||||
|
|
||||||
## Server
|
## Set up
|
||||||
|
|
||||||
A server can be setup via docker with the [linuxserver image](./docker-images/linuxserver_-_airsonic.md).
|
The software can be setup via [Docker](/wiki/docker.md) with the
|
||||||
|
[linuxserver image](./docker-images/linuxserver_-_airsonic.md).
|
||||||
|
|
||||||
## Client
|
### Clients
|
||||||
|
|
||||||
As already mentioned it is possible to use a bunch of different clients because
|
It is possible to use many different clients because the server is compatible
|
||||||
the server is compatible with most of the Subsonic clients.
|
with all the Subsonic clients.
|
||||||
|
These can be found in the [Subsonic entry](./subsonic.md#clients).
|
||||||
- [Ultrasonic](https://www.f-droid.org/en/packages/org.moire.ultrasonic) is a
|
|
||||||
free and open-source android subsonic/airsonic client.
|
|
||||||
|
|||||||
@ -0,0 +1,132 @@
|
|||||||
|
# Audio
|
||||||
|
|
||||||
|
Music, audiobooks and podcast are widely enjoyed.
|
||||||
|
There are multiple different approaches on how to get them onto your system
|
||||||
|
depending on your needs.
|
||||||
|
This entry describes how to handle audio data.
|
||||||
|
Music and Audiobooks can be obtained by buying the digital files or by
|
||||||
|
[extracting them off of a CD](#extract-audio-files-from-cds).
|
||||||
|
Podcasts need a so called Podcatcher.
|
||||||
|
A Podcatcher is used to subscribe to podcasts and download them automatically.
|
||||||
|
|
||||||
|
## Media Software
|
||||||
|
|
||||||
|
If you want to keep your system clean of much data, you can use this kind of
|
||||||
|
setup.
|
||||||
|
There are differences depending on your preffered software interface.
|
||||||
|
|
||||||
|
### Software for Music/Podcasts/Audiobooks
|
||||||
|
|
||||||
|
- [Subsonic](./subsonic.md) is a media streamer for music, podcasts and
|
||||||
|
audiobooks.
|
||||||
|
Subsonic is self-hostable.
|
||||||
|
Subsonic that can be dockerized and has a web-interface aswell as several
|
||||||
|
clients that can be used.
|
||||||
|
There are also the free and open-source implementations - that feature all the
|
||||||
|
same features and using its API - named [Airsonic](./airsonic.md) (no longer
|
||||||
|
maintained) and its inofficial successor [Airsonic-advanced](./airsonic.md).
|
||||||
|
|
||||||
|
### Software for Podcasts
|
||||||
|
|
||||||
|
- [Podgrab](./podgrab.md) is a free and open-source podcatcher that can also be
|
||||||
|
used to listen to them.
|
||||||
|
It is self-hostable and can be dockerized.
|
||||||
|
It has a web-interface and does not feature client software.
|
||||||
|
|
||||||
|
## Audio Formats
|
||||||
|
|
||||||
|
An audio format is an encoding of an audio file.
|
||||||
|
There are lossy and lossless formats, the latter not compromising quality for
|
||||||
|
smaller file sizes.
|
||||||
|
Following is a list of often used formats:
|
||||||
|
|
||||||
|
- wav is an uncompressed lossless format
|
||||||
|
- aiff is an uncompressed lossless format
|
||||||
|
- [flac](./flac_(codec).md) is a compressed lossless format
|
||||||
|
- alac is a compressed lossless format
|
||||||
|
- ape is a compressed lossless format
|
||||||
|
- mp3 is a compressed lossy codec
|
||||||
|
- aac is a compressed lossy codec
|
||||||
|
- wma is a compressed lossy codec
|
||||||
|
- ac3 is a compressed lossy codec usually found in DVDs
|
||||||
|
- dts is a compressed lossy codec usually found in DVDs
|
||||||
|
|
||||||
|
### Lossy and Lossless Formats and Their Conversion
|
||||||
|
|
||||||
|
Music files can either be encoded lossy or lossless.
|
||||||
|
Lossless formats can be converted from and to each other without loosing
|
||||||
|
information.
|
||||||
|
Lossless formats can also be converted to lossy formats to make the files
|
||||||
|
smaller and save space.
|
||||||
|
Files should not be converted to lossy formats more than once.
|
||||||
|
Additionally lossy formats should not be converted to lossless formats as it
|
||||||
|
increases the file size without adding any audio information.
|
||||||
|
These not recommended conversions are called bad conversions.
|
||||||
|
|
||||||
|
#### Detect Bad Conversions
|
||||||
|
|
||||||
|
The bitrate, format and the sample rate can be usually checked with simple
|
||||||
|
tools.
|
||||||
|
For Linux a simple software solution for this is the `file` command.
|
||||||
|
Running it will display these features of a given audio file.
|
||||||
|
This will however only display the format features.
|
||||||
|
Bad convserions as described in
|
||||||
|
[the previous section](#lossy-and-lossless-formats-and-their-conversion) can not
|
||||||
|
be detected by this.
|
||||||
|
A spectral analysis can detect bad conversions.
|
||||||
|
For this a audio analyzer like
|
||||||
|
[Sonic Visualizer](https://www.sonicvisualiser.org/) is needed.
|
||||||
|
Select a audio file and press `Add Spectogram` under `Layer`.
|
||||||
|
This will display a spectogram.
|
||||||
|
Music off of a retail CD and lossless songs have frequencies that extend up to
|
||||||
|
22kHz and can extend even further for hi-res music.
|
||||||
|
If the frequency extends up to at least 22kHz the file is lossless for sure.
|
||||||
|
If the frequency is cut before and the file is encoded in a lossless file it has
|
||||||
|
undergone a bad conversion and is not really lossless.
|
||||||
|
|
||||||
|
## Extract Audio Files from CDs
|
||||||
|
|
||||||
|
You can convert your CDs to files on your computer.
|
||||||
|
This way you don't have to search for your CDs all the time.
|
||||||
|
|
||||||
|
- [Exact Audio Copy](https://www.exactaudiocopy.de) for windows can rip music
|
||||||
|
and automatically tag it with the help of a list of databases.
|
||||||
|
- [metaflac](./linux/flac_(package).md) for linux is a programm
|
||||||
|
to edit the tags of [flac](./flac_(codec).md) files from the command line.
|
||||||
|
It is bundled in the `flac` package for debian and arch based systems.
|
||||||
|
- [MusicBrainz Picard](./picard.md) for linux is a
|
||||||
|
graphical user interface for tagging files of many different formats.
|
||||||
|
|
||||||
|
## Analysis of Different Versions of an Album
|
||||||
|
|
||||||
|
While deciding on what version of an album is the best visit
|
||||||
|
[Dynamic Range DB](https://dr.loudness-war.info).
|
||||||
|
It shows dynamic range scorings of each version.
|
||||||
|
|
||||||
|
## Get Additional Data to an Album/Single
|
||||||
|
|
||||||
|
If additional information for an album is needed, visit
|
||||||
|
[Discogs](https://www.discogs.com).
|
||||||
|
Discogs has tracklists, dates and more information to nearly all versions of
|
||||||
|
albums and singles.
|
||||||
|
|
||||||
|
## Naming Convention
|
||||||
|
|
||||||
|
It is suggested to place the audio files in a directory named after the album they
|
||||||
|
belong to.
|
||||||
|
These album directories are placed in directories named after the album artist.
|
||||||
|
Files can be named in the following scheme:
|
||||||
|
|
||||||
|
- music: `[<discnumber>.]<tracknumber>._<artist>_-_<title>`
|
||||||
|
- audiobooks: `[<discnumber>.]<tracknumber>._<artist>_-_<album>_<tracknumber>`
|
||||||
|
|
||||||
|
## Cue Files
|
||||||
|
|
||||||
|
`.cue` files act as a table of contents for a CD rip.
|
||||||
|
These can be created when the
|
||||||
|
[audio of a CD is extracted](#extract-audio-files-from-cds).
|
||||||
|
Usually this appears together with a single file for the whole CD.
|
||||||
|
The audio file can then be split according to the `.cue` file.
|
||||||
|
For splitting of `.flac` files on a Linux system check the
|
||||||
|
[a flac (package) entry](/wiki/linux/flac_(package).md#splitting-flac-file-according-to-cue-file)
|
||||||
|
for further informations.
|
||||||
@ -0,0 +1,200 @@
|
|||||||
|
# Bind
|
||||||
|
|
||||||
|
[Bind](https://www.isc.org/bind/) is an open-source software suite for
|
||||||
|
interacting with the [DNS](./dns.md).
|
||||||
|
|
||||||
|
## Setup
|
||||||
|
|
||||||
|
The software can be setup via docker with the
|
||||||
|
[ventz image](./docker-images/ventz_-_bind.md).
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
The following sections describe various use cases for Bind and how to set up
|
||||||
|
specific domains.
|
||||||
|
|
||||||
|
### Configure Local DNS server with forwarding
|
||||||
|
|
||||||
|
After setting up the server.
|
||||||
|
Look into the file `/etc/bind/named.conf.options`.
|
||||||
|
Change it to something like the following lines.
|
||||||
|
Note that `192.168.178.0/24` is the subnet that is used mainly in this example.
|
||||||
|
Only queries from within it will be handled.
|
||||||
|
The forwarders `8.8.8.8` and `8.8.4.4` can be changed according to the specific
|
||||||
|
needs.
|
||||||
|
|
||||||
|
```txt
|
||||||
|
acl "trusted" {
|
||||||
|
192.168.178.0/24;
|
||||||
|
localhost;
|
||||||
|
localnets;
|
||||||
|
};
|
||||||
|
|
||||||
|
options {
|
||||||
|
directory "/var/cache/bind";
|
||||||
|
listen-on-v6 { any; };
|
||||||
|
recursion yes; # enables resursive queries
|
||||||
|
allow-query { trusted; }; # allows recursive queries from "trusted" clients
|
||||||
|
allow-transfer { none; }; # disable zone transfers by default
|
||||||
|
|
||||||
|
forwarders {
|
||||||
|
8.8.8.8;
|
||||||
|
8.8.4.4;
|
||||||
|
};
|
||||||
|
forward only;
|
||||||
|
|
||||||
|
dnssec-enable yes;
|
||||||
|
dnssec-validation yes;
|
||||||
|
|
||||||
|
auth-nxdomain no;
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
### Configure local domains
|
||||||
|
|
||||||
|
This section explains how to add local domains for local systems.
|
||||||
|
It is explicitly compatible with the
|
||||||
|
[previous section](#setup-a-local-dns-server-with-forwarding).
|
||||||
|
Locate the `named.conf.local` file in the `/etc/bind` directory.
|
||||||
|
Add the forward zone first.
|
||||||
|
Substitute `<domain>` and `<tld>` to your wishes.
|
||||||
|
|
||||||
|
```txt
|
||||||
|
zone "<domain>.<tld>" IN {
|
||||||
|
type master;
|
||||||
|
file "/etc/bind/extra-zones/zone.<domain>.<tld>";
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
Then add the reverse zone.
|
||||||
|
The following lines assume the subnet is at `192.168.178.0/24`.
|
||||||
|
Note the reverse subnet address without the `.0/24` in the lines.
|
||||||
|
|
||||||
|
```txt
|
||||||
|
zone "178.168.192.in-addr.arpa" {
|
||||||
|
type master;
|
||||||
|
file "/etc/bind/extra-zones/revp.178.168.192";
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
Following this create the directory `/etc/bind/extra-zones/`.
|
||||||
|
Then place the file `zone.<domain>.<tld>` inside it with the following content:
|
||||||
|
|
||||||
|
```txt
|
||||||
|
$TTL 1D
|
||||||
|
@ IN SOA <domain>.<tld>. <thisserver>.<domain>.<tld> (
|
||||||
|
200405191 ; serial
|
||||||
|
8H ; refresh
|
||||||
|
4H ; retry
|
||||||
|
4W ; expire
|
||||||
|
1D ) ; minimum
|
||||||
|
@ NS <servername>
|
||||||
|
|
||||||
|
<servername> A <ip of server>
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
To make the server you operate on the nameserver select a subdomain for it and
|
||||||
|
subsitute `<servername>` for it and its IP address `<ip of server>`.
|
||||||
|
The following uses a filled in example with multiple subdomains.
|
||||||
|
It uses CNAME records as a placeholder for the ip.
|
||||||
|
In the last section the domain itself `home.server` is mapped to the ip
|
||||||
|
`192.168.178.16`.
|
||||||
|
This cannot be done with CNAME as `home.server` is already mapped as a
|
||||||
|
nameserver and assigning it multiple times is not supported.
|
||||||
|
|
||||||
|
```txt
|
||||||
|
$TTL 1D
|
||||||
|
@ IN SOA home.server. kenny.home.server (
|
||||||
|
200405191 ; serial
|
||||||
|
8H ; refresh
|
||||||
|
4H ; retry
|
||||||
|
4W ; expire
|
||||||
|
1D ) ; minimum
|
||||||
|
@ NS kenny
|
||||||
|
|
||||||
|
bag IN CNAME kenny
|
||||||
|
home IN CNAME kenny
|
||||||
|
links IN CNAME kenny
|
||||||
|
search IN CNAME kenny
|
||||||
|
speedtest IN CNAME kenny
|
||||||
|
sync.kenny IN CNAME kenny
|
||||||
|
www IN CNAME kenny
|
||||||
|
|
||||||
|
audio IN CNAME quentin
|
||||||
|
insta IN CNAME quentin
|
||||||
|
jelly IN CNAME quentin
|
||||||
|
media IN CNAME quentin
|
||||||
|
music IN CNAME quentin
|
||||||
|
plex IN CNAME quentin
|
||||||
|
reddit IN CNAME quentin
|
||||||
|
rss IN CNAME quentin
|
||||||
|
sync.quentin IN CNAME quentin
|
||||||
|
transmission IN CNAME quentin
|
||||||
|
tv IN CNAME quentin
|
||||||
|
twitter IN CNAME quentin
|
||||||
|
yt IN CNAME quentin
|
||||||
|
|
||||||
|
folding IN CNAME sheldon
|
||||||
|
|
||||||
|
home.server. IN A 192.168.178.16
|
||||||
|
localhost IN A 127.0.0.1
|
||||||
|
kenny IN A 192.168.178.16
|
||||||
|
mario IN A 192.168.178.15
|
||||||
|
quentin IN A 192.168.178.18
|
||||||
|
sheldon IN A 192.168.178.19
|
||||||
|
```
|
||||||
|
|
||||||
|
More [DNS records](./dns.md#records) can be added.
|
||||||
|
Most importantly used and needed for [reverse proxies](./reverse-proxy.md) are
|
||||||
|
[A records](./dns.md#a-record) and [CNAME records](./dns.md#cname-record).
|
||||||
|
|
||||||
|
Then create `/etc/bind/extra-zones/revp.178.168.192` and fill it with the
|
||||||
|
following lines.
|
||||||
|
|
||||||
|
```txt
|
||||||
|
$ORIGIN 178.168.192.in-addr.arpa.
|
||||||
|
$TTL 1D
|
||||||
|
@ IN SOA <domain>.<tld>. <thisserver>.<domain>.<tld>. (
|
||||||
|
200405190 ; serial
|
||||||
|
28800 ; refresh
|
||||||
|
14400 ; retry
|
||||||
|
2419200 ; expire
|
||||||
|
86400 ; minimum
|
||||||
|
)
|
||||||
|
@ IN NS <thisserver>.<domain>.<tld>.
|
||||||
|
|
||||||
|
<last part of ipv4> IN PTR <thisserver>.<domain>.<tld>.
|
||||||
|
```
|
||||||
|
|
||||||
|
Additionally add all domain names in front of the first `(` that have been
|
||||||
|
added in the `zone.<domain>.<tld>` file as an [A record](./dns.md#a-record).
|
||||||
|
Note that all these have to be followed by a `.` just like
|
||||||
|
`<thisserver>.<domain>.<tld>.` is.
|
||||||
|
For all these records add a PTR record too.
|
||||||
|
The first part of the PTR line is part of the IP address.
|
||||||
|
To get the full address add it to the subnet.
|
||||||
|
In this case this server has the IP `192.168.178.15`.
|
||||||
|
|
||||||
|
An example of `/etc/bind/extra-zones/revp.178.168.192` that is compatible with
|
||||||
|
the previous examples is shown in the following.
|
||||||
|
|
||||||
|
```txt
|
||||||
|
$ORIGIN 178.168.192.in-addr.arpa.
|
||||||
|
$TTL 1D
|
||||||
|
@ IN SOA home.server. kenny.home.server. (
|
||||||
|
200405190 ; serial
|
||||||
|
28800 ; refresh
|
||||||
|
14400 ; retry
|
||||||
|
2419200 ; expire
|
||||||
|
86400 ; minimum
|
||||||
|
)
|
||||||
|
@ IN NS kenny.home.server.
|
||||||
|
1 IN PTR fritz.box.
|
||||||
|
16 IN PTR kenny.home.server.
|
||||||
|
18 IN PTR quentin.home.server.
|
||||||
|
19 IN PTR sheldon.home.server.
|
||||||
|
```
|
||||||
|
|
||||||
|
According to your IPs and domains you may need to create multiple `revp.` or
|
||||||
|
`zone.` files and need to map them back to `named.conf.local`.
|
||||||
@ -0,0 +1,30 @@
|
|||||||
|
# BitTorrent
|
||||||
|
|
||||||
|
[BitTorrent](https://www.bittorrent.org) is a communication protocol for
|
||||||
|
peer-to-peer file sharing.
|
||||||
|
In BitTorrent context Leeching describes the process of only downloading a
|
||||||
|
file, seeding describes the download followed by also uploading it.
|
||||||
|
|
||||||
|
## Clients
|
||||||
|
|
||||||
|
There are various clients to use for BitTorrent down- and uploading.
|
||||||
|
The list below shows clients with an existing entry in this wiki.
|
||||||
|
|
||||||
|
- [Transmission](/wiki/transmission.md) is an easy to use client
|
||||||
|
- [qBittorrent](/wiki/qbittorrent.md) is a very feature rich client
|
||||||
|
|
||||||
|
## Personal Video Recorders
|
||||||
|
|
||||||
|
There are a bunch of applications intended as personal video recorders for
|
||||||
|
usenet or BitTorrent usage.
|
||||||
|
These include the so called [\*ARR applications](/wiki/*arr.md).
|
||||||
|
Usually an indexer application like [Jackett](/wiki/jackett.md) is needed.
|
||||||
|
|
||||||
|
## Legal Situation
|
||||||
|
|
||||||
|
This is not a legal advice.
|
||||||
|
Take your local laws into account when downloading torrents.
|
||||||
|
Some torrents can be copyright infringing and therefor illegal to download.
|
||||||
|
Only download legal and safe torrents like the
|
||||||
|
[Arch Linux ISO](/wiki/linux/arch-linux/arch-linux.md#iso-medium).
|
||||||
|
Seeding it can help the community.
|
||||||
@ -0,0 +1,11 @@
|
|||||||
|
# Calibre
|
||||||
|
|
||||||
|
[Calibre](https://calibre-ebook.com/) is a cross-platform, free and open-source
|
||||||
|
software suite for [e-book](/wiki/e-books.md) management.
|
||||||
|
It supports various formats aswell as conversion between them.
|
||||||
|
|
||||||
|
## Adding a Plugin
|
||||||
|
|
||||||
|
A plugin by a third party can be added by selecting a `.zip` archive - usually
|
||||||
|
named `<plugin name>_plugin.zip` - under Preferences, Plugins, Load plugin from
|
||||||
|
file.
|
||||||
@ -0,0 +1,51 @@
|
|||||||
|
# Cue sheet
|
||||||
|
|
||||||
|
A cue sheet is a metadata file containing information for the tracks of a CD or
|
||||||
|
a file [ripped](./audio.md#extract-audio-files-from-cds) from it.
|
||||||
|
|
||||||
|
## Example file
|
||||||
|
|
||||||
|
To understand the structure of a cue file the following lines show the contents
|
||||||
|
of an example cue file. All lines starting with `REM`, `PERFORMER` or `TITLE`
|
||||||
|
are optional. The following example is taken from the
|
||||||
|
[wikipedia article](https://en.wikipedia.org/wiki/Cue_sheet_(computing)):
|
||||||
|
|
||||||
|
```cue
|
||||||
|
REM GENRE Electronica
|
||||||
|
REM DATE 1998
|
||||||
|
PERFORMER "Faithless"
|
||||||
|
TITLE "Live in Berlin"
|
||||||
|
FILE "Faithless - Live in Berlin.mp3" MP3
|
||||||
|
TRACK 01 AUDIO
|
||||||
|
TITLE "Reverence"
|
||||||
|
PERFORMER "Faithless"
|
||||||
|
INDEX 01 00:00:00
|
||||||
|
TRACK 02 AUDIO
|
||||||
|
TITLE "She's My Baby"
|
||||||
|
PERFORMER "Faithless"
|
||||||
|
INDEX 01 06:42:00
|
||||||
|
TRACK 03 AUDIO
|
||||||
|
TITLE "Take the Long Way Home"
|
||||||
|
PERFORMER "Faithless"
|
||||||
|
INDEX 01 10:54:00
|
||||||
|
TRACK 04 AUDIO
|
||||||
|
TITLE "Insomnia"
|
||||||
|
PERFORMER "Faithless"
|
||||||
|
INDEX 01 17:04:00
|
||||||
|
TRACK 05 AUDIO
|
||||||
|
TITLE "Bring the Family Back"
|
||||||
|
PERFORMER "Faithless"
|
||||||
|
INDEX 01 25:44:00
|
||||||
|
TRACK 06 AUDIO
|
||||||
|
TITLE "Salva Mea"
|
||||||
|
PERFORMER "Faithless"
|
||||||
|
INDEX 01 30:50:00
|
||||||
|
TRACK 07 AUDIO
|
||||||
|
TITLE "Dirty Old Man"
|
||||||
|
PERFORMER "Faithless"
|
||||||
|
INDEX 01 38:24:00
|
||||||
|
TRACK 08 AUDIO
|
||||||
|
TITLE "God Is a DJ"
|
||||||
|
PERFORMER "Faithless"
|
||||||
|
INDEX 01 42:35:00
|
||||||
|
```
|
||||||
@ -1,15 +1,23 @@
|
|||||||
# Cups
|
# CUPS
|
||||||
|
|
||||||
## Server
|
[CUPS](https://www.cups.org/) is a open source printing software developed for
|
||||||
|
unix and unix-like systems.
|
||||||
|
|
||||||
A server can be setup via docker with the [linuxserver image](./docker-images/linuxserver_-_airsonic.md).
|
## Setup
|
||||||
|
|
||||||
## Client
|
The software can be setup via [Docker](/wiki/docker.md) with the
|
||||||
|
[linuxserver image](./docker-images/linuxserver_-_airsonic.md).
|
||||||
|
Additionally to this a client is needed on the system that need access to the
|
||||||
|
server software.
|
||||||
|
|
||||||
|
### Client
|
||||||
|
|
||||||
|
To use CUPS an additional client software is needed.
|
||||||
|
|
||||||
For Linux computers follow these instructions:
|
For Linux computers follow these instructions:
|
||||||
|
|
||||||
- Install the cups-client package (in Arch Linux it is included in `cups`)
|
- Install the CUPS-client package (in Arch Linux it is included in `cups`)
|
||||||
- Edit `/etc/cups/client.conf` and insert `ServerName <ip to print-server>:631`
|
- Edit `/etc/cups/client.conf` and insert `ServerName <ip to print-server>:631`
|
||||||
- Restart the cups service: `systemctl restart cups`
|
- Restart the CUPS service: `systemctl restart cups`
|
||||||
- Test connectivity: `lpstat -r`
|
- Test connectivity: `lpstat -r`
|
||||||
- Check the detected printers with: `lpstat -v`
|
- Check the detected printers with: `lpstat -v`
|
||||||
|
|||||||
@ -0,0 +1,55 @@
|
|||||||
|
# alexta69 - metube
|
||||||
|
|
||||||
|
This is a [Docker](/wiki/docker.md) container for a [MeTube](/wiki/metube.md)
|
||||||
|
server.
|
||||||
|
The official container and documentation was made by
|
||||||
|
[alexta69](https://github.com/alexta69/metube).
|
||||||
|
This docker-rebuild is made up by a `docker-compose.yml` file.
|
||||||
|
|
||||||
|
## Set-up
|
||||||
|
|
||||||
|
Create the files `rebuild.sh` and `docker-compose.yml` at the same place.
|
||||||
|
Change the settings according to your needs and run `./rebuild.sh` afterwards.
|
||||||
|
|
||||||
|
## Volumes
|
||||||
|
|
||||||
|
Set the following volumes in the `volumes:` section of the docker-compose file.
|
||||||
|
|
||||||
|
| Outside mount/volume name | Container mount | Description |
|
||||||
|
| ------------------------- | --------------- | ------------------------------------ |
|
||||||
|
| `downloads` | `/downloads` | folder to download data to |
|
||||||
|
|
||||||
|
## Ports
|
||||||
|
|
||||||
|
Set the following ports in the `ports:` section.
|
||||||
|
|
||||||
|
| Container Port | Recommended outside port | Protocol | Description |
|
||||||
|
| -------------- | ------------------------ | -------- | ----------- |
|
||||||
|
| `8881` | `8081` | TCP | WebUI |
|
||||||
|
|
||||||
|
## rebuild.sh
|
||||||
|
|
||||||
|
```sh
|
||||||
|
#!/bin/sh
|
||||||
|
docker-compose down
|
||||||
|
docker pull vim alexta69/metube
|
||||||
|
docker-compose up -d
|
||||||
|
```
|
||||||
|
|
||||||
|
## docker-compose.yml
|
||||||
|
|
||||||
|
```yml
|
||||||
|
version: "3"
|
||||||
|
services:
|
||||||
|
metube:
|
||||||
|
image: alexta69/metube
|
||||||
|
restart: unless-stopped
|
||||||
|
ports:
|
||||||
|
- "8881:8081"
|
||||||
|
volumes:
|
||||||
|
- downloads:/downloads
|
||||||
|
|
||||||
|
volumes:
|
||||||
|
downloads:
|
||||||
|
driver: local
|
||||||
|
```
|
||||||
@ -0,0 +1,51 @@
|
|||||||
|
# axhilrex - podgrab
|
||||||
|
|
||||||
|
This is a [Docker](/wiki/docker.md) container for a [Podgrab](../podgrab.md)
|
||||||
|
server.
|
||||||
|
The official container and documentation was made by
|
||||||
|
[axhilrex](https://github.com/akhilrex/podgrab).
|
||||||
|
|
||||||
|
## 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 |
|
||||||
|
| ---------- | ----------------------------- | ------- |
|
||||||
|
| `PASSWORD` | Password for `podgrab` user | |
|
||||||
|
|
||||||
|
## Volumes
|
||||||
|
|
||||||
|
Set the following volumes with the -v tag.
|
||||||
|
|
||||||
|
| Outside mount/volume name | Container mount | Description |
|
||||||
|
| ------------------------- | --------------- | ----------------------- |
|
||||||
|
| `podgrab_config` | `/config` | Configuration files |
|
||||||
|
| `media_podcasts` | `/assets` | location for podcasts |
|
||||||
|
|
||||||
|
## Ports
|
||||||
|
|
||||||
|
Set the following ports with the -p tag.
|
||||||
|
|
||||||
|
| Container Port | Recommended outside port | Protocol | Description |
|
||||||
|
| -------------- | ------------------------ | -------- | ----------- |
|
||||||
|
| `8080` | `8080` | TCP | WebUI |
|
||||||
|
|
||||||
|
## rebuild.sh
|
||||||
|
|
||||||
|
```sh
|
||||||
|
#!/bin/sh
|
||||||
|
docker stop podgrab
|
||||||
|
docker rm podgrab
|
||||||
|
docker pull akhilrex/podgrab
|
||||||
|
docker run --name=podgrab \
|
||||||
|
--restart unless-stopped \
|
||||||
|
-p 8000:8080 \
|
||||||
|
-v "media_podcasts:/assets" \
|
||||||
|
-v "podgrab_config:/config" \
|
||||||
|
-d akhilrex/podgrab
|
||||||
|
```
|
||||||
@ -0,0 +1,69 @@
|
|||||||
|
# benbusby - whoogle-search
|
||||||
|
|
||||||
|
This is a [Docker](/wiki/docker.md) container for a [whoogle](../whoogle.md)
|
||||||
|
meta-search machine.
|
||||||
|
The official container and documentation was made by
|
||||||
|
[benbusby](https://github.com/benbusby/whoogle-search).
|
||||||
|
|
||||||
|
## Set-up
|
||||||
|
|
||||||
|
First of all create a folder for your `rebuild.sh`.
|
||||||
|
After that clone whoogle from
|
||||||
|
[github](https://github.com/benbusby/whoogle-search) into a folder within the
|
||||||
|
just created folder.
|
||||||
|
You can find the `docker-compose.yml` in the cloned directory.
|
||||||
|
Set the variables, volumes and ports according and run the `rebuild.sh`.
|
||||||
|
|
||||||
|
## Volumes
|
||||||
|
|
||||||
|
Set the following volumes with the -v tag.
|
||||||
|
|
||||||
|
| Outside mount/volume name | Container mount | Description |
|
||||||
|
| ------------------------- | ---------------- | ---------------- |
|
||||||
|
| `searx_config` | `/config` | configurations |
|
||||||
|
|
||||||
|
## Ports
|
||||||
|
|
||||||
|
Set the following ports with the -p tag.
|
||||||
|
|
||||||
|
| Container Port | Recommended outside port | Protocol | Description |
|
||||||
|
| -------------- | ------------------------ | -------- | ----------- |
|
||||||
|
| `5000` | `8000` | TCP | WebUI |
|
||||||
|
|
||||||
|
## rebuild.sh
|
||||||
|
|
||||||
|
```sh
|
||||||
|
#!/bin/sh
|
||||||
|
cd whoogle-search
|
||||||
|
docker-compose down
|
||||||
|
docker-compose up -d
|
||||||
|
cd ..
|
||||||
|
```
|
||||||
|
|
||||||
|
## docker-compose.yml
|
||||||
|
|
||||||
|
```yml
|
||||||
|
version: "2.2"
|
||||||
|
|
||||||
|
services:
|
||||||
|
whoogle-search:
|
||||||
|
image: ${WHOOGLE_IMAGE:-benbusby/whoogle-search}
|
||||||
|
container_name: whoogle-search
|
||||||
|
restart: unless-stopped
|
||||||
|
user: whoogle
|
||||||
|
security_opt:
|
||||||
|
- no-new-privileges
|
||||||
|
cap_drop:
|
||||||
|
- ALL
|
||||||
|
tmpfs:
|
||||||
|
- /config/:size=10M,uid=927,gid=927,mode=1700
|
||||||
|
- /var/lib/tor/:size=15M,uid=927,gid=927,mode=1700
|
||||||
|
- /run/tor/:size=1M,uid=927,gid=927,mode=1700
|
||||||
|
volumes:
|
||||||
|
- config:/config
|
||||||
|
ports:
|
||||||
|
- 8000:5000
|
||||||
|
|
||||||
|
volumes:
|
||||||
|
config:
|
||||||
|
```
|
||||||
@ -0,0 +1,64 @@
|
|||||||
|
# bilde2910 - Hauk
|
||||||
|
|
||||||
|
This is a docker container for a [Hauk](../hauk.md).
|
||||||
|
|
||||||
|
## Set-up
|
||||||
|
|
||||||
|
Create the files `rebuild.sh` and `docker-compose.yml` at the same place.
|
||||||
|
Additionally create a `config.php` file based on the
|
||||||
|
[config-sample](https://github.com/bilde2910/Hauk/blob/master/backend-php/include/config-sample.php)
|
||||||
|
at the location specified in your `docker-compose.yml` (in this example it's
|
||||||
|
`./config/hauk`).
|
||||||
|
Change the config according to your needs.
|
||||||
|
Do not change anything starting with `memcached` inside the `config.php`.
|
||||||
|
Most importantly set the `public_url` correctly.
|
||||||
|
For a simple multi-user setup set `auth_method` to `HTPASSWD`.
|
||||||
|
Then inside the same folder of `config.php` run the following command to setup
|
||||||
|
the first and optionally more users.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
htpasswd -cBC 10 /etc/hauk/users.htpasswd <first user name>
|
||||||
|
htpasswd -BC 10 /etc/hauk/users.htpasswd <other user name>
|
||||||
|
```
|
||||||
|
|
||||||
|
Finally run `./rebuild.sh`.
|
||||||
|
|
||||||
|
## Volumes
|
||||||
|
|
||||||
|
Set the following volumes in the `volumes:` section of the docker-compose file.
|
||||||
|
|
||||||
|
| Outside mount/volume name | Container mount | Description |
|
||||||
|
| ------------------------- | ------------------ | ------------------------------ |
|
||||||
|
| `./config/hauk` | `/etc/hauk` | config and password location |
|
||||||
|
|
||||||
|
## Ports
|
||||||
|
|
||||||
|
Set the following ports in the `ports:` section.
|
||||||
|
|
||||||
|
| Container Port | Recommended outside port | Protocol | Description |
|
||||||
|
| -------------- | ------------------------ | -------- | ---------------------- |
|
||||||
|
| `80` | `80` | TCP | Basic service |
|
||||||
|
|
||||||
|
## rebuild.sh
|
||||||
|
|
||||||
|
```sh
|
||||||
|
#!/bin/sh
|
||||||
|
docker-compose down
|
||||||
|
docker pull bilde2910/hauk
|
||||||
|
docker-compose up -d
|
||||||
|
```
|
||||||
|
|
||||||
|
## docker-compose.yml
|
||||||
|
|
||||||
|
```yml
|
||||||
|
version: "2"
|
||||||
|
|
||||||
|
services:
|
||||||
|
hauk:
|
||||||
|
image: bilde2910/hauk
|
||||||
|
restart: unless-stopped
|
||||||
|
volumes:
|
||||||
|
- ./config/hauk:/etc/hauk
|
||||||
|
ports:
|
||||||
|
- "80:80"
|
||||||
|
```
|
||||||
@ -0,0 +1,120 @@
|
|||||||
|
# chocobozz - peertube
|
||||||
|
|
||||||
|
This is a [Docker](/wiki/docker.md) container for a [PeerTube](../peertube.md)
|
||||||
|
server.
|
||||||
|
The official container and documentation was made by
|
||||||
|
[chocobozz](https://github.com/chocobozzz/peertube).
|
||||||
|
This docker-rebuild is made up by a `docker-compose.yml` file.
|
||||||
|
In addition to the main container you need to connect a
|
||||||
|
[redis container](./redis.md) 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.
|
||||||
|
|
||||||
|
## Ports
|
||||||
|
|
||||||
|
Set the following ports in the `ports:` section.
|
||||||
|
|
||||||
|
| Container Port | Recommended outside port | Protocol | Description |
|
||||||
|
| -------------- | ------------------------ | -------- | ----------- |
|
||||||
|
| `9000` | `9000` | TCP | WebUI |
|
||||||
|
|
||||||
|
## Volumes
|
||||||
|
|
||||||
|
Set the following volumes with the -v tag.
|
||||||
|
|
||||||
|
| Outside mount/volume name | Container mount | Description |
|
||||||
|
| ------------------------- | -------------------------- | ---------------------- |
|
||||||
|
| `assets` | `/app/client/dist` | storage for icons, etc |
|
||||||
|
| `config` | `/config` | configuration data |
|
||||||
|
| `data` | `/data` | further data storage |
|
||||||
|
|
||||||
|
## rebuild.sh
|
||||||
|
|
||||||
|
```sh
|
||||||
|
#!/bin/sh
|
||||||
|
docker-compose down
|
||||||
|
docker-compose up -d
|
||||||
|
```
|
||||||
|
|
||||||
|
## .env
|
||||||
|
|
||||||
|
```txt
|
||||||
|
TZ="Europe/Berlin"
|
||||||
|
|
||||||
|
PT_INITIAL_ROOT_PASSWORD=<root password>
|
||||||
|
PEERTUBE_ADMIN_EMAIL=<admin email>
|
||||||
|
PEERTUBE_WEBSERVER_HOSTNAME=<domain>
|
||||||
|
PEERTUBE_WEBSERVER_PORT=<port>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
POSTGRES_USER=peertube
|
||||||
|
POSTGRES_PASSWORD=<postgres password>
|
||||||
|
POSTGRES_DB=peertube
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
PEERTUBE_DB_USERNAME=peertube
|
||||||
|
PEERTUBE_DB_PASSWORD=<db password>
|
||||||
|
PEERTUBE_DB_SSL=false
|
||||||
|
PEERTUBE_DB_HOSTNAME=postgres
|
||||||
|
|
||||||
|
PEERTUBE_TRUST_PROXY=["127.0.0.1", "loopback", "172.18.0.0/16"]
|
||||||
|
|
||||||
|
# E-mail configuration
|
||||||
|
PEERTUBE_SMTP_USERNAME=<smtp email>
|
||||||
|
PEERTUBE_SMTP_PASSWORD=<smtp password>
|
||||||
|
PEERTUBE_SMTP_HOSTNAME=mail.<domain>
|
||||||
|
PEERTUBE_SMTP_PORT=587
|
||||||
|
PEERTUBE_SMTP_FROM=<smtp email>
|
||||||
|
PEERTUBE_SMTP_TLS=false
|
||||||
|
PEERTUBE_SMTP_DISABLE_STARTTLS=false
|
||||||
|
```
|
||||||
|
|
||||||
|
## docker-compose.yml
|
||||||
|
|
||||||
|
```yml
|
||||||
|
version: "3.3"
|
||||||
|
|
||||||
|
services:
|
||||||
|
|
||||||
|
peertube:
|
||||||
|
image: chocobozzz/peertube:production-bullseye
|
||||||
|
ports:
|
||||||
|
- "9000:9000"
|
||||||
|
env_file:
|
||||||
|
- .env
|
||||||
|
volumes:
|
||||||
|
- assets:/app/client/dist
|
||||||
|
- data:/data
|
||||||
|
- config:/config
|
||||||
|
depends_on:
|
||||||
|
- postgres
|
||||||
|
- redis
|
||||||
|
restart: unless-stopped
|
||||||
|
|
||||||
|
postgres:
|
||||||
|
image: postgres:13-alpine
|
||||||
|
env_file:
|
||||||
|
- .env
|
||||||
|
volumes:
|
||||||
|
- db:/var/lib/postgresql/data
|
||||||
|
restart: unless-stopped
|
||||||
|
|
||||||
|
redis:
|
||||||
|
image: redis:6-alpine
|
||||||
|
volumes:
|
||||||
|
- redis:/data
|
||||||
|
restart: unless-stopped
|
||||||
|
|
||||||
|
volumes:
|
||||||
|
assets:
|
||||||
|
data:
|
||||||
|
config:
|
||||||
|
db:
|
||||||
|
redis:
|
||||||
|
```
|
||||||
@ -0,0 +1,54 @@
|
|||||||
|
# dyonr - jackettvpn
|
||||||
|
|
||||||
|
This is a [Docker](/wiki/docker.md) container for a [VPN](/wiki/vpn.md)
|
||||||
|
protected [Jackett](/wiki/jackett.md) server.
|
||||||
|
The official container and documentation was made by
|
||||||
|
[dyonr](https://github.com/DyonR/docker-Jackettvpn).
|
||||||
|
|
||||||
|
## Set-up
|
||||||
|
|
||||||
|
Create the file `rebuild.sh` and set `<username>` and `<password>` according to
|
||||||
|
your openvpn.
|
||||||
|
Additionally change the `LAN_NETWORK` if it differs for your local area network.
|
||||||
|
Run `./rebuild.sh` afterwards to create the volumes.
|
||||||
|
Place the openvpn certificate in the `jacket_config` docker volume inside the
|
||||||
|
`openvpn` folder.
|
||||||
|
After that rerun `./rebuild.sh` to make update your config.
|
||||||
|
|
||||||
|
## Volumes
|
||||||
|
|
||||||
|
Set the following volumes with the -v tag.
|
||||||
|
|
||||||
|
| Outside mount/volume name | Container mount | Description |
|
||||||
|
| ------------------------- | --------------- | ---------------------- |
|
||||||
|
| `jackett_config` | `/config` | storage for configs |
|
||||||
|
| `jackett_blackhole` | `/blackhole` | storage for magnets |
|
||||||
|
|
||||||
|
## Ports
|
||||||
|
|
||||||
|
Set the following ports with the -p tag.
|
||||||
|
|
||||||
|
| Container Port | Recommended outside port | Protocol | Description |
|
||||||
|
| -------------- | ------------------------ | -------- | ----------- |
|
||||||
|
| `9117` | `9117` | TCP | WebUI |
|
||||||
|
|
||||||
|
## rebuild.sh
|
||||||
|
|
||||||
|
```sh
|
||||||
|
docker stop jackett
|
||||||
|
docker rm jackett
|
||||||
|
docker pull dyonr/jackettvpn
|
||||||
|
docker run --name jackett \
|
||||||
|
--restart unless-stopped \
|
||||||
|
-p 9117:9117 \
|
||||||
|
-v jackett_config:/config \
|
||||||
|
-v jackett_blackhole:/blackhole \
|
||||||
|
-e "VPN_ENABLED=yes" \
|
||||||
|
-e "VPN_TYPE=openvpn" \
|
||||||
|
-e "VPN_USERNAME=<username>" \
|
||||||
|
-e "VPN_PASSWORD=<password>" \
|
||||||
|
-e "LAN_NETWORK=192.168.178.0/24" \
|
||||||
|
--privileged \
|
||||||
|
-d dyonr/jackettvpn
|
||||||
|
|
||||||
|
```
|
||||||
@ -0,0 +1,76 @@
|
|||||||
|
# dyonr - qbittorrentvpn
|
||||||
|
|
||||||
|
This is a [Docker](/wiki/docker.md) container for a
|
||||||
|
[qBittorrent](../qbittorrent.md) server that is connected to the internet via
|
||||||
|
an [openVPN tunnel](/wiki/vpn.md).
|
||||||
|
The official container and documentation was made by
|
||||||
|
[dyonr](https://github.com/DyonR/docker-qbittorrentvpn).
|
||||||
|
|
||||||
|
## Set-up
|
||||||
|
|
||||||
|
Create the file `rebuild.sh`.
|
||||||
|
Change the settings according to your needs and run `./rebuild.sh` afterwards.
|
||||||
|
The default username of the web interface is `admin`.
|
||||||
|
The default password is `adminadmin`.
|
||||||
|
Both can be changed in the web interface after setup.
|
||||||
|
|
||||||
|
## Environment-variables
|
||||||
|
|
||||||
|
Set the following variables with the -e tag.
|
||||||
|
|
||||||
|
| Name | Usage | Default |
|
||||||
|
| ------------------- | --------------------------- | ------- |
|
||||||
|
| `VPN_ENABLE` | Enable VPN | ` ` |
|
||||||
|
| `VPN_USERNAME` | Username for OpenVPN | ` ` |
|
||||||
|
| `VPN_PASSWORD` | Password for OpenVPN | ` ` |
|
||||||
|
| `LAN_NETWORK` | Subnet of the local network | ` ` |
|
||||||
|
|
||||||
|
## Volumes
|
||||||
|
|
||||||
|
Set the following volumes with the -v tag.
|
||||||
|
|
||||||
|
| Outside mount/volume name | Container mount | Description |
|
||||||
|
| ------------------------- | ------------------- | ----------------------- |
|
||||||
|
| `qbittorrentvpn_config` | `/config` | Configuration files |
|
||||||
|
| `qbittorrentvpn_data` | `/downloads` | Storage for data |
|
||||||
|
|
||||||
|
## Ports
|
||||||
|
|
||||||
|
Set the following ports with the -p tag.
|
||||||
|
|
||||||
|
| Container Port | Recommended outside port | Protocol | Description |
|
||||||
|
| -------------- | ------------------------ | -------- | ----------- |
|
||||||
|
| `9091` | `8080` | TCP | WebUI |
|
||||||
|
|
||||||
|
## Additional
|
||||||
|
|
||||||
|
There are some special variables to set.
|
||||||
|
|
||||||
|
| Flag | Usage |
|
||||||
|
| ----------- | ---------------------- |
|
||||||
|
| `--cap-add` | add linux capabilities |
|
||||||
|
| `--device` | connect devices |
|
||||||
|
| `--sysctl` | configure systemctl |
|
||||||
|
|
||||||
|
## rebuild.sh
|
||||||
|
|
||||||
|
```sh
|
||||||
|
#!/bin/sh
|
||||||
|
docker stop qbittorrentvpn
|
||||||
|
docker rm qbittorrentvpn
|
||||||
|
docker pull dyonr/qbittorrentvpn
|
||||||
|
docker run --name qbittorrentvpn \
|
||||||
|
--restart unless-stopped \
|
||||||
|
-p 9091:8080 \
|
||||||
|
-v qbittorrentvpn_config:/config \
|
||||||
|
-v qbittorrentvpn_data:/downloads \
|
||||||
|
-e "VPN_ENABLED=yes" \
|
||||||
|
-e "VPN_TYPE=openvpn" \
|
||||||
|
-e "VPN_USERNAME=username" \
|
||||||
|
-e "VPN_PASSWORD=password" \
|
||||||
|
-e "LAN_NETWORK=192.168.0.0/16" \
|
||||||
|
--cap-add NET_ADMIN \
|
||||||
|
--device /dev/net/tun \
|
||||||
|
--sysctl "net.ipv4.conf.all.src_valid_mark=1" \
|
||||||
|
-d dyonr/qbittorrentvpn
|
||||||
|
```
|
||||||
@ -0,0 +1,71 @@
|
|||||||
|
# haugene - transmission-openvpn
|
||||||
|
|
||||||
|
This is a [Docker](/wiki/docker.md) container for a
|
||||||
|
[transmission](../transmission.md) server that is connected to the internet via
|
||||||
|
an [openVPN tunnel](/wiki/vpn.md).
|
||||||
|
The official container and documentation was made by
|
||||||
|
[haugene](https://github.com/haugene/docker-transmission-openvpn).
|
||||||
|
|
||||||
|
## Set-up
|
||||||
|
|
||||||
|
Create the file `rebuild.sh`.
|
||||||
|
To see which providers are supported take a look at the
|
||||||
|
[official documentation](https://haugene.github.io/docker-transmission-openvpn/supported-providers/).
|
||||||
|
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 |
|
||||||
|
| ------------------- | --------------------------- | ------- |
|
||||||
|
| `OPENVPN_PROVIDER` | Provider for OpenVPN | ` ` |
|
||||||
|
| `OPENVPN_USERNAME` | Username for OpenVPN | ` ` |
|
||||||
|
| `OPENVPN_PASSWORD` | Password for OpenVPN | ` ` |
|
||||||
|
| `LOCAL_NETWORK` | Subnet of the local network | ` ` |
|
||||||
|
| `CREATE_TUN_DEVICE` | Use a tunnel device | ` ` |
|
||||||
|
| `WEBPROXY_ENABLES` | Use a webproxy | ` ` |
|
||||||
|
|
||||||
|
## Volumes
|
||||||
|
|
||||||
|
Set the following volumes with the -v tag.
|
||||||
|
|
||||||
|
| Outside mount/volume name | Container mount | Description |
|
||||||
|
| ------------------------- | --------------- | ----------------------- |
|
||||||
|
| `transmission_config` | `/config` | Configuration files |
|
||||||
|
| `transmission data` | `/data` | Storage for data |
|
||||||
|
| `/etc/localtime` | `/etc/localtime:ro` | Link to the systemtime |
|
||||||
|
|
||||||
|
## Ports
|
||||||
|
|
||||||
|
Set the following ports with the -p tag.
|
||||||
|
|
||||||
|
| Container Port | Recommended outside port | Protocol | Description |
|
||||||
|
| -------------- | ------------------------ | -------- | ----------- |
|
||||||
|
| `9091` | `9091` | TCP | WebUI |
|
||||||
|
|
||||||
|
## rebuild.sh
|
||||||
|
|
||||||
|
```sh
|
||||||
|
#!/bin/sh
|
||||||
|
docker stop transmission
|
||||||
|
docker rm transmission
|
||||||
|
docker pull haugene/transmission-openvpn
|
||||||
|
docker run --name transmission \
|
||||||
|
--restart unless-stopped \
|
||||||
|
--cap-add NET_ADMIN \
|
||||||
|
-v /etc/localtime:/etc/localtime:ro \
|
||||||
|
-v transmission_data:/data \
|
||||||
|
-v transmission_config:/config \
|
||||||
|
-e OPENVPN_PROVIDER=<vpn provider> \
|
||||||
|
-e OPENVPN_CONFIG=<vpn_-_country-udp> \
|
||||||
|
-e OPENVPN_USERNAME=<username> \
|
||||||
|
-e OPENVPN_PASSWORD=<password> \
|
||||||
|
-e LOCAL_NETWORK=192.168.178.0/24 \
|
||||||
|
-e CREATE_TUN_DEVICE=true \
|
||||||
|
-e WEBPROXY_ENABLES=false \
|
||||||
|
--log-driver json-file \
|
||||||
|
--log-opt max-size=50m \
|
||||||
|
-p 9091:9091 \
|
||||||
|
-d haugene/transmission-openvpn
|
||||||
|
```
|
||||||
@ -0,0 +1,68 @@
|
|||||||
|
# jonohill - docker-openvpn-proxy
|
||||||
|
|
||||||
|
This is a [Docker](/wiki/docker.md) container for an
|
||||||
|
[OpenVPN proxy](/wiki/vpn.md#proxy).
|
||||||
|
The official container and documentation was made by
|
||||||
|
[jonohill](https://github.com/jonohill/docker-openvpn-proxy).
|
||||||
|
|
||||||
|
## Set-up
|
||||||
|
|
||||||
|
Create the file `rebuild.sh`.
|
||||||
|
Change the settings according to your needs and run `./rebuild.sh` afterwards.
|
||||||
|
|
||||||
|
## Volumes
|
||||||
|
|
||||||
|
Set the following volumes with the -v tag.
|
||||||
|
|
||||||
|
| Outside mount/volume name | Container mount | Description |
|
||||||
|
| ------------------------- | --------------- | ------------------------ |
|
||||||
|
| `ovpn-proxy` | `/config` | storage for openvpn data |
|
||||||
|
|
||||||
|
## Ports
|
||||||
|
|
||||||
|
Set the following ports with the -p tag.
|
||||||
|
|
||||||
|
| Container Port | Recommended outside port | Protocol | Description |
|
||||||
|
| -------------- | ------------------------ | -------- | ------------ |
|
||||||
|
| `9050` | `8080` | HTTP | proxy port |
|
||||||
|
|
||||||
|
## Environment-variables
|
||||||
|
|
||||||
|
Set the following variables with the -e tag.
|
||||||
|
|
||||||
|
| Name | Usage | Default |
|
||||||
|
| ------------------- | --------------------------- | ------- |
|
||||||
|
| `LOCAL_NETWORK` | Set local network subnet | ` ` |
|
||||||
|
| `OPENVPN_USERNAME` | username for OpenVPN | ` ` |
|
||||||
|
| `OPENVPN_PASSWORD` | password for OpenVPN | ` ` |
|
||||||
|
|
||||||
|
## Additional
|
||||||
|
|
||||||
|
There are some special variables to set.
|
||||||
|
|
||||||
|
| Flag | Usage |
|
||||||
|
| ----------- | ---------------------- |
|
||||||
|
| `--cap-add` | add linux capabilities |
|
||||||
|
| `--device` | connect devices |
|
||||||
|
| `--sysctl` | configure systemctl |
|
||||||
|
|
||||||
|
## rebuild.sh
|
||||||
|
|
||||||
|
```sh
|
||||||
|
#!/bin/sh
|
||||||
|
docker stop openvpn-proxy
|
||||||
|
docker rm openvpn-proxy
|
||||||
|
docker pull jonoh/openvpn-proxy
|
||||||
|
docker run --name openvpn-proxy \
|
||||||
|
--restart unless-stopped \
|
||||||
|
-p "9050:8080" \
|
||||||
|
-v "openvpn-proxy:/config" \
|
||||||
|
-e LOCAL_NETWORK=192.168.178.0/24 \
|
||||||
|
-e OPENVPN_USERNAME="<OVPN_USERNAME>" \
|
||||||
|
-e OPENVPN_PASSWORD="<OVPN_PASSWORD>" \
|
||||||
|
--cap-add=NET_ADMIN \
|
||||||
|
--device /dev/net/tun \
|
||||||
|
--sysctl net.ipv6.conf.all.disable_ipv6=0 \
|
||||||
|
-d jonoh/openvpn-proxy
|
||||||
|
|
||||||
|
```
|
||||||
@ -0,0 +1,63 @@
|
|||||||
|
# linuxserver - airsonic-advanced
|
||||||
|
|
||||||
|
This is a [Docker](/wiki/docker.md) container for a
|
||||||
|
[Airsonic-Advanced](../airsonic-advanced.md) server.
|
||||||
|
The official container and documentation was made by
|
||||||
|
[linuxserver](https://github.com/linuxserver/docker-airsonic-advanced).
|
||||||
|
|
||||||
|
## 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 |
|
||||||
|
| ------ | -------- | ------- |
|
||||||
|
| `PUID` | UserID | |
|
||||||
|
| `PGID` | GroupID | |
|
||||||
|
| `TZ` | Timezone | |
|
||||||
|
|
||||||
|
## Volumes
|
||||||
|
|
||||||
|
Set the following volumes with the -v tag.
|
||||||
|
|
||||||
|
| Outside mount/volume name | Container mount | Description |
|
||||||
|
| ------------------------- | --------------- | ----------------------- |
|
||||||
|
| `airsonicadv_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.sh
|
||||||
|
|
||||||
|
```sh
|
||||||
|
#!/bin/sh
|
||||||
|
docker stop airsonicadv
|
||||||
|
docker rm airsonicadv
|
||||||
|
docker pull lscr.io/linuxserver/airsonic-advanced:latest
|
||||||
|
docker run --name=airsonicadv \
|
||||||
|
--restart unless-stopped \
|
||||||
|
-p 4040:4040 \
|
||||||
|
-v airsonicadv_config:/config \
|
||||||
|
-v media_music:/music \
|
||||||
|
-v media_playlists:/playlists \
|
||||||
|
-v media_podcasts:/podcasts \
|
||||||
|
-v media_audiobooks:/media \
|
||||||
|
-e PUID=0 \
|
||||||
|
-e PGID=0 \
|
||||||
|
-e TZ=Europe/Berlin \
|
||||||
|
-d lscr.io/linuxserver/airsonic-advanced:latest
|
||||||
|
```
|
||||||
@ -0,0 +1,86 @@
|
|||||||
|
# linuxserver - lidarr
|
||||||
|
|
||||||
|
This is a [Docker](/wiki/docker.md) container for a [Lidarr](/wiki/*arr.md)
|
||||||
|
server.
|
||||||
|
The official container and documentation was made by
|
||||||
|
[linuxserver](https://hub.docker.com/r/linuxserver/lidarr).
|
||||||
|
|
||||||
|
## Set-up
|
||||||
|
|
||||||
|
Create the files `rebuild.sh` and `docker-compose.yml` at the same place.
|
||||||
|
Change the settings according to your needs and run `./rebuild.sh` afterwards.
|
||||||
|
It is recommended to set a download completed folder with the same internal and
|
||||||
|
external mounts as your [BitTorent](/wiki/bittorrent.md) client.
|
||||||
|
This guide uses the same mounts as used in the
|
||||||
|
[Transmission](/wiki/transmission.md)
|
||||||
|
[Docker container](/wiki/docker-images/haugene_-_transmission-openvpn.md).
|
||||||
|
This namely causes the following line in the
|
||||||
|
[`docker-compose.yml`](#docker-composeyml).
|
||||||
|
|
||||||
|
```txt
|
||||||
|
- /var/lib/docker/volumes/transmission_data/_data/completed:/data/completed #optional
|
||||||
|
```
|
||||||
|
|
||||||
|
## Environment-variables
|
||||||
|
|
||||||
|
Set the following environment-variables in the `environment:` section of the
|
||||||
|
docker-compose file.
|
||||||
|
|
||||||
|
| Name | Usage | Default |
|
||||||
|
| --------------------- | --------------------------- | ----------------------- |
|
||||||
|
| `PUID` | user id for container user | `1000` |
|
||||||
|
| `PGID` | group id for container user | `1000` |
|
||||||
|
| `TZ` | specify the timezone | `Etc/UTC` |
|
||||||
|
|
||||||
|
## Volumes
|
||||||
|
|
||||||
|
Set the following volumes in the `volumes:` section of the docker-compose file.
|
||||||
|
|
||||||
|
| Outside mount/volume name | Container mount | Description |
|
||||||
|
| ------------------------- | ----------------- | --------------------------------- |
|
||||||
|
| `config` | `/config` | directory for config |
|
||||||
|
| `complete` | `/music` | directory for music |
|
||||||
|
|
||||||
|
## Ports
|
||||||
|
|
||||||
|
Set the following ports in the `ports:` section.
|
||||||
|
|
||||||
|
| Container Port | Recommended outside port | Protocol | Description |
|
||||||
|
| -------------- | ------------------------ | -------- | ------------ |
|
||||||
|
| `8686` | `8686` | TCP | webUI |
|
||||||
|
|
||||||
|
## rebuild.sh
|
||||||
|
|
||||||
|
```sh
|
||||||
|
#!/bin/sh
|
||||||
|
docker-compose down
|
||||||
|
docker pull lscr.io/linuxserver/lidarr:latest
|
||||||
|
docker-compose up -d
|
||||||
|
```
|
||||||
|
|
||||||
|
## docker-compose.yml
|
||||||
|
|
||||||
|
```yml
|
||||||
|
version: "2.1"
|
||||||
|
services:
|
||||||
|
lidarr:
|
||||||
|
image: lscr.io/linuxserver/lidarr:latest
|
||||||
|
container_name: lidarr
|
||||||
|
environment:
|
||||||
|
- PUID=0
|
||||||
|
- PGID=0
|
||||||
|
- TZ=Etc/UTC
|
||||||
|
volumes:
|
||||||
|
- config:/config
|
||||||
|
- complete:/music #optional
|
||||||
|
- /var/lib/docker/volumes/transmission_data/_data/completed:/data/completed #optional
|
||||||
|
ports:
|
||||||
|
- 8686:8686
|
||||||
|
restart: unless-stopped
|
||||||
|
|
||||||
|
volumes:
|
||||||
|
config:
|
||||||
|
driver: local
|
||||||
|
complete:
|
||||||
|
driver: local
|
||||||
|
```
|
||||||
@ -0,0 +1,86 @@
|
|||||||
|
# linuxserver - radarr
|
||||||
|
|
||||||
|
This is a [Docker](/wiki/docker.md) container for a [Radarr](/wiki/*arr.md)
|
||||||
|
server.
|
||||||
|
The official container and documentation was made by
|
||||||
|
[linuxserver](https://hub.docker.com/r/linuxserver/radarr).
|
||||||
|
|
||||||
|
## Set-up
|
||||||
|
|
||||||
|
Create the files `rebuild.sh` and `docker-compose.yml` at the same place.
|
||||||
|
Change the settings according to your needs and run `./rebuild.sh` afterwards.
|
||||||
|
It is recommended to set a download completed folder with the same internal and
|
||||||
|
external mounts as your [BitTorent](/wiki/bittorrent.md) client.
|
||||||
|
This guide uses the same mounts as used in the
|
||||||
|
[Transmission](/wiki/transmission.md)
|
||||||
|
[Docker container](/wiki/docker-images/haugene_-_transmission-openvpn.md).
|
||||||
|
This namely causes the following line in the
|
||||||
|
[`docker-compose.yml`](#docker-composeyml).
|
||||||
|
|
||||||
|
```txt
|
||||||
|
- /var/lib/docker/volumes/transmission_data/_data/completed:/data/completed #optional
|
||||||
|
```
|
||||||
|
|
||||||
|
## Environment-variables
|
||||||
|
|
||||||
|
Set the following environment-variables in the `environment:` section of the
|
||||||
|
docker-compose file.
|
||||||
|
|
||||||
|
| Name | Usage | Default |
|
||||||
|
| --------------------- | --------------------------- | ----------------------- |
|
||||||
|
| `PUID` | user id for container user | `1000` |
|
||||||
|
| `PGID` | group id for container user | `1000` |
|
||||||
|
| `TZ` | specify the timezone | `Etc/UTC` |
|
||||||
|
|
||||||
|
## Volumes
|
||||||
|
|
||||||
|
Set the following volumes in the `volumes:` section of the docker-compose file.
|
||||||
|
|
||||||
|
| Outside mount/volume name | Container mount | Description |
|
||||||
|
| ------------------------- | ----------------- | --------------------------------- |
|
||||||
|
| `config` | `/config` | directory for config |
|
||||||
|
| `complete` | `/movies` | directory for music |
|
||||||
|
|
||||||
|
## Ports
|
||||||
|
|
||||||
|
Set the following ports in the `ports:` section.
|
||||||
|
|
||||||
|
| Container Port | Recommended outside port | Protocol | Description |
|
||||||
|
| -------------- | ------------------------ | -------- | ------------ |
|
||||||
|
| `7878` | `7878` | TCP | webUI |
|
||||||
|
|
||||||
|
## rebuild.sh
|
||||||
|
|
||||||
|
```sh
|
||||||
|
#!/bin/sh
|
||||||
|
docker-compose down
|
||||||
|
docker pull lscr.io/linuxserver/radarr:latest
|
||||||
|
docker-compose up -d
|
||||||
|
```
|
||||||
|
|
||||||
|
## docker-compose.yml
|
||||||
|
|
||||||
|
```yml
|
||||||
|
version: "2.1"
|
||||||
|
services:
|
||||||
|
radarr:
|
||||||
|
image: lscr.io/linuxserver/radarr:latest
|
||||||
|
container_name: radarr
|
||||||
|
environment:
|
||||||
|
- PUID=0
|
||||||
|
- PGID=0
|
||||||
|
- TZ=Etc/UTC
|
||||||
|
volumes:
|
||||||
|
- config:/config
|
||||||
|
- complete:/movies #optional
|
||||||
|
- /var/lib/docker/volumes/transmission_data/_data/completed:/data/completed #optional
|
||||||
|
ports:
|
||||||
|
- 7878:7878
|
||||||
|
restart: unless-stopped
|
||||||
|
|
||||||
|
volumes:
|
||||||
|
config:
|
||||||
|
driver: local
|
||||||
|
complete:
|
||||||
|
driver: local
|
||||||
|
```
|
||||||
@ -0,0 +1,86 @@
|
|||||||
|
# linuxserver - sonarr
|
||||||
|
|
||||||
|
This is a [Docker](/wiki/docker.md) container for a [Sonarr](/wiki/*arr.md)
|
||||||
|
server.
|
||||||
|
The official container and documentation was made by
|
||||||
|
[linuxserver](https://hub.docker.com/r/linuxserver/sonarr).
|
||||||
|
|
||||||
|
## Set-up
|
||||||
|
|
||||||
|
Create the files `rebuild.sh` and `docker-compose.yml` at the same place.
|
||||||
|
Change the settings according to your needs and run `./rebuild.sh` afterwards.
|
||||||
|
It is recommended to set a download completed folder with the same internal and
|
||||||
|
external mounts as your [BitTorent](/wiki/bittorrent.md) client.
|
||||||
|
This guide uses the same mounts as used in the
|
||||||
|
[Transmission](/wiki/transmission.md)
|
||||||
|
[Docker container](/wiki/docker-images/haugene_-_transmission-openvpn.md).
|
||||||
|
This namely causes the following line in the
|
||||||
|
[`docker-compose.yml`](#docker-composeyml).
|
||||||
|
|
||||||
|
```txt
|
||||||
|
- /var/lib/docker/volumes/transmission_data/_data/completed:/data/completed #optional
|
||||||
|
```
|
||||||
|
|
||||||
|
## Environment-variables
|
||||||
|
|
||||||
|
Set the following environment-variables in the `environment:` section of the
|
||||||
|
docker-compose file.
|
||||||
|
|
||||||
|
| Name | Usage | Default |
|
||||||
|
| --------------------- | --------------------------- | ----------------------- |
|
||||||
|
| `PUID` | user id for container user | `1000` |
|
||||||
|
| `PGID` | group id for container user | `1000` |
|
||||||
|
| `TZ` | specify the timezone | `Etc/UTC` |
|
||||||
|
|
||||||
|
## Volumes
|
||||||
|
|
||||||
|
Set the following volumes in the `volumes:` section of the docker-compose file.
|
||||||
|
|
||||||
|
| Outside mount/volume name | Container mount | Description |
|
||||||
|
| ------------------------- | ----------------- | --------------------------------- |
|
||||||
|
| `config` | `/config` | directory for config |
|
||||||
|
| `complete` | `/tv` | directory for music |
|
||||||
|
|
||||||
|
## Ports
|
||||||
|
|
||||||
|
Set the following ports in the `ports:` section.
|
||||||
|
|
||||||
|
| Container Port | Recommended outside port | Protocol | Description |
|
||||||
|
| -------------- | ------------------------ | -------- | ------------ |
|
||||||
|
| `8989` | `8989` | TCP | webUI |
|
||||||
|
|
||||||
|
## rebuild.sh
|
||||||
|
|
||||||
|
```sh
|
||||||
|
#!/bin/sh
|
||||||
|
docker-compose down
|
||||||
|
docker pull lscr.io/linuxserver/sonarr:latest
|
||||||
|
docker-compose up -d
|
||||||
|
```
|
||||||
|
|
||||||
|
## docker-compose.yml
|
||||||
|
|
||||||
|
```yml
|
||||||
|
version: "2.1"
|
||||||
|
services:
|
||||||
|
sonarr:
|
||||||
|
image: lscr.io/linuxserver/sonarr:latest
|
||||||
|
container_name: sonarr
|
||||||
|
environment:
|
||||||
|
- PUID=0
|
||||||
|
- PGID=0
|
||||||
|
- TZ=Etc/UTC
|
||||||
|
volumes:
|
||||||
|
- config:/config
|
||||||
|
- complete:/tv #optional
|
||||||
|
- /var/lib/docker/volumes/transmission_data/_data/completed:/data/completed #optional
|
||||||
|
ports:
|
||||||
|
- 8989:8989
|
||||||
|
restart: unless-stopped
|
||||||
|
|
||||||
|
volumes:
|
||||||
|
config:
|
||||||
|
driver: local
|
||||||
|
complete:
|
||||||
|
driver: local
|
||||||
|
```
|
||||||
@ -0,0 +1,72 @@
|
|||||||
|
# linuxserver - tvheadend
|
||||||
|
|
||||||
|
This is a [Docker](/wiki/docker.md) container for a [TVHeadend](../tvheadend.md)
|
||||||
|
server.
|
||||||
|
The official container and documentation was made by
|
||||||
|
[linuxserver](https://hub.docker.com/r/linuxserver/tvheadend).
|
||||||
|
|
||||||
|
## Set-up
|
||||||
|
|
||||||
|
Create the files `rebuild.sh` 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 environment-variables in the `environment:` section of the
|
||||||
|
docker-compose file.
|
||||||
|
|
||||||
|
| Name | Usage | Default |
|
||||||
|
| --------------------- | --------------------------- | ----------------------- |
|
||||||
|
| `PUID` | user id for container user | `1000` |
|
||||||
|
| `PGID` | group id for container user | `1000` |
|
||||||
|
| `TZ` | specify the timezone | `Europe/London` |
|
||||||
|
| `RUN_OPTS` | specify the timezone | ` ` |
|
||||||
|
|
||||||
|
## Volumes
|
||||||
|
|
||||||
|
Set the following volumes in the `volumes:` section of the docker-compose file.
|
||||||
|
|
||||||
|
| Outside mount/volume name | Container mount | Description |
|
||||||
|
| ------------------------- | --------------- | --------------------------------- |
|
||||||
|
| `config` | `/config` | directory for config |
|
||||||
|
| `tvdvr` | `/recordings` | directory for storage |
|
||||||
|
|
||||||
|
## Ports
|
||||||
|
|
||||||
|
Set the following ports in the `ports:` section.
|
||||||
|
|
||||||
|
| Container Port | Recommended outside port | Protocol | Description |
|
||||||
|
| -------------- | ------------------------ | -------- | ------------ |
|
||||||
|
| `9981` | ` ` | TCP | webUI |
|
||||||
|
| `9982` | ` ` | TCP | HTSP port |
|
||||||
|
|
||||||
|
## rebuild.sh
|
||||||
|
|
||||||
|
```sh
|
||||||
|
#!/bin/sh
|
||||||
|
docker-compose down
|
||||||
|
docker pull lscr.io/linuxserver/tvheadend:latest
|
||||||
|
docker-compose up -d
|
||||||
|
```
|
||||||
|
|
||||||
|
## docker-compose.yml
|
||||||
|
|
||||||
|
```yml
|
||||||
|
version: "2.1"
|
||||||
|
services:
|
||||||
|
tvheadend:
|
||||||
|
image: lscr.io/linuxserver/tvheadend:latest
|
||||||
|
environment:
|
||||||
|
- PUID=1000
|
||||||
|
- PGID=1000
|
||||||
|
- TZ=Europe/London
|
||||||
|
volumes:
|
||||||
|
- config:/config
|
||||||
|
- tvdvr:/recordings
|
||||||
|
network_mode: "host"
|
||||||
|
restart: unless-stopped
|
||||||
|
|
||||||
|
volumes:
|
||||||
|
config:
|
||||||
|
tvdvr:
|
||||||
|
```
|
||||||
@ -1,20 +0,0 @@
|
|||||||
# nasourso - nginx-certbot-docker-tui
|
|
||||||
|
|
||||||
The official script/image and documentation [nasourso](https://github.com/nasourso/nginx-certbot-docker-tui).
|
|
||||||
The first step is downloading it.
|
|
||||||
|
|
||||||
`wget https://raw.githubusercontent.com/nasourso/nginx-certbot-docker-tui/master/src/ncdt.sh`
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
## rebuild.sh
|
|
||||||
|
|
||||||
```shell
|
|
||||||
#!/bin/sh
|
|
||||||
docker-compose down
|
|
||||||
docker pull nginx:latest
|
|
||||||
docker pull certbot/certbot:latest
|
|
||||||
docker-compose up -d
|
|
||||||
```
|
|
||||||
@ -1,42 +0,0 @@
|
|||||||
# nasourso - pltu
|
|
||||||
|
|
||||||
The official container and documentation was made by [nasourso](https://hub.docker.com/r/nasourso/pltu).
|
|
||||||
|
|
||||||
## Volumes
|
|
||||||
|
|
||||||
Set the following volumes with the -v tag.
|
|
||||||
|
|
||||||
| Outside mount/volume name | Container mount | Description |
|
|
||||||
| ------------------------- | --------------- | --------------------------------------------------- |
|
|
||||||
| `pltu` | `/cert` | storage for openvpn certificate of server with plex |
|
|
||||||
|
|
||||||
## Ports
|
|
||||||
|
|
||||||
Set the following ports with the -p tag.
|
|
||||||
|
|
||||||
| Container Port | Recommended outside port | Protocol | Description |
|
|
||||||
| -------------- | ------------------------ | -------- | ----------- |
|
|
||||||
| `80` | `32400` | TCP | Plex webUI |
|
|
||||||
|
|
||||||
## Additional
|
|
||||||
|
|
||||||
There are some special variables to set.
|
|
||||||
|
|
||||||
| Flag | Usage |
|
|
||||||
| -------------- | ------------------------ |
|
|
||||||
| `--privileged` | is needed due to openvpn |
|
|
||||||
|
|
||||||
## rebuild.sh
|
|
||||||
|
|
||||||
```shell
|
|
||||||
#!/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
|
|
||||||
```
|
|
||||||
@ -0,0 +1,49 @@
|
|||||||
|
# sissbrueckner - linkding
|
||||||
|
|
||||||
|
This is a [Docker](/wiki/docker.md) container for a [linkding](../linkding.md)
|
||||||
|
bookmark and archive service.
|
||||||
|
The official container and documentation was made by
|
||||||
|
[sissbrueckner](https://github.com/sissbruecker/linkding).
|
||||||
|
|
||||||
|
## Set-up
|
||||||
|
|
||||||
|
Create the file `rebuild.sh`.
|
||||||
|
Change the settings according to your needs and run `./rebuild.sh` afterwards.
|
||||||
|
Afterwards you need to create a user.
|
||||||
|
This can be done by running the following line with changed credentials:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
docker exec -it linkding python manage.py createsuperuser --username=joe --email=joe@example.com
|
||||||
|
```
|
||||||
|
|
||||||
|
You will be asked for a password via the commandline.
|
||||||
|
|
||||||
|
## Volumes
|
||||||
|
|
||||||
|
Set the following volumes with the -v tag.
|
||||||
|
|
||||||
|
| Outside mount/volume name | Container mount | Description |
|
||||||
|
| ------------------------- | ---------------------- | --------------------------- |
|
||||||
|
| `linkding` | `/etc/linkding/data` | storage for persistent data |
|
||||||
|
|
||||||
|
## Ports
|
||||||
|
|
||||||
|
Set the following ports with the -p tag.
|
||||||
|
|
||||||
|
| Container Port | Recommended outside port | Protocol | Description |
|
||||||
|
| -------------- | ------------------------ | -------- | ----------- |
|
||||||
|
| `9090` | `9090` | TCP | WebUI |
|
||||||
|
|
||||||
|
## rebuild.sh
|
||||||
|
|
||||||
|
```sh
|
||||||
|
#!/bin/sh
|
||||||
|
docker stop linkding
|
||||||
|
docker rm linkding
|
||||||
|
docker pull sissbruecker/linkding:latest
|
||||||
|
docker run --name linkding \
|
||||||
|
--restart unless-stopped \
|
||||||
|
-p 9090:9090 \
|
||||||
|
-v linkding:/etc/linkding/data \
|
||||||
|
-d sissbruecker/linkding:latest
|
||||||
|
```
|
||||||
@ -0,0 +1,23 @@
|
|||||||
|
# E-books
|
||||||
|
|
||||||
|
E-books are digital publications of books.
|
||||||
|
They can be read with specific hardware - an e-reader - or on a personal
|
||||||
|
computer.
|
||||||
|
E-books are usually available in `.epub` or `.pdf` files.
|
||||||
|
Amazon (`.azw`), Mobi (`.mobi`) and other brands selling e-readers have
|
||||||
|
proprietary formats.
|
||||||
|
|
||||||
|
## Management
|
||||||
|
|
||||||
|
The management of e-books can be achieved by using special software suites like
|
||||||
|
[calibre](/wiki/calibre.md).
|
||||||
|
|
||||||
|
## DRM
|
||||||
|
|
||||||
|
Proprietary formats may but don't have to feature DRM.
|
||||||
|
There are some software solutions for handling DRM like the no longer supported
|
||||||
|
[DeDRM by apprenticeharper](https://github.com/apprenticeharper/DeDRM_tools) or
|
||||||
|
its supported counterpart [DeDRM by noDRM](https://github.com/noDRM/DeDRM_tools).
|
||||||
|
Due to legal issues in many places it is recommended to not use these or
|
||||||
|
similar software.
|
||||||
|
If the software is to be used by you check your local laws first.
|
||||||
@ -1,64 +1,88 @@
|
|||||||
# Firefox
|
# Firefox
|
||||||
|
|
||||||
[Firefox](https://www.mozilla.org/en-US/firefox) is a free and open-source web
|
[Firefox](https://www.mozilla.org/en-US/Firefox) is a free and open-source web
|
||||||
browser.
|
browser.
|
||||||
|
|
||||||
## List of useful Firefox addons
|
## Telemetry
|
||||||
|
|
||||||
Following is a list of useful Firefox addons.
|
Telemetry is the remote measurement and transmission of data.
|
||||||
|
To change the telemetry of Firefox navigate to `about:telemetry` and click the
|
||||||
|
options to toggle between enabled and disabled.
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
Firefox has many possible settings and precerences.
|
||||||
|
This section addresses possible settings and preferences for specific use cases.
|
||||||
|
|
||||||
|
### Scrolling
|
||||||
|
|
||||||
|
On Linux distributions auto scroll is disabled by default.
|
||||||
|
This means that you cant click the middle mouse button to use it for scrolling.
|
||||||
|
To enable it go into the preferences and check `Use autoscrolling`.
|
||||||
|
|
||||||
|
### Sponsorings
|
||||||
|
|
||||||
|
Sponsorings are embedded ads in Firefox.
|
||||||
|
After navigating to `about:config` enabling and disabling of sponsorings can be done at
|
||||||
|
`browser.newtabpage.activity-stream.showSponsored`.
|
||||||
|
|
||||||
|
### Compact Mode
|
||||||
|
|
||||||
|
In Firefox compact mode is a configuration to make tabs and navigation elements
|
||||||
|
including bookmarks smaller.
|
||||||
|
After navigating to `about:config` the configuration can be done at
|
||||||
|
`browser.compactmode.show`.
|
||||||
|
|
||||||
|
## List of useful Firefox add-ons
|
||||||
|
|
||||||
|
Following is a list of useful Firefox add-ons.
|
||||||
They can be removed and configured under `about:config`.
|
They can be removed and configured under `about:config`.
|
||||||
|
|
||||||
- [ClearURLs](https://addons.mozilla.org/en-GB/firefox/addon/clearurls) removes
|
- [Cameleon](https://addons.mozilla.org/en-GB/firefox/addon/chameleon-ext/)
|
||||||
|
spoofs your browser profile including user agent and screen size.
|
||||||
|
- [ClearURLs](https://addons.mozilla.org/en-GB/Firefox/addon/clearurls) removes
|
||||||
tracking elements from URLs.
|
tracking elements from URLs.
|
||||||
- [Dark Reader](https://addons.mozilla.org/en-GB/firefox/addon/darkreader) creates
|
- [Dark Reader](https://addons.mozilla.org/en-GB/Firefox/addon/darkreader) creates
|
||||||
an automatic dark mode for sites without native dark mode.
|
an automatic dark mode for sites without native dark mode.
|
||||||
- [Firefox Multi-Account Containers](https://addons.mozilla.org/en-GB/firefox/addon/multi-account-containers)
|
- [Firefox Multi-Account Containers](https://addons.mozilla.org/en-GB/Firefox/addon/multi-account-containers)
|
||||||
lets you separate cookies in different containers on a per site base.
|
lets you separate cookies in different containers on a per site base.
|
||||||
- [Floccus](https://addons.mozilla.org/en-US/firefox/addon/floccus/) syncs your
|
With this add-on a proxy can be selected for each container which enables
|
||||||
|
usage of [a VPN proxy](/wiki/vpn.md#proxy).
|
||||||
|
- [Floccus](https://addons.mozilla.org/en-US/Firefox/addon/floccus/) syncs your
|
||||||
bookmarks across devices (supports Nextcloud and WebDAV (ownCloud, etc)).
|
bookmarks across devices (supports Nextcloud and WebDAV (ownCloud, etc)).
|
||||||
- [hide-scrollbars](https://addons.mozilla.org/en-GB/firefox/addon/hide-scrollbars)
|
- [hide-scrollbars](https://addons.mozilla.org/en-GB/Firefox/addon/hide-scrollbars)
|
||||||
hides scrollbars.
|
hides scrollbars.
|
||||||
- [Never-Consent](https://addons.mozilla.org/en-GB/firefox/addon/never-consent)
|
- [Never-Consent](https://addons.mozilla.org/en-GB/Firefox/addon/never-consent)
|
||||||
automatically refuses GDPR consent to a bunch of platforms.
|
automatically refuses GDPR consent to a bunch of platforms.
|
||||||
- [NoScript](https://addons.mozilla.org/en-GB/firefox/addon/noscript) blocks all
|
- [NoScript](https://addons.mozilla.org/en-GB/Firefox/addon/noscript) blocks all
|
||||||
javascript so that the parts you need can be reenabled and the rest is not used.
|
javascript so that the parts you need can be reenabled and the rest is not used.
|
||||||
- [Privacy Badger](https://addons.mozilla.org/en-GB/firefox/addon/privacy-badger17)
|
- [Privacy Badger](https://addons.mozilla.org/en-GB/Firefox/addon/privacy-badger17)
|
||||||
blocks unwanted invisible trackers.
|
blocks unwanted invisible trackers.
|
||||||
- [Privacy Redirect](https://addons.mozilla.org/en-US/firefox/addon/privacy-redirect/)
|
- [Privacy Redirect](https://addons.mozilla.org/en-US/Firefox/addon/privacy-redirect/)
|
||||||
redirects youtube, instagram, twitter, etc to free alternatives or alternative
|
redirects youtube, instagram, twitter, etc to free alternatives or alternative
|
||||||
frontends.
|
frontends.
|
||||||
- [Temporary Containers](https://addons.mozilla.org/en-GB/firefox/addon/temporary-containers)
|
- [Sidebery](https://addons.mozilla.org/en-GB/Firefox/addon/sidebery)
|
||||||
|
is a sidebar with treestyle tabs and bookmarks.
|
||||||
|
- [SponsorBlock](https://addons.mozilla.org/en-US/firefox/addon/sponsorblock/)
|
||||||
|
skips YouTube video sponsors automatically, works with
|
||||||
|
[invidious](./invidious.md) too.
|
||||||
|
- [Temporary Containers](https://addons.mozilla.org/en-GB/Firefox/addon/temporary-containers)
|
||||||
opens tabs and websites, that are not already managed by
|
opens tabs and websites, that are not already managed by
|
||||||
`Firefox Multi-Account Containers` in a new container.
|
`Firefox Multi-Account Containers` in a new container.
|
||||||
- [uBlock Origin](https://addons.mozilla.org/en-GB/firefox/addon/ublock-origin)
|
- [Tree Style Tab](https://addons.mozilla.org/en-GB/Firefox/addon/tree-style-tab)
|
||||||
|
shows tabs like a tree. This is especially useful if many tabs are used.
|
||||||
|
- [uBlock Origin](https://addons.mozilla.org/en-GB/Firefox/addon/ublock-origin)
|
||||||
blocks unwanted content like ads.
|
blocks unwanted content like ads.
|
||||||
- [User-Agent Switcher and Manager](https://addons.mozilla.org/en-GB/firefox/addon/user-agent-string-switcher)
|
- [User-Agent Switcher and Manager](https://addons.mozilla.org/en-GB/Firefox/addon/user-agent-string-switcher)
|
||||||
spoofs websites that try to gather information about your webbrowser.
|
spoofs websites that try to gather information about your webbrowser.
|
||||||
- [Vim Vixen](https://addons.mozilla.org/en-GB/firefox/addon/vim-vixen) enables
|
- [Vim Vixen](https://addons.mozilla.org/en-GB/Firefox/addon/vim-vixen) enables
|
||||||
vim movement for firefox.
|
vim movement for Firefox.
|
||||||
- Plugins for Tabs, etc. in tree style:
|
|
||||||
- [Sidebery](https://addons.mozilla.org/en-GB/firefox/addon/sidebery)
|
|
||||||
is a sidebar with treestyle tabs and bookmarks.
|
|
||||||
- [Tree Style Tab](https://addons.mozilla.org/en-GB/firefox/addon/tree-style-tab)
|
|
||||||
shows tabs like a tree. This is especially useful if many tabs are used.
|
|
||||||
|
|
||||||
## Useful configuration
|
|
||||||
|
|
||||||
To disable the telemetry of firefox navigate to `about:telemetry` and (if it says
|
|
||||||
enabled) click on `enabled` and disable all the options.
|
|
||||||
|
|
||||||
To disable ads from firefox navigate to `about:config`, search for
|
|
||||||
`browser.newtabpage.activity-stream.showSponsored` and disable all upcoming results.
|
|
||||||
|
|
||||||
On Linux distributions auto scroll is disabled by default.
|
|
||||||
This means that you cant click the middle mouse button to use it for scrolling.
|
|
||||||
To enable it go into the preferences and check `Use autoscrolling`.
|
|
||||||
|
|
||||||
## Add a new search engine
|
## Add a new search engine
|
||||||
|
|
||||||
You can add a new search engine with the addon `Add custom search engine`.
|
You can add a new search engine with the add-on `Add custom search engine`.
|
||||||
Make sure to replace `<url to search engine>` with the according url.
|
Make sure to replace `<url to search engine>` with the according url.
|
||||||
|
|
||||||
It is possible to add it without an addon.
|
It is possible to add it without an add-on.
|
||||||
Navigate to the search engine and click the `...` in the address bar.
|
Navigate to the search engine and click the `...` in the address bar.
|
||||||
Then click `Add Search Engine`
|
Then click `Add Search Engine`
|
||||||
|
|||||||
@ -0,0 +1,27 @@
|
|||||||
|
# flac (Codec)
|
||||||
|
|
||||||
|
This article describes the `flac` codec.
|
||||||
|
For the linux `flac` package see the
|
||||||
|
[flac package entry](./linux/flac_(package).md.
|
||||||
|
|
||||||
|
`flac` - short for Free Lossless Audio Codec - is a [audio](./audio.md) codec
|
||||||
|
without compression losses.
|
||||||
|
|
||||||
|
## Tagging
|
||||||
|
|
||||||
|
The following explains the most general tags in short.
|
||||||
|
|
||||||
|
- `title` is the name of the music piece.
|
||||||
|
- `artist` is the artist of the song - for classical music it is the composer.
|
||||||
|
- `album` is the name of the album.
|
||||||
|
- `tracknumber` is the number of the music piece in the album
|
||||||
|
- `date` is the year of publication
|
||||||
|
- `albumartist` is the artist that made the album
|
||||||
|
- `discnumber` is the disc number of the music piece in the album
|
||||||
|
- `genre` is the genre of the music piece
|
||||||
|
- `totaldiscs` is the amount of discs of the album
|
||||||
|
- `totaltracks` is the amount of tracks in the disc of the music piece
|
||||||
|
- `front` is an image of the front cover
|
||||||
|
- `performer` is used in classical music and defines the artist that
|
||||||
|
played the piece. In audiobooks it can be used to signal the reader of the
|
||||||
|
book.
|
||||||
@ -0,0 +1,13 @@
|
|||||||
|
# Bottles
|
||||||
|
|
||||||
|
[Bottles](https://usebottles.com/) is an application similar to
|
||||||
|
[Lutris](/wiki/games/lutris.md) that focusses on running both
|
||||||
|
[Windows](/wiki/windows/windows.md) applications aswell as games through
|
||||||
|
[WINE](/wiki/linux/wine.md) or their own runner [Caffe](#caffe).
|
||||||
|
|
||||||
|
## Caffe
|
||||||
|
|
||||||
|
[Caffe](https://docs.usebottles.com/components/runners) is the official runner
|
||||||
|
of [Windows](/wiki/windows/windows.md) programs in Bottles.
|
||||||
|
It is a patched version of [WINE](/wiki/linux/wine.md) that can have positive
|
||||||
|
effects on certain programs.
|
||||||
@ -0,0 +1,58 @@
|
|||||||
|
# Dolphin
|
||||||
|
|
||||||
|
[Dolphin](https://dolphin-emu.org/) is a GameCube and Wii
|
||||||
|
[emulator](./emulators.md).
|
||||||
|
|
||||||
|
## Setup
|
||||||
|
|
||||||
|
Dolphin can be installed on different systems, a list for this can be found on
|
||||||
|
the [Dolphin website](https://dolphin-emu.org/download/).
|
||||||
|
Additionally it can be installed using [Flatpak](../linux/flatpak.md) where the
|
||||||
|
package is called `org.DolphinEmu.dolphin-emu`.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
The following sections describe specific issues relating to the configuration
|
||||||
|
and usage of Dolphin.
|
||||||
|
|
||||||
|
### Steam Deck specific settings
|
||||||
|
|
||||||
|
The following settings are especially useful when emulating games on the
|
||||||
|
[Steam Deck](./steam_deck.md) as pointed out by
|
||||||
|
[nchristopher](https://github.com/nchristopher/steamdeck-emulation/blob/main/emulators/dolphin.md).
|
||||||
|
But it is a good starting point for other systems aswell.
|
||||||
|
It is important to emphasize that the system needs to meet the requirements to
|
||||||
|
run Vulkan.
|
||||||
|
Select the configuration and select the paths tab.
|
||||||
|
There the directories for Wii and GameCube [ROMs](./emulators.md) can be added.
|
||||||
|
In the audio tab select `Pulse` as your audio backend.
|
||||||
|
In the interface tab select `Confirm to Stop` to avoid prompts when closing the
|
||||||
|
game.
|
||||||
|
Close the configuration and select the graphics menu.
|
||||||
|
Set the backend to Vulkan.
|
||||||
|
[Fullscreen Mode](#fullscreen-mode) can be enabled when starting the game too.
|
||||||
|
In the enhancements tab select `3x Native` as internal resolution, as it will
|
||||||
|
upscale the image to 1080p.
|
||||||
|
In the main tab check the `Render to Main Window` box.
|
||||||
|
Close the graphics menu and open the controllers menu.
|
||||||
|
For the first GameCube controller open the configuration, select
|
||||||
|
`SDL/0/Microsoft X-Box 360 Pad 0` as type, clear and change the buttons to your
|
||||||
|
preference.
|
||||||
|
Select emulate Wii Bluetooth adapter for Wii controllers, alternatively you can
|
||||||
|
leave it empty to use the GameCube controller settings.
|
||||||
|
For the first Wii controller open the configuration, select
|
||||||
|
`SDL/0/Microsoft X-Box 360 Pad 0` as type, clear and change the buttons to your
|
||||||
|
preference.
|
||||||
|
|
||||||
|
### Fullscreen Mode
|
||||||
|
|
||||||
|
Check the `Start in Fullscreen` box to start games automatically in fullscreen
|
||||||
|
mode.
|
||||||
|
To exit it use `Esc`.
|
||||||
|
|
||||||
|
### Running a game without selection in the menu
|
||||||
|
|
||||||
|
To run a game instantly the path to the [ROM](./emulators.md) needs to be
|
||||||
|
appended to the command used for starting Dolphin.
|
||||||
|
This should be made in quotation marks as it could contain characters that need
|
||||||
|
to be escaped.
|
||||||
@ -0,0 +1,13 @@
|
|||||||
|
# Emulators
|
||||||
|
|
||||||
|
An Emulator is a hard- or software that enables a computer to behave like
|
||||||
|
another computer.
|
||||||
|
In the gaming context this is mainly used to run games from a console on
|
||||||
|
another computer.
|
||||||
|
Emulators usually need ROMs to run games.
|
||||||
|
ROMs are a digital copy of a video game.
|
||||||
|
|
||||||
|
## List of Emulator software
|
||||||
|
|
||||||
|
- [PPSSPP](./ppsspp.md) is made to emulate Playstation Portable games
|
||||||
|
- [Dolphin](./dolphin.md) is made to emulate GameCube and Wii games
|
||||||
@ -0,0 +1,120 @@
|
|||||||
|
# Guild Wars 2
|
||||||
|
|
||||||
|
[Guild Wars 2](https://www.guildwars2.com) is a MMORPG which is available as
|
||||||
|
a standalone Launcher for Windows and on [Steam](./steam.md).
|
||||||
|
|
||||||
|
## Add-ons
|
||||||
|
|
||||||
|
Guild Wars 2 features a large add-on community.
|
||||||
|
All add-ons described in this guide will assume
|
||||||
|
[gw2-add-on-loader](#gw2-add-on-loader) is already installed.
|
||||||
|
It has to be set up first if not already done.
|
||||||
|
Additionally this guide assumes the usage of DX11 rendering which is enabled by
|
||||||
|
default.
|
||||||
|
|
||||||
|
The following subsections assume that Guild Wars 2 is installed at
|
||||||
|
`gw2_root_directory`.
|
||||||
|
Replace this directory placeholder according to your installation.
|
||||||
|
Updating of the add-ons is done by downloading newer versions of the mentioned
|
||||||
|
files and replacing the old ones at the corresponding locations.
|
||||||
|
|
||||||
|
### gw2-add-on-loader
|
||||||
|
|
||||||
|
To make multiple add-ons work together an add-on loader is recommended.
|
||||||
|
One option for this is
|
||||||
|
[gw2-add-on-loader](https://github.com/gw2-addon-loader/loader-core).
|
||||||
|
|
||||||
|
Download the current version from the
|
||||||
|
[releases page](https://github.com/gw2-addon-loader/loader-core/releases).
|
||||||
|
Proceed to place the files in the Guild Wars 2 Directory according to the
|
||||||
|
installation instruction.
|
||||||
|
This files namely include the following:
|
||||||
|
|
||||||
|
- `gw2_root_directory/addonLoader.dll`
|
||||||
|
- `gw2_root_directory/d3d11.dll`
|
||||||
|
- `gw2_root_directory/dxgi.dll`
|
||||||
|
- `gw2_root_directory/bin64/d3d9.dll`
|
||||||
|
|
||||||
|
This add-on loader loads both DX9 and DX11 add-ons.
|
||||||
|
[d3d9_wrapper](#d3d9wrapper) is needed for some functionality of the following
|
||||||
|
add-ons.
|
||||||
|
The installation of it is therefore recommended.
|
||||||
|
|
||||||
|
This add-on does not need to be updated often.
|
||||||
|
It only is required when Guild Wars 2 switches its API.
|
||||||
|
|
||||||
|
### d3d9_wrapper
|
||||||
|
|
||||||
|
[d3d9_wrapper](https://github.com/gw2-addon-loader/d3d9_wrapper) is a wrapper
|
||||||
|
to the d3d9 API that includes d3d9 loading.
|
||||||
|
|
||||||
|
Download the current version from the
|
||||||
|
[releases page](https://github.com/gw2-addon-loader/d3d9_wrapper/releases).
|
||||||
|
From there place the included Directory
|
||||||
|
`d3d9_wrapper/gw2addon_d3d9_wrapper.dll` in Guild Wars 2
|
||||||
|
`gw2_root_directory/addon` directory.
|
||||||
|
|
||||||
|
This add-on does not need to be updated often.
|
||||||
|
It only is required when Guild Wars 2 switches its API.
|
||||||
|
|
||||||
|
### arcdps
|
||||||
|
|
||||||
|
[arcdps](https://www.deltaconnected.com/arcdps/) is a damage meter.
|
||||||
|
Its menu is accessible in-game via the hotkeys `Alt-Shift-T`.
|
||||||
|
|
||||||
|
Download the file `d3d11.dll` from
|
||||||
|
[their website](https://www.deltaconnected.com/arcdps/x64/).
|
||||||
|
Then rename it to `gw2addon_arcdps.dll` and move it to a newly created
|
||||||
|
directory inside the Guild Wars 2 add-on directory
|
||||||
|
`gw2_root_directory/addons/arcdps/gw2addon_arcdps.dll`.
|
||||||
|
|
||||||
|
This add-on and its sub-add-ons needs to be updated regularly to work correctly.
|
||||||
|
|
||||||
|
#### boon-tables
|
||||||
|
|
||||||
|
There is an extension to the arcdps add-on regarding the boon stats which are
|
||||||
|
not easily readable otherwise.
|
||||||
|
For this download the current version of the
|
||||||
|
[gw2-arcdps-boon-table](https://github.com/knoxfighter/GW2-ArcDPS-Boon-Table/releases)
|
||||||
|
and move the downloaded `.dll` file without changing its name to
|
||||||
|
`gw2_root_directory/addons/arcdps/d3d9_arcdps_table.dll`.
|
||||||
|
This extension can be opened via the main menu of the original arcdps settings
|
||||||
|
with the `Boon Table` checkmark or with the hotkey `Alt-Shift-B`.
|
||||||
|
|
||||||
|
#### mechanics
|
||||||
|
|
||||||
|
Another extension to the arcdps addon is a log of mechanics for various
|
||||||
|
strikes, fractals and raids.
|
||||||
|
For this download the current version of
|
||||||
|
[gw2-arcdps-mechanics-log](https://github.com/knoxfighter/GW2-ArcDPS-Mechanics-Log/releases)
|
||||||
|
and move the downloaded `.dll` file without changing its name to
|
||||||
|
`gw2_root_directory/addons/arcdps/d3d9_arcdps_mechanics.dll`.
|
||||||
|
This extension can be opened via the extensions menu of the original arcdps
|
||||||
|
settings.
|
||||||
|
|
||||||
|
#### healing_stats
|
||||||
|
|
||||||
|
The following is an extension of the arcdps addon that allows easier readability
|
||||||
|
of healing.
|
||||||
|
For this download the current version of
|
||||||
|
[arcdps_healing_stats](https://github.com/Krappa322/arcdps_healing_stats/releases)
|
||||||
|
and move the downloaded `.dll` file without changing its name to
|
||||||
|
`gw2_root_directory/addons/arcdps/arcdps_healing_stats.dll`.
|
||||||
|
This extension can be opened via the extensions menu of the original arcdps
|
||||||
|
settings.
|
||||||
|
|
||||||
|
### gw2radial
|
||||||
|
|
||||||
|
[gw2radial](https://github.com/Friendly0Fire/GW2Radial) is a add-on for Guild
|
||||||
|
Wars 2 that allows faster access to markers, mounts and novelties.
|
||||||
|
It is accessible in-game via the hotkeys `Alt-Shift-M`.
|
||||||
|
|
||||||
|
Download the current version from the
|
||||||
|
[releases page](https://github.com/gw2-addon-loader/GW2Radial/releases).
|
||||||
|
Then place the folder `gw2radial_d3d9` which contains the file
|
||||||
|
`gw2addon_gw2radial_d3d9.dll` in the add-on directory of Guild Wars 2
|
||||||
|
`gw2_root_directory/addons`.
|
||||||
|
|
||||||
|
This add-on does not need to be updated often.
|
||||||
|
Updates are only required to get new functions working for example when new
|
||||||
|
mounts are added.
|
||||||
@ -0,0 +1,149 @@
|
|||||||
|
# Lutris
|
||||||
|
|
||||||
|
[Lutris](https://lutris.net/) is a free and open source video game platform for
|
||||||
|
[Linux](/wiki/linux/linux.md) systems.
|
||||||
|
It features compatibility with [GOG](https://www.gog.com/),
|
||||||
|
[Humble Bundle](https://humblebundle.com/),
|
||||||
|
[Epic Games](https://www.epicgames.com/), [Steam](/wiki/games/steam.md) and many
|
||||||
|
other [Windows](/wiki/windows/windows.md) games via its own installer that uses
|
||||||
|
[WINE](/wiki/linux/wine.md). Lutris can also use [Proton](/wiki/games/proton.md)
|
||||||
|
- a patched version of WINE developed by
|
||||||
|
[Valve](https://www.valvesoftware.com/).
|
||||||
|
Additionally to that Lutris supports many different
|
||||||
|
[emulators](/wiki/games/emulators.md).
|
||||||
|
For running both Windows applications aswell as games
|
||||||
|
[Bottles](/wiki/games/bottles.md) can be used.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
### Manually Add a Game
|
||||||
|
|
||||||
|
By clicking on the `+` in the left upper corner of the Lutris application a new
|
||||||
|
game can be manually added.
|
||||||
|
|
||||||
|
Mount `.iso` files first using the `mount -o loop <path to iso> <path to mount>`
|
||||||
|
command.
|
||||||
|
Check the directory the media was mounted to afterwards to select the appropiate
|
||||||
|
Option.
|
||||||
|
|
||||||
|
If a setup executable is available select `Install a Windows game from media`.
|
||||||
|
Then select the setup executable from the mounted path.
|
||||||
|
And proceed with the installation.
|
||||||
|
Lutris will automatically pick the correct executable to start the game after
|
||||||
|
setup.
|
||||||
|
|
||||||
|
For non-setup `.exe` files of completely downloaded games select
|
||||||
|
`Add locally installed game`.
|
||||||
|
Make sure to select the runner [WINE](/wiki/linux/wine.md) for the game in the
|
||||||
|
following window.
|
||||||
|
Make sure to set the `Wine prefix` to the desired location.
|
||||||
|
Select the `Working directory` to be the location of the downloaded game.
|
||||||
|
For cleanup afterwards the game can be moved into the WINE prefix folder as if
|
||||||
|
it was installed inside Windows.
|
||||||
|
If so make sure to point the `Executable` after right-clicking the game and
|
||||||
|
selecting `Configure` to the right location and remove the `Working directory`
|
||||||
|
entry as it is not needed if the executable is inside the WINE prefix.
|
||||||
|
|
||||||
|
|
||||||
|
### Setting Environment Variables
|
||||||
|
|
||||||
|
Environment variables can be set globally or on a per game basis.
|
||||||
|
To set them globally navigate to the `Global options` tab in the `Preferences`.
|
||||||
|
There the `Environment variables` can be added and removed by selecting the
|
||||||
|
corresponding buttons.
|
||||||
|
To set the environment variables for a single game right-click the game and
|
||||||
|
select `Configure`.
|
||||||
|
Navigate to the `System options` tab where the `Environment variables` can be
|
||||||
|
found.
|
||||||
|
|
||||||
|
An environment variable has two parts.
|
||||||
|
The key and the value.
|
||||||
|
This guide uses the notation `key=value` for better readability.
|
||||||
|
The following is an example of an environment variable in this notation.
|
||||||
|
|
||||||
|
```txt
|
||||||
|
__GL_SHADER_DISK_CACHE=1
|
||||||
|
```
|
||||||
|
|
||||||
|
### Nvidia Shader Cache Settings
|
||||||
|
|
||||||
|
This section is based on a
|
||||||
|
[piece of documentation by Lutris](https://github.com/lutris/docs/blob/master/Performance-Tweaks.md#nvidia-gpu-only-optimization)
|
||||||
|
regarding performance optimization for systems with [Nvidia](/wiki/nvidia.md)
|
||||||
|
GPUs.
|
||||||
|
|
||||||
|
For Nvidia GPUs the shader cache is set to have a softlimit of 128MB.
|
||||||
|
This can be easily reached by some games and will cause performance limitations.
|
||||||
|
The cleanup of the cache after reaching 128MB can be disabled.
|
||||||
|
For this set `__GL_SHADER_DISK_CACHE_SKIP_CLEANUP` to `1` as explained in the
|
||||||
|
[section regarding environment variables](#setting-environment-variables).
|
||||||
|
|
||||||
|
By default Lutris uses a cache location for all games.
|
||||||
|
For better trouble shooting capabilities a unique shader location for each game
|
||||||
|
can be set.
|
||||||
|
This can be done with the [environment variable](#setting-environment-variables)
|
||||||
|
`__GL_SHADER_DISK_CACHE_PATH=</path/to/shaders/>` that has to be set as a per
|
||||||
|
game variable and adapted with a path of your choosing.
|
||||||
|
|
||||||
|
### Performance Tweaks
|
||||||
|
|
||||||
|
This section addresses ways of increasing the performance of games when run by
|
||||||
|
Lutris.
|
||||||
|
|
||||||
|
An easy way to increase the performance of games is to install and enable
|
||||||
|
[Feral GameMode](https://github.com/FeralInteractive/gamemode) as recommended in
|
||||||
|
the [documentation of Lutris](https://github.com/lutris/docs/blob/master/Performance-Tweaks.md#enable-game-mode).
|
||||||
|
It is important to install both the 64-bit and the 32-bit version to ensure full
|
||||||
|
functionality.
|
||||||
|
Check the package manager of your distribution for packages with the names
|
||||||
|
`gamemode` and `lib32-gamemode` or similar names or install it manually via git.
|
||||||
|
Afterwards check in Lutris `Preferences` if `Enable Feral GameMode` is checked
|
||||||
|
under the `Global options` tab.
|
||||||
|
|
||||||
|
Another way to increase the performance is to increase the
|
||||||
|
[Nvidia Shader Cache](#nvidia-shader-cache-settings) limit.
|
||||||
|
|
||||||
|
### Installing Windows DLLs
|
||||||
|
|
||||||
|
Select the game in the `Games` tab of the library.
|
||||||
|
Then select the upwards arrow next to the [WINE](/wiki/linux/wine.md) symbol in
|
||||||
|
the bar at the lower screen.
|
||||||
|
Select `Winetricks` and `Select the default wineprefix` in the window
|
||||||
|
afterwards.
|
||||||
|
After selecting `Install a Windows DLL or component` the package to install can
|
||||||
|
be selected.
|
||||||
|
|
||||||
|
### Change WINE/Proton Version
|
||||||
|
|
||||||
|
[Windows](/wiki/windows/windows.md) games are handled by
|
||||||
|
[WINE](/wiki/linux/wine.md).
|
||||||
|
After right-clicking a game and selecting `Configure` the `Wine version` can be
|
||||||
|
changed under the `Runner options` tab.
|
||||||
|
There are many different versions of WINE, WINE-fshack and various
|
||||||
|
[Proton](/wiki/games/proton.md) and
|
||||||
|
[Proton GE versions](/wiki/games/proton.md#ge-version) to select.
|
||||||
|
Using the default runner of [Bottles called Caffe](/wiki/games/bottles.md#caffe)
|
||||||
|
is also possible.
|
||||||
|
|
||||||
|
## Troubleshooting
|
||||||
|
|
||||||
|
This section explains ways of solving various problems that can occur when using
|
||||||
|
Lutris.
|
||||||
|
|
||||||
|
### DX12/DX13 is not Supported on Your System
|
||||||
|
|
||||||
|
This section handles a fix if the game is not able to run due to the system not
|
||||||
|
supporting DX12 or DX13.
|
||||||
|
This can be easily fixed by inserting `-dx11` in `Arguments` under the
|
||||||
|
`Game options` tab that pops up after selecting `Configure` for a selected game.
|
||||||
|
|
||||||
|
### Crashes for Windows Games
|
||||||
|
|
||||||
|
When it comes to crashes for [Windows](/wiki/windows/windows.md) games that get
|
||||||
|
handled by [WINE](/wiki/linux/wine.md) one point of failure is the selected
|
||||||
|
WINE version.
|
||||||
|
Change the version used as explained in
|
||||||
|
[the regarding section](#change-wineproton-version).
|
||||||
|
Especially trying [Proton GE versions](/wiki/games/proton.md#ge-version) or
|
||||||
|
WINE fshack versions can lead to successful running of the game.
|
||||||
|
Specific games also benefit from running [Caffe](/wiki/games/bottles.md#caffe).
|
||||||
@ -0,0 +1,47 @@
|
|||||||
|
# Medieval 2: Total War
|
||||||
|
|
||||||
|
Medieval 2: Total War is a game from the [Total War](https://www.totalwar.com)
|
||||||
|
series.
|
||||||
|
|
||||||
|
## Mods
|
||||||
|
|
||||||
|
### Third Age: Total War - Divide and Conquer
|
||||||
|
|
||||||
|
[Divide and Conquer](https://www.moddb.com/mods/divide-and-conquer) is a submod
|
||||||
|
for the [Third Age Total War](https://www.moddb.com/mods/third-age-total-war)
|
||||||
|
mod.
|
||||||
|
It is a Lord of the Rings themed mod, not only adding a large array of new
|
||||||
|
units, castles and factions, but converting it to a setting based in
|
||||||
|
Middle-earth.
|
||||||
|
|
||||||
|
#### Setup (Windows)
|
||||||
|
|
||||||
|
For Windows guides follow the official installation guide at
|
||||||
|
[MOD DB](https://www.moddb.com/mods/divide-and-conquer/).
|
||||||
|
|
||||||
|
#### Setup (Linux)
|
||||||
|
|
||||||
|
The installation guide for this mod is based on
|
||||||
|
[Laetus'](http://www.twcenter.net/forums/showthread.php?724777-Third-Age-and-Linux)
|
||||||
|
post in the Total War Center Forum and assumes Medieval 2: Total War was
|
||||||
|
purchased via [Steam](./steam.md) and being on a linux system.
|
||||||
|
For installation the latest version needs to be downloaded from
|
||||||
|
[MOD DB](https://www.moddb.com/mods/divide-and-conquer/downloads/).
|
||||||
|
Following this run the executable (`.exe`) file with [wine](../linux/wine.md)
|
||||||
|
and select not the game but a newly createt folder.
|
||||||
|
The executable will create many files in the directory.
|
||||||
|
At last it will open a dialog for large adress awareness, which you can
|
||||||
|
immediately close without further actions.
|
||||||
|
The important files are located in a subdirectory called `mods`.
|
||||||
|
Rename all the files and directories under the `mods` folder to lowercase.
|
||||||
|
This can be done by running
|
||||||
|
`find . -depth -exec perl-rename 's/(.*)\/([^\/]*)/$1\/\L$2/' {} \;` after
|
||||||
|
changing the working directory to the `mods` folder.
|
||||||
|
`perl-rename` can be called just `rename` depending on the distribution.
|
||||||
|
Rename the directory below the `mods` folder to `third_age`.
|
||||||
|
`third_age` now has to be moved to the modding folder of Medieval 2: Total War.
|
||||||
|
This folder named `mods` too can be found on the top level of the game
|
||||||
|
directory.
|
||||||
|
Lastly you need to change the launch options in steam.
|
||||||
|
Open `Properties` of Medieval 2: Total War and set the launch options under the
|
||||||
|
general tab to `--features.mod=mods/third_age`
|
||||||
@ -0,0 +1,28 @@
|
|||||||
|
# MultiMC5
|
||||||
|
|
||||||
|
[MultiMC5](https://multimc.org) is a custom launcher that allows multiple
|
||||||
|
[Minecraft](./minecraft.md) instances installed at once.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
### Adding OptiFine to a Minecraft instance
|
||||||
|
|
||||||
|
[OptiFine](https://www.optifine.net/home) is a Minecraft optimization mod.
|
||||||
|
The following steps show how to add optifine to a MultiMC5 Minecraft instance.
|
||||||
|
It is based on a comment by
|
||||||
|
[FuchsFuchs1](https://gist.github.com/jspanos71/32dc422eb4435a8f8dd5604e7a77c327).
|
||||||
|
The setup uses the [Fabric Mod Loader](https://fabricmc.net/) together with
|
||||||
|
[OptiFabric](https://www.curseforge.com/minecraft/mc-mods/optifabric) to make
|
||||||
|
OptiFine available.
|
||||||
|
|
||||||
|
- If not already done create an instance on MultiMC5
|
||||||
|
- Select `Edit Instance`, navigate to `Version` and `Install Fabric`
|
||||||
|
- Download the version of
|
||||||
|
[OptiFabric](https://www.curseforge.com/minecraft/mc-mods/optifabric/files)
|
||||||
|
according to your Minecraft version
|
||||||
|
- Navigate to `Loader Mods` and press `Add`, then select the downloaded
|
||||||
|
OptiFabric file
|
||||||
|
- Download the version of [OptiFine](https://optifine.net/downloads) according
|
||||||
|
to your Minecraft version
|
||||||
|
- Navigate to `Loader Mods` and press `Add`, then select the downloaded
|
||||||
|
OptiFine file
|
||||||
@ -0,0 +1,43 @@
|
|||||||
|
# PPSSPP
|
||||||
|
|
||||||
|
[PPSSPP](https://ppsspp.org/) is a Playstation Portable (PSP)
|
||||||
|
[emulator](./emulators.md).
|
||||||
|
|
||||||
|
## Setup
|
||||||
|
|
||||||
|
PPSSPP can be installed on different systems, a list for this can be found on
|
||||||
|
the [PPSSPP website](https://ppsspp.org/downloads.html).
|
||||||
|
Additionally it can be installed using [Flatpak](../linux/flatpak.md) where the
|
||||||
|
package is called `org.ppsspp.PPSSPP`.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
The following sections describe specific issues relating to the configuration
|
||||||
|
and usage of PPSSPP.
|
||||||
|
|
||||||
|
### Steam Deck specific settings
|
||||||
|
|
||||||
|
The following settings are especially useful when emulating PSP games on the
|
||||||
|
[Steam Deck](./steam_deck.md) as pointed out by
|
||||||
|
[nchristopher](https://github.com/nchristopher/steamdeck-emulation/blob/main/emulators/ppsspp.md).
|
||||||
|
But it is a good starting point for other systems aswell.
|
||||||
|
It is important to emphasize that the system needs to meet the requirements to
|
||||||
|
run Vulkan.
|
||||||
|
The Device name will change if you are not using a
|
||||||
|
[Steam Deck](./steam_deck.md).
|
||||||
|
|
||||||
|
- Backend: `Vulkan`
|
||||||
|
- Device: `AMD RADV VANGOGH`
|
||||||
|
- Fullscreen: `on`
|
||||||
|
- VSync: `on`
|
||||||
|
- Rendering solution: `Auto (1:1)`
|
||||||
|
- Upscale level: `2x`
|
||||||
|
- Upscale type: `Hybrid + Bicubic`
|
||||||
|
- Deposterize: `on`
|
||||||
|
|
||||||
|
### Running a game without selection in the menu
|
||||||
|
|
||||||
|
To run a game instantly the path to the [ROM](./emulators.md) needs to be
|
||||||
|
appended to the command used for starting PPSSPP.
|
||||||
|
This should be made in quotation marks as it could contain characters that need
|
||||||
|
to be escaped.
|
||||||
@ -0,0 +1,48 @@
|
|||||||
|
# Proton
|
||||||
|
|
||||||
|
[Proton](https://github.com/ValveSoftware/Proton) is a compatibility tool for
|
||||||
|
[Steam](./steam.md) by its developers, [Valve](https://www.valvesoftware.com),
|
||||||
|
based on [WINE](../linux/wine.md).
|
||||||
|
|
||||||
|
## GE-Version
|
||||||
|
|
||||||
|
[Proton GE](https://github.com/GloriousEggroll/proton-ge-custom) is a community
|
||||||
|
built version of Proton.
|
||||||
|
GE stands for Glorious Eggroll, the lead developer of Proton GE.
|
||||||
|
It often contains fixes for bugs which are not yet included in the official
|
||||||
|
Proton releases.
|
||||||
|
Thus some games, that do not work with Proton, can be run with Proton GE.
|
||||||
|
|
||||||
|
## Setup
|
||||||
|
|
||||||
|
Proton and [Proton GE](#ge-version) can be installed on Linux systems by using the
|
||||||
|
[ProtonUp](https://github.com/AUNaseef/protonup) application using
|
||||||
|
[Flatpak](../linux/flatpak.md) or the package manager of the distribution.
|
||||||
|
ProtonUp is usually bundled in a package named `protonup-qt`.
|
||||||
|
It can be used to install Proton GE versions for both
|
||||||
|
[Steam](/wiki/games/steam.md) and [Lutris](/wiki/games/lutris.md).
|
||||||
|
|
||||||
|
## Troubleshooting
|
||||||
|
|
||||||
|
This section addresses various errors that can happen when using Proton.
|
||||||
|
|
||||||
|
### Errors with the Wine prefix of a specific game
|
||||||
|
|
||||||
|
The last ressort for fixing problems that are related to the wine prefix of a
|
||||||
|
game is to delete the Wine prefix.
|
||||||
|
For this the id of the Steam game first has to be known.
|
||||||
|
This is done by navigating to the Steam website or the community page of the
|
||||||
|
specific game.
|
||||||
|
The URLs will have one of the following forms where the game id can be read:
|
||||||
|
|
||||||
|
```
|
||||||
|
http://steamcommunity.com/app/<game id>/
|
||||||
|
http://store.steampowered.com/app/<game id>/
|
||||||
|
```
|
||||||
|
|
||||||
|
After that navigate to the place your Steam games are stored.
|
||||||
|
You can remove `<steam location>/steamapps/compatdata/<game id>` to reset the
|
||||||
|
Wine prefix completely.
|
||||||
|
It is recommended to keep a backup of the folder containing the old Wine prefix
|
||||||
|
as it stores game saves and other important data, that can be useful.
|
||||||
|
|
||||||
@ -0,0 +1,19 @@
|
|||||||
|
# Sid Meier's Civilization VI
|
||||||
|
|
||||||
|
[Sid Meier's Civilization VI](https://civilization.com/de-DE/) is a round-based
|
||||||
|
strategy game which is available as a standalone Launcher for Windows and on
|
||||||
|
[Steam](./steam.md) and many other video game distribution services.
|
||||||
|
|
||||||
|
## Troubleshooting
|
||||||
|
|
||||||
|
### Problems launching with [Proton](./steam.md)
|
||||||
|
|
||||||
|
Due to the standalone launcher of Civilization VI being used in the startup
|
||||||
|
process of steam, it can be useful to skip the launcher by
|
||||||
|
setting the following line as launch options in the general tab of
|
||||||
|
steams game related settings:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
eval $( echo "%command%" | sed "s/2KLauncher\/LauncherPatcher.exe'.*/Base\/Binaries\/Win64Steam\/CivilizationVI'/" )
|
||||||
|
```
|
||||||
|
|
||||||
@ -0,0 +1,101 @@
|
|||||||
|
# Steam
|
||||||
|
|
||||||
|
[Steam](https://store.steampowered.com/) is a software for digital game
|
||||||
|
destribution.
|
||||||
|
It is developed by [Valve](https://www.valvesoftware.com).
|
||||||
|
Steam uses its compatibility layer, [Proton](./proton.md) for running windows
|
||||||
|
games on linux based operating systems.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
### Adding non-Steam Games
|
||||||
|
|
||||||
|
Games that are not in the Steam store can be added to the Steam application.
|
||||||
|
This is done by opening (the desktop mode) of Steam and selecting
|
||||||
|
`Add a Non-Steam Game to My Library` under the `Games` tab in the top left
|
||||||
|
corner.
|
||||||
|
A dialog window will open to select the software to add to Steam.
|
||||||
|
Check the box or boxes of the software to add to Steam and tap
|
||||||
|
`Add Selected Programs`.
|
||||||
|
|
||||||
|
For games such as launchers a `Launch Option` can be set most of the time to
|
||||||
|
skip the launcher and go directly into the specified game.
|
||||||
|
This option usually mirrors the command that would be used in the command line
|
||||||
|
of a system to go directly into the game.
|
||||||
|
Often this is done by simply appending the path of the specified game to the
|
||||||
|
command but this can also differ depending on the launcher.
|
||||||
|
|
||||||
|
Websites can be added by setting `xdg-open "<url/ip>"` as the `Launch Option`.
|
||||||
|
This will open the website with the Steam browser.
|
||||||
|
|
||||||
|
### Setting Icons and Banners for Games
|
||||||
|
|
||||||
|
Images for games can be changed by downloading them and applying them manually.
|
||||||
|
An easier route can be taken by using
|
||||||
|
[SGDBoop](https://www.steamgriddb.com/boop).
|
||||||
|
To use it, you first need to install it.
|
||||||
|
It is available in the [flatpak package manager](../linux/flatpak.md).
|
||||||
|
After that navigate to the
|
||||||
|
[SteamGridDB website](https://www.steamgriddb.com/boop) and log in with your
|
||||||
|
Steam account.
|
||||||
|
Follow the remaining steps as described on the website.
|
||||||
|
Following this different images, banners and icons can be found on
|
||||||
|
[the website](https://www.steamgriddb.com/).
|
||||||
|
When hovering over an asset a little blue button will appear.
|
||||||
|
On the press of the button a game can be chosen that will use the asset in the
|
||||||
|
Steam application.
|
||||||
|
Make sure the game is a Steam game or
|
||||||
|
[added to Steam as a non-Steam game](#adding-non-steam-games).
|
||||||
|
After the installation of the game, the system may need to restart to correctly
|
||||||
|
work with [SGDBoop](https://www.steamgriddb.com/boop) for the game.
|
||||||
|
|
||||||
|
## Steam Cloud
|
||||||
|
|
||||||
|
The [Steam Cloud](https://partner.steamgames.com/doc/features/cloud) allows
|
||||||
|
games and the platform to utilize cloud storage hosted by Steam.
|
||||||
|
Games can use this to store data including game settings and saves.
|
||||||
|
|
||||||
|
### Synchronize games saves without non-Steam-Cloud
|
||||||
|
|
||||||
|
By using [Syncthing](../syncthing.md) game saves can be synchronized without
|
||||||
|
the Steam Cloud.
|
||||||
|
First set up Syncthing as described in the
|
||||||
|
[Syncthing entry](../syncthing.md#setup).
|
||||||
|
If the [Steam Deck](./steam_deck.md) or another system with only user access is
|
||||||
|
used the
|
||||||
|
[user space configuration](../syncthing.md#user-space-configuration-for-linux)
|
||||||
|
is recommended.
|
||||||
|
Afterwards move the game saves to the directory set up by Syncthing and create
|
||||||
|
symbolic links to link them back to the original place.
|
||||||
|
|
||||||
|
## Error Handling
|
||||||
|
|
||||||
|
The following section addresses errors that can handle inside Steam or game
|
||||||
|
errors that are specific to Steam.
|
||||||
|
|
||||||
|
### Store Wishlist Displays More Items Than Shown
|
||||||
|
|
||||||
|
It is possible for the counter of the Steam wishlist to display more games than
|
||||||
|
the number of games shown when showing the wishlist.
|
||||||
|
This happens when a game is removed from the Steam store but still being on the
|
||||||
|
wishlist.
|
||||||
|
To remove it navigate to the wishlist in a browser like
|
||||||
|
[Firefox](/wiki/firefox.md).
|
||||||
|
Press `F12` to open up the developer tools.
|
||||||
|
Then navigate to the `Console` tab and enter `g_rgWishlistData` in it.
|
||||||
|
It will display the list of games inside the wishlist.
|
||||||
|
Identify the game that has been removed and is not shown in the wishlist
|
||||||
|
anymore.
|
||||||
|
Remember the `appid` of the game
|
||||||
|
Then run the following command inside the console and change `<appid>`
|
||||||
|
accordingly.
|
||||||
|
|
||||||
|
```js
|
||||||
|
$J.post( g_strWishlistBaseURL + 'remove/', {
|
||||||
|
'appid' : <appid>,
|
||||||
|
'sessionid' : g_sessionID
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
By running this the game will be removed from the wishlist causing it to display
|
||||||
|
the correct number of games.
|
||||||
@ -0,0 +1,20 @@
|
|||||||
|
# Steam Deck
|
||||||
|
|
||||||
|
The [Steam Deck](https://store.steampowered.com/steamdeck) is a handheld gaming
|
||||||
|
computer made by the same developers as [Steam](./steam.md),
|
||||||
|
[Valve](https://www.valvesoftware.com).
|
||||||
|
Due to its form factor it can be used especially well to play games that need a
|
||||||
|
controller, such as many games that run on [emulators](./emulators.md).
|
||||||
|
But by adding a USB-hub and connecting keyboard and mouse it can be used to
|
||||||
|
play classical PC games aswell.
|
||||||
|
As the Steam Deck is using a linux based operating system all the windows based
|
||||||
|
games are run with the help of [Proton](./proton.md).
|
||||||
|
The Steam Deck includes the Flatpak based [Discover](../linux/flatpak.md)
|
||||||
|
software management suite to install additional software.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
### Shortcuts
|
||||||
|
|
||||||
|
- Esc: `STEAM + D-Pad Left`
|
||||||
|
- Show Keyboard: `STEAM + X`
|
||||||
@ -0,0 +1,11 @@
|
|||||||
|
# Hauk
|
||||||
|
|
||||||
|
Hauk is a selfhostable location sharing server that can be used with the Hauk
|
||||||
|
app that is available at
|
||||||
|
[F-Droid](https://f-droid.org/packages/info.varden.hauk/) and
|
||||||
|
[Google Play Store](https://play.google.com/store/apps/details?id=info.varden.hauk).
|
||||||
|
|
||||||
|
## Setup
|
||||||
|
|
||||||
|
The server can be setup via [Docker](/wiki/docker.md) with the
|
||||||
|
[bilde2910 image](/wiki/docker-images/bilde2910_-_hauk.md).
|
||||||
@ -0,0 +1,32 @@
|
|||||||
|
# Jackett
|
||||||
|
|
||||||
|
[Jackett](https://github.com/Jackett/Jackett) is an application that is
|
||||||
|
intended to manage multiple [BitTorrent](/wiki/bittorrent.md) indexers.
|
||||||
|
One of its main usecases is in feeding indexers to the
|
||||||
|
[\*ARR applications](/wiki/*arr.md).
|
||||||
|
|
||||||
|
## Setup
|
||||||
|
|
||||||
|
The software can be setup via [Docker](/wiki/docker.md) with the
|
||||||
|
[DyonR image](/wiki/docker-images/dyonr_-_jackettvpn.md) which also features a
|
||||||
|
VPN tunnel.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
### Adding an Indexer
|
||||||
|
|
||||||
|
Indexers can be added by simply clicking `Add indexer` in the main menu.
|
||||||
|
For private or semi-private trackers login information or a cookie is needed.
|
||||||
|
|
||||||
|
### Adding a Jackett Indexer to \*ARR applications
|
||||||
|
|
||||||
|
For adding a Jackett Indexer to an \*ARR application press `Copy Torznab Feed`
|
||||||
|
of the Jackett indexer you want to add.
|
||||||
|
Paste this in the \*ARR application under
|
||||||
|
`Settings`, `Indexers`, `Add`, `Torznab` and `Custom` in the `URL` field.
|
||||||
|
Also copy and paste the Jackett API key into the corresponding field in the
|
||||||
|
\*ARR application.
|
||||||
|
Afterwards check and configure the correct category IDs via the `Categories`
|
||||||
|
option.
|
||||||
|
The list of supported categories can be found in the Jackett indexer
|
||||||
|
configuration (the wrench in the corresponding index list entry).
|
||||||
@ -1,23 +1,61 @@
|
|||||||
# Jellyfin
|
# Jellyfin
|
||||||
|
|
||||||
[Jellyfin](https://jellyfin.ord) is a suite for multimedia streaming.
|
[Jellyfin](https://jellyfin.ord) is a suite for multimedia streaming.
|
||||||
It includes a web-interface.
|
It includes a web-interface and is mainly used for
|
||||||
|
[movies and tv shows](./movies_&_tv_shows.md).
|
||||||
|
|
||||||
## Server
|
## Setup
|
||||||
|
|
||||||
A server can be setup via docker with the [linuxserver image](./docker-images/linuxserver_-_jellyfin.md).
|
The software can be setup via [Docker](/wiki/docker.md) with the
|
||||||
|
[linuxserver image](./docker-images/linuxserver_-_jellyfin.md).
|
||||||
|
|
||||||
## Add IP-TV
|
## Usage
|
||||||
|
|
||||||
|
This section addresses various features of invidious.
|
||||||
|
|
||||||
|
### Live TV and DVR
|
||||||
|
|
||||||
|
Jellyfin can connect to live TV with different tuners to display and record TV
|
||||||
|
channels - so called DVR - directly via jellyfin.
|
||||||
|
|
||||||
|
#### Live TV with M3U Tuner
|
||||||
|
|
||||||
You can add IP-TV under `Live TV` in the administration panel.
|
You can add IP-TV under `Live TV` in the administration panel.
|
||||||
To include a m3u IP-TV stream just put the file on the server or copy its URL
|
To include a M3U IP-TV stream just put the file on the server or copy its URL
|
||||||
and add it under `Live TV`.
|
and add it under `Live TV`.
|
||||||
After that make sure to setup `DVR` to your liking to record.
|
After that make sure to setup `DVR` to your liking to record.
|
||||||
|
|
||||||
## Handling of movies consisting of multiple files
|
#### Live TV and DVR with TVHeadend
|
||||||
|
|
||||||
|
This section explains the steps neccessary to make [TVHeadend](./tvheadend.md)
|
||||||
|
work with a jellyfin server according to the
|
||||||
|
[official documentation](https://jellyfin.org/docs/general/server/plugins/tvheadend/).
|
||||||
|
It is assumed a working TVHeadend instance is up and running.
|
||||||
|
In the [TVHeadend entry](./tvheadend.md) a guide to run an instance is given.
|
||||||
|
In the admin dashboard install the
|
||||||
|
[TVHeadend plugin](https://jellyfin.org/docs/general/server/plugins/tvheadend/)
|
||||||
|
and restart the server.
|
||||||
|
Afterwards create a user with a username in TVHeadend under
|
||||||
|
`Go to Configuration > Users > Access Entries > Add`.
|
||||||
|
Check the `Change Parameters`
|
||||||
|
`Rights`, `Channel number range`, `Channel tags`, `DVR configurations`,
|
||||||
|
`Streaming profiles` and `Connection limits`.
|
||||||
|
Check the `Streaming Profiles` `htsp`, `matroska`, `pass`,
|
||||||
|
`webtv-h264-aac-matroska`, `webtv-h264-aac-mpegts`, `webtv-h264-vorbis-mp4` and
|
||||||
|
`webtv-vp8-vorbis-webm`.
|
||||||
|
Check `Enabled` and `Web Interface`.
|
||||||
|
Select `Basic`, `Advanced` and `HTSP` under `Streaming` and `Basic`, `HTSP` and
|
||||||
|
`View all` under `Video recorder`.
|
||||||
|
Save the user.
|
||||||
|
Create a password via `Configuration > Users > Passwords > Add`.
|
||||||
|
Check `Enabled`, select the according `Username` and fill in the `Password`.
|
||||||
|
Afterwards save.
|
||||||
|
|
||||||
|
Now in Jellyfin under `Go to Dashboard > Plugins > TVHeadend > Settings` set
|
||||||
|
the `TVHeadend Hostname or IP Address`, the `HTTP Port` and `HTSP Port`, the
|
||||||
|
`Username` and the `Password` set in the previous step.
|
||||||
|
|
||||||
Jellyfin does not have the capability to seamlessly transition between multiple
|
Finally run `Refresh Guide Data` under `Dashboard > Live TV > Live TV` to load
|
||||||
files of a movie.
|
the guide data for the next 7 days aswell as to refresh the TV channels.
|
||||||
The easiest way to achieve a seamless movie experience is to concatenate the two
|
Afterwards the channels [mapped in TVHeadend](./tvheadend.md#adding-channels)
|
||||||
movie files.
|
should appear in the `Live TV` Library.
|
||||||
This can be done with [ffmpeg](./linux/ffmpeg.md).
|
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in new issue