structure renewed: usage/setup

2 years ago · 05687b4a63
parent 91ada52958
commit 05687b4a63
23 changed files with 212 additions and 73 deletions
--- a/wiki/docker.md
+++ b/wiki/docker.md
@ -3,7 +3,7 @@
 Docker is a virtualization software that deploys docker containers.
 Due to easy handling and reproducable environments it is a useful tool.

-## Installation
+## Setup

 - Arch linux: run `pacman -S docker` to install docker
 - Ubuntu: visit [the official installation guide](https://docs.docker.com/engine/install/ubuntu/)
--- a/wiki/firefox.md
+++ b/wiki/firefox.md
@ -9,9 +9,10 @@ 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.

-## Settings
+## Configuration

-In Firefox the settings can be found in the menu on the right-hand side.
+Firefox has many possible settings and precerences.
+This section addresses possible settings and preferences for specific use cases.

 ### Scrolling

@ -19,22 +20,18 @@ 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`.

-## Configuration
-
-In Firefox a special side for configuration can be found by setting as the URL
-`about:config`.
-
 ### Sponsorings

 Sponsorings are embedded ads in Firefox.
-Enabling and disabling of sponsorings can be done at
+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.
-The configuration can be done at `browser.compactmode.show`.
+After navigating to `about:config` the configuration can be done at
+`browser.compactmode.show`.

 ## List of useful Firefox add-ons

--- a/wiki/git.md
+++ b/wiki/git.md
@ -3,9 +3,13 @@
 Git is probably the best version control system (VCS) there is.
 It's easy and can be lightweight, but also has tons of possibilities for using graphical (/web) user interfaces.

-## Client
+## Setup

-The Client is pretty simple to understand.
+Git consists of two parts: [a client](#client) and [a server](#server)
+
+### Client
+
+The client is pretty simple to understand.
 With only a handfull of commands you should be able to get your versioning going.
 For servers with web interfaces there are different cli tools to control it
 without using a browser.
@ -14,7 +18,14 @@ For most linux distributions it is packaged with the `git` package
 There is also an interactive
 [fixup guide by Seth Robertson](https://sethrobertson.github.io/GitFixUm/fixup.html).

-## Server with web interface
+### Server
+
+The server hosts the data that is needed for the versioning.
+A distinction can be made between
+[GUI-less servers](#server-without-graphical-interface) and
+[servers with a web-GUI](#server-with-web-interface).
+
+#### Server with web interface

 Web interfaces for git are quite useful for easily showing code to other people.
 Additionally it is easy to collaborate together.
@ -23,14 +34,18 @@ Additionally it is easy to collaborate together.
 - [Github](https://github.com) is the go to system for many people. Not
  selfhosted, owned by microsoft ([cli-tool](https://github.com/github/hub)).

-## Server without graphical interface
+#### Server without graphical interface

 If you don't need a bloated web-interface a more basic approach is more than enough.

 - [git-server-docker](./docker-images/jkarlos_-_git-server-docker.md) is a pretty
  basic docker-container for git.

-## Ignore files having local changes
+## Usage
+
+This section addresses various use cases and problems solvable with git.
+
+### Ignore files having local changes

 If you need to make changes to a file that are local you can run
 `config update-index --skip-worktree <file>`.
--- a/wiki/gitea.md
+++ b/wiki/gitea.md
@ -5,6 +5,11 @@ It is similar to Github but opensource.

 ## Setup

+Gitea as a [Git](./git.md) service consists of a [client](#client) and a
+[server](#server).
+
+### Server
+
 The software can be setup via docker with the
 [gitea image](./docker-images/gitea_-_gitea.md).
 Additionally to this a client is needed on the system that need access to the
--- a/wiki/golinks.md
+++ b/wiki/golinks.md
@ -3,12 +3,16 @@
 [Golinks](https://github.com/prologic/golinks) is a web app that can create and
 use bookmarks and run different searches by prefixes.

-## Setup
+## Server

 The software can be setup via docker with the
 [prologic image](./docker-images/prologic_-_golinks.md).

-### Client: Firefox
+## Usage
+
+This section addresses various features of Golinks.
+
+## Browser add-ons

 Add Golinks as a new search engine for firefox and set it as main search for the
 address bar as described in [the Firefox article](./firefox.md#add-a-new-search-engine).
--- a/wiki/invidious.md
+++ b/wiki/invidious.md
@ -9,7 +9,11 @@ It includes locally stored subscription management.
 The software can be setup via docker with the
 [iv-org image](./docker-images/iv-org_-_invidious.md).

-## Automatic redirect from YouTube
+## Usage
+
+This section addresses various use cases and problems solvable with invidious.
+
+### Automatic redirect

 There are various add-ons to redirect from YouTube links to your (or a public)
 invidious instance.
@ -19,7 +23,7 @@ or [privacy redirect](https://addons.mozilla.org/en-US/firefox/addon/privacy-red
 For Android there is
 [the UntrackMe app](https://framagit.org/tom79/nitterizeme) (available at [f-droid](./android/f-droid.md)).

-## Skip sponsorships in videos
+### Skip sponsorships in videos

 When using [Firefox](./firefox.md) SponsorBlock can be installed.
 This will skip YouTube video sponsors in YouTube and in Invidious.
--- a/wiki/jellyfin.md
+++ b/wiki/jellyfin.md
@ -9,19 +9,23 @@ It includes a web-interface and is mainly used for
 The software can be setup via docker with the
 [linuxserver image](./docker-images/linuxserver_-_jellyfin.md).

-## Live TV and DVR
+## 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
+#### Live TV with M3U Tuner

 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
 and add it under `Live TV`.
 After that make sure to setup `DVR` to your liking to record.

-### Live TV and DVR with TVHeadend
+#### 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
--- a/wiki/libreddit.md
+++ b/wiki/libreddit.md
@ -8,11 +8,15 @@ Reddit.
 The software can be setup via docker with the
 [spikecodes image](./docker-images/spikecodes_-_libreddit.md).

-## Automatic redirect from Reddit
+## Usage
+
+This section addresses various features of LibReddit.
+
+### Automatic redirect

 There are various add-ons to redirect from Reddit links to your (or a public)
 libreddit instance.
 For Firefox for example there is
 [privacy redirect](https://addons.mozilla.org/en-US/firefox/addon/privacy-redirect/).
-For Android there is
-[the UntrackMe app](https://framagit.org/tom79/nitterizeme) (available at [f-droid](./android/f-droid.md)).
+For Android there is [the UntrackMe app](https://framagit.org/tom79/nitterizeme)
+(available at [f-droid](./android/f-droid.md)).
--- a/wiki/linkding.md
+++ b/wiki/linkding.md
@ -3,12 +3,16 @@
 [Linkding](https://github.com/sissbruecker/linkding) is a self-hostable
 bookmarking and archiving service.

-## The software
+## Setup

 The software can be setup via docker with the
 [image by sissbrueckner](./docker-images/sissbrueckner_-_linkding.md).

-## Firefox add-on
+## Usage
+
+This section addresses various features of Linkding.
+
+### Browser add-on

 [On the firefox add-on site](https://addons.mozilla.org/de/firefox/addon/linkding-extension/)
 you can find an add-on for linkding.
--- a/wiki/mail.md
+++ b/wiki/mail.md
@ -1,8 +1,10 @@
-# Mail
+# E-mail

-Mail is not dead yet.
-But most of the programs used to interact with them are total trash.
-Nevertheless there are some really nice pieces of software to check out.
+E-mail is a method of exchanging electronic messages.
+
+## Setup
+
+E-mail usually consists of a [server](#server) and a [client](#client).

 ## Server

--- a/wiki/nextcloud.md
+++ b/wiki/nextcloud.md
@ -10,7 +10,11 @@ The software can be setup via docker with the
 When using NextCloud with a specific nginx configuration you have to append
 `'overwriteprotocol' => 'https',` to your `config/config.html`.

-## WebDAV
+## Usage
+
+This section addresses various features of NextCloud.
+
+### WebDAV

 You can access ownCloud via WebDAV with the link
 `https://<nextcloud instance>/remote.php/dav/files/<user>/<path to folder or file>`.
--- a/wiki/nitter.md
+++ b/wiki/nitter.md
@ -8,7 +8,11 @@ Twitter.
 The software can be setup via docker with the
 [zedeus image](./docker-images/zedeus_-_nitter.md).

-## Automatic redirect from Twitter
+## Usage
+
+This section addresses various features of Nitter.
+
+## Automatic redirect

 There are various add-ons to redirect from Twitter links to your (or a public)
 Nitter instance.
--- a/wiki/owncloud.md
+++ b/wiki/owncloud.md
@ -7,6 +7,15 @@ ownCloud is a free client-server cloud-service.
 The software can be setup via docker with the
 [owncloud image](./docker-images/owncloud.md).

+## Usage
+
+This section addresses various features of Owncloud.
+
+### WebDAV
+
+You can access ownCloud via WebDAV with the link
+`https://<owncloud instance>/remote.php/dav/files/<user>/<path to folder or file>`.
+
 ## Error handling

 ### Problems with a locked file
@ -20,8 +29,3 @@ Afterwards enable locking again by removing the added line.

 The reason I choose this process over editing the database file, is ease of use.
 The editing of the database is much more time consuming especially if run with docker.
-
-## WebDAV
-
-You can access ownCloud via WebDAV with the link
-`https://<owncloud instance>/remote.php/dav/files/<user>/<path to folder or file>`.
--- a/wiki/picard.md
+++ b/wiki/picard.md
@ -5,7 +5,11 @@ tagging software for [music or other audio files](./audio.md).
 It is able to tag a wide range of [audio codecs](./audio.md#audio-codecs)
 [flac](./flac_(codec).md) among others.

-## File naming
+## Usage
+
+This section addresses various features of picard.
+
+### File naming

 To enable the file renaming on saving check `Rename files when saving` in the
 preferences.
@ -14,7 +18,7 @@ The tags described used are based on the audio codec.
 In this section it is assumed the standard
 [flac tags](./flac_(codec).md#tagging) are used as described in this wiki.

-### Music
+#### Music

 The following is a basic script for renaming music files to the scheme
 `[<discnumber>.]<tracknumber>._<artist>_-_<title>`
@ -32,7 +36,7 @@ $num(%tracknumber%,$if($gt($len(%totaltracks%),2),$len(%totaltracks%),2))._
 %title%), ,_)
 ```

-### Audiobooks
+#### Audiobooks

 Another Script is mainly used for audiobooks, where the title is not part of
 the filename to avoid confusion.
--- a/wiki/portainer.md
+++ b/wiki/portainer.md
@ -5,10 +5,15 @@ also works with [Docker](./docker.md).

 ## Setup

+Portainer is a service that allows clustering.
+It consist of one [server](#server) and possibly multiple [agents](#agent).
+
+### Server
+
 The software can be setup via Docker with the
 [portainer image](./docker-images/portainer_-_portainer.md).

-## Configure an agent
+## Agent

-An agent is a cluster of Docker API proxies
+An agent is a cluster of Docker API proxies.
 An agent can be setup via Docker with the [portainer image](./docker-images/portainer_-_agent.md).
--- a/wiki/recommended_alternatives.md
+++ b/wiki/recommended_alternatives.md
@ -3,11 +3,9 @@
 This article is a list of proprietary hard- and software, its alternatives and other
 recommended, good software (mostly free and/or open-source).

-## Alternatives
-
 - **Fitness tracker apps** alternatives:
  - [GadgetBridge](https://codeberg.org/Freeyourgadget/Gadgetbridge) is a free and
-  cloudless alternative compatible with many devices.
+    cloudless alternative compatible with many devices.

 - [**Instagram**](https://instagram.com) alternatives:
  - [Bibliogram](./bibliogram.md) is an alternative frontend for instagram.
@ -16,34 +14,34 @@ recommended, good software (mostly free and/or open-source).
  - [ThunderBird](https://www.thunderbird.net/) is an open-source email client
    and an alternative to Microsoft Office.
  - [LibreOffice](https://www.libreoffice.org/) is a free and open-source office
-  software suite and an alternative to Microsoft Word, Excel and Powerpoint.
+    software suite and an alternative to Microsoft Word, Excel and Powerpoint.

 - [**Pocket**](https://getpocket.com/) alternatives:
  - [wallabag](./wallabag.md) is a self-hosted application for saving websites
-  to read them at a later point. It also saves the text of a site to the
-  application to make it available offline.
+    to read them at a later point. It also saves the text of a site to the
+    application to make it available offline.
  - [linkding](./linkding.md) is a self-hosted application for saving bookmarks
-  and archiving them. It features saving the current state of the sites with
-  [web archive](https://web.archive.org) and is lightweight.
+    and archiving them. It features saving the current state of the sites with
+    [web archive](https://web.archive.org) and is lightweight.

 - **Preinstalled Android apps** alternatives:
  - [SimpleMobileTools](https://www.simplemobiletools.com/) features a wide variety
-  of apps, that can replace the preinstalled apps (calendar, gallery, launcher, etc.).
+    of apps, that can replace the preinstalled apps (calendar, gallery, launcher, etc.).

 - **Preinstalled Windows programs** alternatives:
  - [ImageGlass](https://github.com/d2phap/ImageGlass) is a simple and open-source
-  image viewer for windows.
+    image viewer for windows.
  - [foobar2000](https://www.foobar2000.org/) is a freeware audio player for windows.

 - [**Reddit**](https://reddit.com) alternatives:
  - [Slide](https://github.com/ccrama/Slide) is a open-sourced Reddit browser for
-  Android. Slide does not feature local subscription management, so you will still
-  need a reddit account.
+    Android. Slide does not feature local subscription management, so you will still
+    need a reddit account.
  - [LibReddit](./libreddit.md) is an alternative private front-end to Reddit.

 - [**Twitter**](https://twitter.com) alternatives:
  - [Fritter](https://github.com/jonjomckay/fritter) is a free, open-source Twitter
-  client for Android and iOS. Fritter features local subscription management.
+    client for Android and iOS. Fritter features local subscription management.
  - [Nitter](./nitter.md) is a free and open source alternative frontend.

 - [**Watch2gether**](https://w2g.tv/) alternatives:
@ -51,11 +49,11 @@ recommended, good software (mostly free and/or open-source).

 - [**YouTube**](https://youtube.com) is a online video platform owned by Google.
  - [Invidious](./invidious.md) is a copyleft and open-source alternative frontend.
-  Invidious features local subscription management.
+    Invidious features local subscription management.
  - [NewPipe](https://newpipe.net/) is an free and open-source android youtube client.
-  NewPipe features local subscription management.
+    NewPipe features local subscription management.
  - [PeerTube](./peertube.md) is a free and decentralized video platform.
-  Creators that are on YouTube are not neccessarily on PeerTube and vice versa.
+    Creators that are on YouTube are not neccessarily on PeerTube and vice versa.

 - [**Google**](https://google.com) is a search engine.
  - [Searx](./searx.md) is a self-hostable meta-search engine that can be
@ -63,9 +61,10 @@ recommended, good software (mostly free and/or open-source).
  - [Whoogle](./whoogle.md) is another self-hostable meta-search engine that
    has a similar style to google.

-## Recommended Software
+- **SRS cards** are cards for learning vocabulary and more
+  - [anki](https://github.com/ankitects/anki) is an open-source tool to learn with
+    [SRS](https://en.wikipedia.org/wiki/Spaced_repetition) flashcards.

- [anki](https://github.com/ankitects/anki) is an open-source tool to learn with
-[SRS](https://en.wikipedia.org/wiki/Spaced_repetition) flashcards.
- [Webapps by tobykurien](https://github.com/tobykurien/webapps) is a tool to
-create sandboxed android apps of websites.
+- Convert a website to an app
+  - [Webapps by tobykurien](https://github.com/tobykurien/webapps) is a tool to
+    create sandboxed android apps of websites.
--- a/wiki/searx.md
+++ b/wiki/searx.md
@ -7,14 +7,18 @@
 The software can be setup via Docker with the
 [searx image](./docker-images/searx_-_searx.md).

-## Adding to Firefox
+## Usage
+
+This section addresses various features of Searx.
+
+### Browser support

 Add Searx as a new search engine for firefox and set it as main search for the
 address bar as described in [the Firefox article](./firefox.md).
 Follow the add-on part of the guide and put searx with
 `<url to searx instance>/search?q=%s` as search string.

-## Route search traffic through tor
+### Route search traffic through tor

 You can setup a torproxy with [the dperson image](./docker-images/dperson_-_torproxy.md).
 In the `settings.yml` file locate the section for `proxies :` and
--- a/wiki/subsonic.md
+++ b/wiki/subsonic.md
@ -6,7 +6,21 @@ It is non-free and closed-source.
 There are free and open-source alternatives named [Airsonic](./airsonic.md) and
 [Airsonic-Advanced](./airsonic-advanced.md).

-## Clients
+## Setup
+
+Subsonic is a service that consists of a [client](#client) and a
+[server](#server).
+
+### Server
+
+It is possible to use different servers.
+The following list contains a selection of servers.
+
+- [airsonic](./airsonic.md) is a free and open-source fork of subsonic.
+- [airsonic-advanced](./airsonic-advanced.md) is a free and open-source fork of
+  airsonic with new features.
+
+### Client

 It is possible to use different clients.
 The following list contains a selection of clients.
--- a/wiki/teamspeak3.md
+++ b/wiki/teamspeak3.md
@ -7,7 +7,11 @@
 The software can be setup via Docker with the
 [teamspeak image](./docker-images/teamspeak.md).

-## Link Teamspeak3 to a subdomain
+## Usage
+
+This section addresses various features of Teamspeak3.
+
+### Link Teamspeak3 to a subdomain

 To link Teamspeak3 to one of your subdomains you need to add a
 [DNS SRV-record](./dns.md#srv-record):
--- a/wiki/tor.md
+++ b/wiki/tor.md
@ -3,7 +3,11 @@
 [Tor](https://www.torproject.org/) is a free and open source software for anonymous
 communication via internet traffic.

-## Tor proxy
+## Usage
+
+This section features various features of Tor.
+
+### Tor proxy

 A tor proxy can be used to access `.onion` sites or to anonymize traffic.
 It can be set up using [docker](./docker-images/dperson_-_torproxy.md).
--- a/wiki/tvheadend.md
+++ b/wiki/tvheadend.md
@ -4,6 +4,9 @@
 streams to internet streams.
 It supports multiple dvb tuners and tuner sticks aswell as Sat>IP tuners.
 It also has the ability to record programs like a digital video recorder.
+TVHeadend has an
+[official documentation](https://docs.tvheadend.org/webui/config_dvr/) on its
+website.
 TVHeadend is compatible with [jellyfin](./jellyfin.md#connect-tvheadend) with
 the help of a plugin.

@ -11,6 +14,11 @@ the help of a plugin.

 The software can be setup via docker with the
 [linuxserver image](./docker-images/linuxserver_-_tvheadend.md).
+For different hardware there may be additional run options needed to get
+TVHeadend working properly.
+Additionally a solid [initial configuration](#initial-configuration) is
+recommended.
+This configuration includes the setup of different types of tuners.

 ### Fritzbox

@ -25,7 +33,30 @@ Setting up a linux system with additional IP addresses is described in

 The still needed setup is equal to the [setup for DVB-C Tuners](#dvb-c).

-### DVB-C
+### Initial configuration
+
+This subsection is about the recommended configurations for a TVHeadend
+instance.
+
+One of the most important configurations is the naming scheme of the recorded
+files.
+To change this setting navigate to
+`Configuration > Recording > Digital Video Recorder Profiles` and select your
+current profile.
+Under `Filesystem Settings` `Format string/Pathname specification` can be found.
+In the according
+[official documentation section](https://docs.tvheadend.org/webui/config_dvr/)
+The default format string and possible variations are specified there.
+The recommended Format string used by this guide is the following:
+`$t/$t$_e_%F$n.$x`.
+It will create a folder with the same name as the show for each show.
+The containing files are named with the title, the possible episode aswell as
+the date the show was recorded.
+If two files feature the same name an ascending number is added.
+This naming scheme is compatible with [Jellyfins](./jellyfin.md) `Other`
+content type.
+
+#### DVB-C

 In TVHeadend navigate to `Configuration > DBV Inputs > TV adapters`.
 Create a Network, select `Enabled`, set your `Network name`, select one of the
@ -51,7 +82,11 @@ Following this a list of TV and radio channels should appear in
 `Configuration > DBV Inputs > Services`.
 After this the setup is completed.

-## Adding channels
+## Usage
+
+This section addresses various features of TVHeadend.
+
+### Mapping channels

 Following the Setup you have a list of possible channels available at
 `Configuration > DVB Inputs > Service`.
@ -63,3 +98,14 @@ is displayed.
 There you can select `Numbers` by invoking `Edit` on the Channels.
 Under `Electronic Program Guide` a list of current and future programs is
 shown.
+
+### Scheduling a recording
+
+To record a show navigate to `Electronic Program Guide` after
+[adding the channel](#adding-channels) that is to be recorded.
+In the program guide a list of all shows is given.
+Left click on the show to record and select `Record` in the pop-up.
+To record all shows of the same name select `Autorec`.
+In `Digital Video Recorder` all `Upcoming/Current Recordings` can be seen and
+deleted if neccessary.
+In `Autorecs` the show names to record are listed.
--- a/wiki/wallabag.md
+++ b/wiki/wallabag.md
@ -7,7 +7,11 @@
 The software can be setup via Docker with the
 [wallabag image](./docker-images/wallabag_-_wallabag.md).

-## Add-ons for quick access
+## Usage
+
+This section addresses various features of Wallabag.
+
+## Browser add-ons

 [On the firefox add-on site](https://addons.mozilla.org/de/firefox/addon/linkding-extension/)
 you can find an add-on for wallabag.
--- a/wiki/whoogle.md
+++ b/wiki/whoogle.md
@ -8,7 +8,11 @@ metasearch engine.
 The software can be setup via docker with the
 [image by benbusby](./docker-images/benbusby_-_whoogle-search.md)

-## Adding to Firefox
+## Usage
+
+This section addresses various features of Whoogle.
+
+### Browser support

 Add Whoogle as a new search engine for firefox and set it as main search for the
 address bar as described in [the Firefox article](./firefox.md).