move

jailman/wiki/content/plugins/General

@@ -0,0 +1,5 @@
+## General Info
+
+Blueprints are the blueprint on which your created jails are going to be based.
+
+More info TBD

jailman/wiki/content/plugins/bazarr.md

@@ -0,0 +1,15 @@
+# Bazarr
+
+Bazarr is a companion application to Sonarr and Radarr. It manages and downloads subtitles based on your requirements. You define your preferences by TV show or movie and Bazarr takes care of everything for you.
+
+Be aware that Bazarr doesn't scan disk to detect series and movies: It only takes care of the series and movies that are indexed in Sonarr and Radarr.
+
+Thanks to the folks at OpenSubtitles for their logo that was an inspiration for ours.
+
+**For more information about Bazarr, please checkout:**
+
+https://github.com/morpheus65535/bazarr
+
+
+## Known issues
+- The Bazarr installer might throw SSL errors if your TrueNAS "date and time" settings are incorrect, these errors break the installation process.

jailman/wiki/content/plugins/bitwarden.md

@@ -0,0 +1,12 @@
+# Bitwarden_RS
+This is a Bitwarden server API implementation written in Rust compatible with [upstream Bitwarden clients](https://bitwarden.com/#download)*, perfect for self-hosted deployment where running the official resource-heavy service might not be ideal.
+
+**For more information about Bitwarden_RS, please checkout:**
+https://github.com/dani-garcia/bitwarden_rs
+
+## Configuration Parameters
+- admin_token: Long (preferable random) password to be used to open the Bitwarden_rs admin interface. Admin interface is disabled when empty
+- link_mariadb: MariaDB jail to be used for storing the database.
+- mariadb_database: The name of the database used for (encrypted) credential storage. defaults to the jail name. Will be created on first install.
+- mariadb_user: The name of the database user to be used for (encrypted) credential storage. defaults to the database name. Will be created on first install.
+- mariadb_password: The password of the database user to be used for (encrypted) credential storage. defaults to the database name. 

jailman/wiki/content/plugins/forked_daapd.md

@@ -0,0 +1,12 @@
+# forked-dappd
+
+This plugin installs forked-daapd with a current version of ffmpeg.
+As it compiles ffmepg from sources the initialisation takes a while (~25 minutes
+on a Xeon E3-1230 v5 @ 3.40GHz).
+
+#### Configuration parameters
+
+- itunes_media: Path to your itunes media that will be mounted in the jail. (ex. /mnt/tank/media/music/itunes/)
+
+`forked-daapd` needs to know the location of your iTunes Library. Add a `itunes_media:`
+section to your `config.yaml` with the  path to your itunes library as value.

jailman/wiki/content/plugins/grafana.md

@@ -0,0 +1,10 @@
+# Grafana
+Grafana allows you to query, visualize, alert on and understand your metrics no matter where they are stored. Create, explore, and share dashboards with your team and foster a data driven culture:
+
+**For more information about Grafana, please checkout:**
+https://grafana.com
+
+#### Configuration Parameters
+- password (req): The password for the default admin account (admin). Required.
+- link_influxdb (opt): set to the name of the influxdb jail to set as datasource, if desired. 
+- link_unifi (opt): set to the name of the Unifi jail with Unifi Poller to automatically get its data from influxdb. (requires link_influxdb)

jailman/wiki/content/plugins/influxdb.md

@@ -0,0 +1,5 @@
+# InfluxDB
+InfluxDB is an open source time series platform. This includes APIs for storing and querying data, processing it in the background for ETL or monitoring and alerting purposes, user dashboards, and visualizing and exploring the data and more. The master branch on this repo now represents the latest InfluxDB, which now includes functionality for Kapacitor (background processing) and Chronograf (the UI) all in a single binary.
+
+**For more information about InfluxDB, please checkout:**
+https://github.com/influxdata/influxdb

jailman/wiki/content/plugins/jackett.md

@@ -0,0 +1,9 @@
+## jackett 
+
+Jackett is tool designed to combine and search multiple bittorrent trackers like a proxy.
+
+**For more information about Jackett, please checkout:**
+https://github.com/Jackett/Jackett
+
+### Post-install
+Currently there are not relevant post-install steps, other than your own personal preferences for setting up Jacket.

jailman/wiki/content/plugins/kms.md

@@ -0,0 +1,5 @@
+# Py-KMS
+_py-kms_ is a port of node-kms created by [cyrozap](http://forums.mydigitallife.info/members/183074-markedsword), which is a port of either the C##, C++, or .NET implementations of KMS Emulator. The original version was written by [CODYQX4](http://forums.mydigitallife.info/members/89933-CODYQX4) and is derived from the reverse-engineered code of Microsoft's official KMS.
+
+**For more information about Py-KMS, please checkout:**
+https://github.com/SystemRage/py-kms

jailman/wiki/content/plugins/lazylibrarian.md

@@ -0,0 +1,4 @@
+# Plugin Template
+
+This Repository contains a templatate to base your plugin on.
+Please be aware: When submitting your plugin, this readme gets added to the Wiki

jailman/wiki/content/plugins/lidarr.md

@@ -0,0 +1,6 @@
+# Lidarr
+Lidarr is a music collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new tracks from your favorite artists and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available.
+
+**For more information about Lidarr, please checkout:**
+
+https://github.com/lidarr/Lidarr

jailman/wiki/content/plugins/mariadb.md

@@ -0,0 +1,11 @@
+# MariaDB
+MariaDB is designed as a drop-in replacement of MySQL(R) with more
+features, new storage engines, fewer bugs, and better performance.
+
+**For more information about MariaDB, please checkout:**
+https://github.com/MariaDB/server/
+
+## Configuration Parameters:
+ cert_email: Currently not used, but required due to a caddy bug.
+ root_password: The root password used for MariaDB
+

jailman/wiki/content/plugins/nextcloud.md

@@ -0,0 +1,19 @@
+# Nextcloud
+Nextcloud is the most deployed on-premises file share and collaboration platform. Access & collaborate across your devices. 
+
+**For more information about Nextcloud, please checkout:**
+https://nextcloud.com/
+
+## Configuration parameters:
+
+- time_zone: Is the time zone of your location, in PHP notation--see the [PHP manual](http://php.net/manual/en/timezones.php) for a list of all valid time zones.
+- cert_type: DNS_CERT, STANDALONE_CERT, SELFSIGNED_CERT, and NO_CERT determine which method will be used to generate a TLS certificate (or, in the case of NO_CERT, indicate that you don't want to use SSL at all).  DNS_CERT and STANDALONE_CERT indicate use of DNS or HTTP validation for Let's Encrypt, respectively.
+- cert_email: The email address Let's Encrypt will use to notify you of certificate expiration.  This is mandatory regardless of whether you're using Let's Encrypt (Caddy won't start without it), but it's only used with Let's Encrypt.  If you are **not** using one of the Let's Encrypt certificate options, you can set this to a dummy address as above.  If you **are** using Let's Encrypt, though, it should be set to a valid address for the system admin.
+- dns_plugin: If DNS_CERT is set, DNS_PLUGIN must contain the name of the DNS validation plugin you'll use with Caddy to validate domain control.  See the [Caddy documentation](https://caddyserver.com/docs) under the heading of "DNS Providers" for the available plugins, but omit the leading "tls.dns.".  For example, to use Cloudflare, set `DNS_PLUGIN="cloudflare"`.
+- dns_env: If DNS_CERT is set, DNS_ENV must contain the authentication credentials for your DNS provider.  See the [Caddy documentation](https://caddyserver.com/docs) under the heading of "DNS Providers" for further details.  For Cloudflare, you'd set `DNS_ENV="CLOUDFLARE_EMAIL=foo@bar.baz CLOUDFLARE_API_KEY=blah"`, using your the email address of your Cloudflare account and your Global API key--the newer API tokens aren't currently supported.
+- link_mariadb: The name of the MariaDB database jail you want to use.
+- mariadb_password: The Password for the mariadb database user you want to use. Will be created on first install.
+- mariadb_user: The name for the mariadb database user you want to use. Will be created on first install. Will default to the database name.
+- mariadb_database: The name of the mariadb database you want to use. Will be created on first install. Will default to the jail name.
+- admin_password: The password for the default Nextcloud admin user you want to create. Not created on reinstall.
+

jailman/wiki/content/plugins/organizr.md

@@ -0,0 +1,5 @@
+# Organizr
+Do you have quite a bit of services running on your computer or server?  Do you have a lot of bookmarks or have to memorize a bunch of ip's and ports?  Well, Organizr is here to help with that.  Organizr allows you to setup "Tabs" that will be loaded all in one webpage.  You can then work on your server with ease.  Want to give users access to some Tabs?  No problem, just enable user support and have them make an account.  Want guests to be able to visit too?  Enable Guest support for those tabs.
+
+**For more information about Organizr, please checkout:**
+https://github.com/causefx/Organizr

jailman/wiki/content/plugins/plex.md

@@ -0,0 +1,15 @@
+# Plex
+Plex gives you one place to find and access all the media that matters to you. From personal media on your own server, to podcasts, web shows, and news, to streaming music, you can enjoy it all in one app, on any device.
+
+**For more information about Plex, please checkout:**
+https://plex.tv
+
+#### Advanced config parameters:
+- ramdisk: Specify the `size` parameter to create a transcoding ramdisk under /tmp_transcode. Requires manual setting it un plex to be used for transcoding. (optional)
+
+
+#### Experimental config parameters:
+
+These parameters are either not fully tested or expected to break with short-term OS updates. They are included in the release however, because they are suspected to become stable eventually.
+
+- hw_transcode: set this to "true" to enable hardware transcoding on compatible systems, to "false" to disable or, preferable, just leave it out to disable

jailman/wiki/content/plugins/radarr.md

@@ -0,0 +1,7 @@
+# Radarr
+
+Radarr is an __independent__ fork of [Sonarr](https://github.com/Sonarr/Sonarr) reworked for automatically downloading movies via Usenet and BitTorrent.
+
+**For more information about Radarr, please checkout:**
+
+https://github.com/Radarr/Radarr

jailman/wiki/content/plugins/sabnzbd.md

@@ -0,0 +1,5 @@
+# Sabnzbd
+plugin for Sabnzbd news reader.
+
+**For more information about Sabnzbd, please checkout:**
+https://github.com/sabnzbd/sabnzbd

jailman/wiki/content/plugins/sabnzbd3.md

@@ -0,0 +1,7 @@
+# Sabnzbd v3
+
+SABnzbd is a multi-platform binary newsgroup downloader. The program works in the background and simplifies the downloading verifying and extracting of files from Usenet.
+V3. is the newest (beta) version of Sabnzbd
+
+**For more information about Sabnzbd, please checkout:**
+https://sabnzbd.org/

jailman/wiki/content/plugins/sonarr.md

@@ -0,0 +1,6 @@
+# Sonarr
+Sonarr is a PVR for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new episodes of your favorite shows and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available.
+
+**For more information about Sonarr, please checkout:**
+
+https://github.com/Sonarr/Sonarr

jailman/wiki/content/plugins/tautulli.md

@@ -0,0 +1,5 @@
+# Tautulli
+A python based web application for monitoring, analytics and notifications for [Plex Media Server](https://plex.tv).
+
+**For more information about Tautulli, please checkout:**
+https://github.com/Tautulli/Tautulli

jailman/wiki/content/plugins/template.md

@@ -0,0 +1,4 @@
+# Plugin Template
+
+This Repository contains a templatate to base your plugin on.
+Please be aware: When submitting your plugin, this readme gets added to the Wiki

jailman/wiki/content/plugins/traefik.md

@@ -0,0 +1,94 @@
+# Traefik
+
+Traefik is a reverse proxy, this means it sits in-between your servers and the internet. Often these reverse proxies also, just like traefik, function as SSL endpoints, this means they encrypt the traffic comming from/to your servers.
+
+Standalone without docker Traefik is quite a challenge to setup right. JailMan tries to make it as easy as possible for your, by doing most of the groundwork and tweaking for you.
+This also means we don't support all features of traefik. We use traefik as a central reverse proxy and ssl termination endpoint for all our jails. Nothing more, Nothing less.
+
+To make things as streamlined as possible we had to make choices. Hence we only support DNS-verification for certificate generation. No http(s) verification is included.
+
+
+**For more information about Traefik, please checkout:**
+https://containo.us/traefik/
+
+## Configuration Parameters
+
+Traefik requires a little more variables to setup in config.yml than other jails.
+Here is the list of configuration parameters:
+
+- dns_provider: The DNS provider you are using to verify ownership of the domain. This is required to get a letsencrypt certificate. We only support DNS-verification for certificate generation.
+- domain_name: The domain name you want to use to connect to traefik. Needs to be accessable at the DNS provider (cert_provider) with the DNS credentials (cert_env) provided.
+- cert_email: The email adress to link to the Lets Encrypt certificate
+- dashboard: set to "true" to enable the dashboard.
+- cert_env: For DNS verification we need login credentials and need to write those in a way Traefik understands. You can find the requirements for your DNS provider at the traefik website: https://docs.traefik.io/https/acme/
+You will need to use 2 spaces(!) in front and enter them below this configuration option. Like this:
+```
+	cert_env:
+	  CF_API_EMAIL: fake@email.adress
+	  CF_API_KEY: ftyhsfgufsgusfgjhsfghjsgfhj
+```
+
+### Advanced settings
+
+These settings are normally not required or normally used, but might come in handy for advanced users.
+- cert_staging: Set this to "true" if you want to test it out using the Lets Encrypt staging server. Set it to "false" or (preferable) just leave it out to use the production server.
+- cert_wildcard_domain: If you want to generate wildcard certificates, please enter the domain name here, without `*.` (ex. `test.testdomain.com`)
+- cert_strict_sni: set to "true" to enable strict SNI checking, set to false or (preferably) just leave it out to disable strict-SNI checking.
+- link_influxdb: This links traefik to a influxdb jail to store metrics data (influxdb_password required)
+- influxdb_password: this sets up a password to use for the influxdb database
+- traefik_auth_basic: Add basic authentication to the traefik dashboard itself (if used on the traefik jail) or another jail (if used on another jail)
+- traefik_forward_auth: Add forwarded authentication to the traefik dashboard itself (if used on the traefik jail) or another jail (if used on another jail)
+
+## Installing
+
+To make traefik as easy as possible to install, we advice to base your config.yml settings on the following example:
+```
+traefikjail:
+  blueprint: traefik
+  ip4_addr: 192.168.1.200/24
+  gateway: 192.168.1.1
+  dashboard: true
+  traefik_auth_basic: user:password user2:pass2
+  domain_name: traefik.test.placeholder.net
+  dns_provider: cloudflare
+  cert_staging: true
+  cert_email: fake@email.net
+  cert_wildcard_domain: test.placeholder.net
+  # Please follow the guide here: https://docs.traefik.io/https/acme/
+  # and enter your DNS providers environment variables below (2 spaces indent) of cert_env
+  cert_env:
+    CF_API_EMAIL: fake@email.adress
+    CF_API_KEY: ftyhsfgufsgusfgjhsfghjsgfhj
+  link_influxdb: influxdbjail
+  influxdb_password: traefikmetricspass
+```
+
+
+## Usages
+
+To add a jail to traefik, you will need a domain name (which can be accessed using the cert_env settings on traefik).
+If you have the domain name configured correctly on traefik, just add the following config parameter to the other jail (not traefik), where $traefikjail is the name of your traefik-jail:
+```
+  domain_name: myjail.test.com
+  traefik_proxy: $traefikjail
+```
+
+## Security
+
+If you want to add security to a jail, there are two opions: basic_auth or forward_auth.
+**basic_auth:**
+Basic_auth uses a simpel username and passowrd prompt before it allows anyone to open the site. It can be enabled by adding the following config parameter in addition to traefik_proxy.
+```
+  traefik_basic_auth: user1:password1 user2:password2
+
+```
+
+**forward_auth:**
+forward_auth checks if you already have access (http not-403) to another website. It's more advanced to setup, but it (for example) enables you to easily add central authentication to jails using organizr.
+The following is an example config, using an organizr jail. It needs to be added in addition to traefik_proxy:
+```
+  traefik_auth_forward: https://organizr.testdomain.com/api/?v1/auth&group=1
+
+```
+
+Although the web interface shows port 9080 and 9443, Traefik is actually also listening on the (more common) port 80 and 443, also known as normal (without port in the URL) http and https ports.

jailman/wiki/content/plugins/transmission.md

@@ -0,0 +1,5 @@
+# Transmission
+Transmission is a fast, easy, and free BitTorrent client.
+
+**For more information about Transmission, please checkout:**
+https://github.com/transmission/transmission

jailman/wiki/content/plugins/unifi.md

@@ -0,0 +1,26 @@
+# Unifi Controller
+The UniFi® Controller is a wireless network managementsoftware solution from Ubiquiti Networks™. It allows you tomanage multiple wireless networks using a web browser.
+
+**For more information about Unifi Controller, please checkout:**
+https://www.ui.com
+
+**For more information about Unifi Poller, please checkout:**
+https://github.com/unifi-poller/unifi-poller
+
+### Installation:
+
+- This jail requires an existing InfluxDB jail. InfluxDB may be created using the same install command, as long as influxdb is listed first.
+- Once the script runs, a user must be created in the Unifi Controller software for your Unifi-Poller user.
+- To view the data from Unifi-Poller, Grafana is required. Add the unifi InfluxDB database as a data source in Grafana.
+
+### Config Description
+
+- unifi_poller: boolean, true if you want to also install unifi-poller
+- link_influxdb: This is the name of your influxdb database jail, should be influxdb.
+- influxdb_database: The name of the database that will be created in influxdb for Unifi Poller.
+- influxdb_user & influxdb_password: The created database's credentials for Unifi Poller.
+- poller_user & poller_password: The Unifi-Poller user credentials. This user must be created in the Unifi Controller web gui after install matching these credentials. This is for the connection between Unifi Controller & Unifi Poller
+
+### Unifi-Controller Post-Install
+
+After the script runs and the unifi jail is running, open the web gui of the unifi jail at port 8443 (i.e. https://192.168.2.250:8443). After completing the initial setup wizard, go to Admins --> Add New Admin. Select "Manually set and share the password", enter the username and password used for up_user & up_password. Uncheck 'Require the user to change their password'. Verify "Role" is set to 'Read Only'. Click Create.