not logged in | [Login]

Unraid Cheat Sheet - Plex, Sonarr, Radarr, Home Assistant, PlexPy, VPN, Deluge, Jackett, Nginx

Helpful Commands

Check if a parity operation is in-progress

grep mdResync= /proc/mdcmd

Check the status of a parity operation. Wait for % complete is mdResyncPos/mdResyncSize.

/root/mdcmd status | egrep "mdResync|mdState|sbSync"

Helpful links

Setup notes

Setup Community Applications

This will allow you to search and install applications (plugins and docker containers).

VPN Setup

VPN Certificates

Create a share named vpn. Make it private so only you can read it. Next, download your VPN certs from your VPN provider's website and do the following:

  • Copy the following into that share: ca.crt, .crt, .key, ta.key, and one of the ovpn file you want to use
  • Rename the ovpn file to vpn.conf
  • Edit the vpn.conf file and put the full path where it references the certs. /vpn/ca.crt, etc...

VPN Container

  • Click the docker tab
  • Click Add container
  • Name: vpn
  • Repository: dperson/openvpn-client
  • Privileged: On
  • Path: /mnt/user/vpn/ -> Container Path: /vpn
  • Container Device: /dev/net/tun
  • Variable:
    • Name: FIREWALL
    • Value: true
  • Click Apply

Go to the docker tab. Look at the last column on the right for the VPN container, look at the logs, make sure things are OK. Should say "Initialization Sequence Completed". May take 5 minutes or more to complete.

Deluge

First setup Deluge.

  • Go to "Apps" tab and search for "Deluge" and add it. I use captinsano/deluge
  • Name: Deluge
  • Extra Parameters: --net="container:vpn"
  • Network Type: None
  • Privileged: Off
  • Add your paths for the media

The above configures Deluge but you won't be able to reach the web UI since the network type is set to "none". To reach it, we'll create a proxy with nginx, see the next section

nginx

Go to "Apps" tab and search for "nginx" and add it. I use linuxserver/nginx. Enter these settings:

  • Name: nginx
  • Repository: dperson/nginx
  • Extra Parameters: --link vpn:deluge -p 8112:8112
  • Network Type: Bridge
  • Host Port 1: 8080
  • Host Port 2: 8443
  • AppData Config Path: /mnt/user/appdata/nginx

In the /mnt/user/appdata/nginx, edit the nginx configuration file as needed. Here's mine, which includes a proxy_pass for deluge.

server {
  error_log /var/log/nginx/error.log;
  listen 80 default_server;
  listen 443 ssl;
  root /media/www;

  server_name 192.168.1.2:8080;

  ssl_certificate /config/keys/cert.crt;
  ssl_certificate_key /config/keys/cert.key;

  location /media/ {
    root /;
    autoindex on;
  }
}

server {
  error_log /var/log/nginx/error_8112.log;
  listen 8112;
  server_name 192.168.1.2:8112;

  location / {
    proxy_pass http://deluge:8112/;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header Host $host;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
  }
}

Now you can reach the Deluge web UI by going to http://:8112/

Home Assistant

This will get Home Assistant running with a Z-Wave USB stick.

  • Go to apps, install home-assistant
  • Network type: Host
  • Extra Parameters: select device
    • Name: ttyACM0
    • Value: /dev/ttyACM0
  • Privileged: On
  • Start the container.

Now edit the file /mnt/user/appdata/home-assistant/configuration.yaml and add the following two lines and then restart Home Assistant.

zwave:
  usb_path: /dev/ttyACM0

Jackett

  • Got to apps and search for linuxserver/jackett
  • Name: Jackett
  • Network Type: Bridge
  • Privileged: off
  • Host Port 1: 9117
  • Host Path 2: /mnt/user/media/downloads/

Plex Media Server

  • Go to apps and search for PlexMediaServer. I used the one from limetech/plex
  • Name PlexMediaServer
  • Network Type: Host
  • Privileged: on
  • Add a container path variable: /mnt/user/media/

PlexPy

  • Go to apps and search for plexpy. I use the one from linuxserver/plexpy
  • Name: PlexPy
  • Network Type: Bridge
  • Host Port 1: 8181
  • Host Path 1: /logs

Sonarr

  • Go to apps and search for sonarr. I use the one from linuxserver/sonarr
  • Name: Sonarr
  • Network Type: Bridge
  • Privileged: Off
  • Host Port 1: 8989

Radarr

  • Go to apps and search for radarr. I use the one from linuxserver/radarr
  • Name: Radarr
  • Network Type: Bridge
  • Privileged: Off
  • Host Port 1: 7878

# Below is optional
Go back to the docker tab
	edit "Dockergui-dev"
	make it use the "vpn" by going to the advanced view and put this in extra parameters:  --net="container:vpn"
	Set network type to "none"

Install dockergui
	go to the apps tab
	search for "dockergui" and install it. 
	on the next screen, use all the defaults
        Test that you can log into that and reach the internet

now you'll need a proxy so you can access the "Dockergui-dev" from your local network
	go add a new container
		name: proxy-dockergui
		Repository: dperson/nginx
		Extra Parameters: --link vpn:dockergui-dev -p 8080:80
		Variable: 
			Name: PROXY
			Key: PROXY
			Value: http://Dockergui-dev:8080/;/