Commit 620b3e7e authored by Nick Busey's avatar Nick Busey

Adding Raddar/Sonnar, Jackett, and TheLounge documentation

parent fef83346
Pipeline #33382775 passed with stages
in 33 seconds
......@@ -41,7 +41,6 @@ If you have the latest version of Vagrant and Virtual Box setup you can demo thi
## Included Software
* [Bitwarden](https://bitwarden.com/) - Password and secrets manager via [bitwarden-rs](https://github.com/dani-garcia/bitwarden_rs)
* [Convos](https://convos.by/) - Always-on IRC client (IRC bouncer)
* [Darksky](http://darksky.net/) - Local weather reported via [darksky-influxdb](https://github.com/ErwinSteffens/darksky-influxdb)
* [Dasher](https://github.com/maddox/dasher) - Amazon Dash button support
* [Documentation](https://nickbusey.gitlab.io/HomelabOS/) - Offline, searchable documentation via [MkDocs](https://www.mkdocs.org/)
......@@ -65,6 +64,7 @@ If you have the latest version of Vagrant and Virtual Box setup you can demo thi
* [Radarr](https://radarr.video/) - Automated movie downloading
* [Sonarr](https://sonarr.tv/) - Automated TV downloading
* [Telegraf](https://www.influxdata.com/time-series-platform/telegraf/) - Server statistics reporting
* [The Lounge](https://thelounge.chat/) - Always-on IRC client (IRC bouncer)
* [Transmission](https://transmissionbt.com/) - BitTorrent client
## Requirements
......
# Jackett
[Jackett](https://github.com/Jackett/Jackett) provides API Support for your favorite torrent trackers.
## Configuration
It is important to secure Jackett! Access the Jackett dashboard with the links below,
scroll down to the `Jackett Configuration` section, and set a value for `Admin Password`.
Hit `Set Password` and you should be good to go.
Set up some indexers in the interface, and now in [Sonarr](/software/sonarr.md) and
[Radarr](/software/radarr.md) you can setup the link to Jackett.
## Access
The dashboard is available at [https://jackett.{{ domain }}/](https://jackett.{{ domain }}/) or [http://jackett.{{ domain }}/](http://jackett.{{ domain }}/)
It is also available via Tor at [http://jackett.{{ tor_domain }}/](http://jackett.{{ tor_domain }}/)
\ No newline at end of file
# Radarr / Sonarr
[Radarr](https://radarr.video/) (Automated movie downloading) and [Sonarr](https://sonarr.tv/) (Automated TV downloading) work esentially the same, so the documentation below applies to both.
## Configuration
To make either Sonarr or Radarr work, you need to configure an
Indexer and a Downlad Client.
The Indexer will be [Jackett](/software/jackett.md). Configure
Jackett first, once that is done, in either Sonarr or Radarr, go
to `Settings` then the `Indexers` tab, and click the Plus button.
Select the `Custom` button undernear `Torznab` and enter
`Jackett` for the name, for the URL enter `http://jackett:9117/api/v2.0/indexers/all/results/torznab/`
and for the API Key, enter the API key that Jackett displays
on it's Dashboard.
Next go to the `Download Client` tab, toggle the `Advanced Settings`
toggle in the top right to `Shown`, then click the Plus button,
select `Transmission`. Enter `transmission` for host,
`9091` for port, and your transmission username and password in
their respective fields. In Sonarr, enter `/tv` under `Directory`
and in Radarr enter `/movies`. This points to the same folders
[Emby](/software/emby.md) reads from, so they should be automatically
detected by Emby if you set this up correctly.
Now if you add some content, either a movie to Radarr or
a TV series to Sonarr, they will automatically be searched
and downloaded according to your settings.
## Access
Sonarr available at [https://sonarr.{{ domain }}/](https://sonarr.{{ domain }}/) or [http://sonarr.{{ domain }}/](http://sonarr.{{ domain }}/)
It is also available via Tor at [http://sonarr.{{ tor_domain }}/](http://sonarr.{{ tor_domain }}/)
Radarr available at [https://radarr.{{ domain }}/](https://radarr.{{ domain }}/) or [http://radarr.{{ domain }}/](http://radarr.{{ domain }}/)
It is also available via Tor at [http://radarr.{{ tor_domain }}/](http://radarr.{{ tor_domain }}/)
\ No newline at end of file
# Terminal
[Butterfly](georgeyord/butterfly-web-terminal) is available as a simple web terminal.
## Access
It is available at [https://terminal.{{ domain }}/](https://terminal.{{ domain }}/) or [http://terminal.{{ domain }}/](http://terminal.{{ domain }}/)
It is also available via Tor at [http://terminal.{{ tor_domain }}/](http://terminal.{{ tor_domain }}/)
\ No newline at end of file
# TheLounge
[TheLounge](https://thelounge.chat/) is a web based IRC client that syncs nicely across devices, and stays online
when you aren't.
## Configuration
To turn TheLounge from a public instance to a private (highly recommended) run the following commands
on your server. Run `sed -i 's/public: true/public: false/' /var/homelabos/thelounge/config.js`, then
restart the container with `docker restart homelabos_thelounge_1`, then create a user with
`docker exec -it homelabos_thelounge_1 thelounge add <username>` and follow the prompts.
Now you should be able to login with the username and password you created at the URLs below,
and have your session automatically sync between multiple devices.
## Access
The dashboard is available at [https://thelounge.{{ domain }}/](https://thelounge.{{ domain }}/) or [http://thelounge.{{ domain }}/](http://thelounge.{{ domain }}/)
It is also available via Tor at [http://thelounge.{{ tor_domain }}/](http://thelounge.{{ tor_domain }}/)
\ No newline at end of file
......@@ -10,10 +10,11 @@ theme:
pages:
- Home: index.md
- Installation: setup/installation.md
- Getting Started: setup/gettingstarted.md
- Setup:
- Installation: setup/installation.md
- Getting Started: setup/gettingstarted.md
- Backups: setup/backups.md
- SMTP: setup/smtp.md
- Tor Onion Services: setup/tor.md
- VPN Setup: setup/vpn.md
- Included Software:
......@@ -28,14 +29,17 @@ pages:
- Grafana: software/grafana.md
- Home Assistant: software/homeassistant.md
- InfluxDB: software/influxdb.md
- Jackett: software/jackett.md
- Koel: software/koel.md
- Matomo: software/matomo.md
- Minio: software/minio.md
- Miniflux: software/miniflux.md
- Minio: software/minio.md
- Monica: software/monica.md
- NextCloud: software/nextcloud.md
- Paperless: software/paperless.md
- Pi-hole: software/pihole.md
- Portainer: software/portainer.md
- Terminal: software/terminal.md
- Radarr / Sonarr: software/radarr-sonarr.md
- Synchthing: software/syncthing.md
- The Lounge: software/thelounge.md
- Transmission: software/transmission.md
......@@ -255,8 +255,15 @@ services:
- /etc/localtime:/etc/localtime:ro
environment:
- TZ={{ timezone }}
ports:
- 9117:9117
labels:
- "traefik.enable=true"
- "traefik.http.frontend.rule=Host:jackett.{{ domain }}"
- "traefik.http.protocol={{ protocol }}"
- "traefik.http.port=9117"
- "traefik.http.frontend.headers.customFrameOptionsValue=ALLOW-FROM https://{{ domain }}"
- "traefik.tor.frontend.rule=Host:jackett.{{ tor_domain }}"
- "traefik.tor.protocol={{ protocol }}"
- "traefik.tor.port=9117"
# kibitzr:
# image: peterdemin/kibitzr
......@@ -626,28 +633,6 @@ services:
- "traefik.tor.protocol={{ protocol }}"
- "traefik.tor.port=9000"
# TV Downloader
sonarr:
image: linuxserver/sonarr
restart: always
environment:
- PGID=1000
- PUID=1000
- TZ={{ timezone }}
links:
- jackett
- transmission
volumes:
- /etc/localtime:/etc/localtime:ro
- /var/homelabos/sonarr/config:/config
- /mnt/nas/TV:/tv
- /var/homelabos/sonarr/downloads:/downloads
labels:
- "traefik.enable=true"
- "traefik.http.frontend.rule=Host:sonarr.{{ domain }}"
- "traefik.http.protocol={{ protocol }}"
- "traefik.http.port=8989"
# Movie Downloader
radarr:
image: linuxserver/radarr
......@@ -669,6 +654,9 @@ services:
- "traefik.http.frontend.rule=Host:radarr.{{ domain }}"
- "traefik.http.protocol={{ protocol }}"
- "traefik.http.port=7878"
- "traefik.tor.frontend.rule=Host:radarr.{{ tor_domain }}"
- "traefik.tor.protocol={{ protocol }}"
- "traefik.tor.port=7878"
# Backups https://nickbusey.gitlab.io/HomelabOS/software/restic/
restic:
......@@ -689,6 +677,31 @@ services:
- /etc/localtime:/etc/localtime:ro
- /var/homelabos:/data:ro
# TV Downloader
sonarr:
image: linuxserver/sonarr
restart: always
environment:
- PGID=1000
- PUID=1000
- TZ={{ timezone }}
links:
- jackett
- transmission
volumes:
- /etc/localtime:/etc/localtime:ro
- /var/homelabos/sonarr/config:/config
- /mnt/nas/TV:/tv
- /var/homelabos/sonarr/downloads:/downloads
labels:
- "traefik.enable=true"
- "traefik.http.frontend.rule=Host:sonarr.{{ domain }}"
- "traefik.http.protocol={{ protocol }}"
- "traefik.http.port=8989"
- "traefik.tor.frontend.rule=Host:sonarr.{{ tor_domain }}"
- "traefik.tor.protocol={{ protocol }}"
- "traefik.tor.port=8989"
# Sync Server
syncthing:
image: linuxserver/syncthing
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment