FreeNAS Service jails

Manual setup of various services in FreeNAS jails. I have found manually set up services to be much more reliable then using FreeNAS' built in plugins.

Deluge

Setup of a jail for deluge server.

FreeNAS Configuration

User

Use the media user from FreeNAS, It's important to check the UID and GID match up with the user's for any datasets shared with the jail. I have found the media user is usually already correctly matched.

Create a dataset for deluge and mount to your desired location inside the jail. Mount the desired location inside the jail, I mounted mine to the ${HOME}/.config directory of my deluge user.

jail

The following sections were done inside the jail.

Install Deluge

Install deluge or deluge-cli depending on what you want installed. Since this is a headless server I'm only installing the CLI version.

pkg update && pkg upgrade
pkg install deluge-cli

Init Script

Setup /etc/rc.conf

sysrc 'deluged_enable=YES' 'deluged_user=media'

Start Service

service deluged start

Couchpotato

Install couchpotato freebsd version from git.

FreeNAS UI

Create database dataset couchpotato and mount to /var/db/couchpotato.

pkg update && pkg upgrade

Install required tools

pkg install python py27-sqlite3 fpc-libcurl docbook-xml git-lite

Use user media, clone to a temp repo in /var/db.

cd /var/db
git clone https://github.com/CouchPotato/CouchPotatoServer.git temp

Move the bare repo that was just cloned to the dataset we mounted earlier to /var/db/couchpotato.

mv temp/.git couchpotato/
rm -rf temp

Switch to the media user and reset the repo to HEAD.

su media
cd couchpotato
git reset --hard HEAD
exit

As root, copy the startup script to /usr/local/etc/rc.d and make the startup script executable.

cp couchpotato/init/freebsd /usr/local/etc/rc.d/couchpotato
chmod 555 /usr/local/etc/rc.d/couchpotato

Read the options at the top of /usr/local/etc/rc.d/couchpotato.

If not using the default install, specify options with startup flags.

sysrc 'couchpotato_enable=YES'
sysrc 'couchpotato_user=media'
sysrc 'couchpotato_dir=/var/db/couchpotato'

Finally, start couchpotato.

service couchpotato start

Restart the jail, open your browser and go to http://server:5050/.

Emby

FreeNAS

Create dataset, mount at /var/db/emby

Jail

In the jail, update all packages and install emby-server.

pkg update && pkg upgrade
pkg install emby-server

FFMpeg

It's recommended to install ffmpeg from ports so that certain compile time options can be enabled.

Update the FreeBSD ports tree

portsnap fetch extract update

Remove the default ffmpeg package

pkg delete -f ffmpeg

Reinstall FFMpeg from ports with lame option enabled

cd /usr/ports/multimedia/ffmpeg && make config

• enable the lame option

• enable the ass subtitles option

• enable the opus subtitles option

• enable the x265 subtitles option

Compile and install.

make install clean

ImageMagick

It is recommended to recompile the graphics/ImageMagick package from ports with the following options .

• disable (unset) 16BIT_PIXEL (to increase thumbnail generation performance)

Delete the imagemagick pkg.

pkg delete -f imagemagick

Install from ports

cd /usr/ports/graphics/ImageMagick && make config

• Disable the 16BIT_PIXEL option

make install clean

Emby Start Options

Set the rc script executable.

chmod 555 /usr/local/etc/rc.d/emby-server

Check the options.

less /usr/local/etc/rc.d/emby-server

Set emby to start on boot and change the options based on setup.

sysrc 'emby_server_enable=YES'
sysrc 'emby_server_user=media'
sysrc 'emby_server_group=media'
sysrc 'emby_server_data_dir=/var/db/emby-server'

Start the emby service.

service emby-server start

Pod

In Jail

Enter jail.

jexec pod tcsh

Update.

pkg update && pkg upgrade

Requirements

pkg install bash libxslt wget curl

bash requires fdescfs(5) mounted on /dev/fd, add to boot tasks in FreeNAS UI.

mount -t fdescfs fdesc /mnt/tank/jails/pod/dev/fd

Create User

Create user 'pod'.

adduser pod
Username: pod
Full name: Podcatcher
Uid (Leave empty for default):
Login group [pod]:
Login group is pod. Invite pod into other groups? []: media
Login class [default]:
Shell (sh csh tcsh git-shell nologin) [sh]: bash
Home directory [/home/pod]:
Home directory permissions (Leave empty for default):
Use password-based authentication? [yes]:
Use an empty password? (yes/no) [no]: yes
Lock out the account after creation? [no]:
Username   : pod
Password   : <blank>
Full Name  : Podcatcher
Uid        : 1001
Class      :
Groups     : pod media
Home       : /home/pod
Home Mode  :
Shell      : /usr/local/bin/bash
Locked     : no
OK? (yes/no): yes
adduser: INFO: Successfully added (pod) to the user database.
Add another user? (yes/no): no
Goodbye!

Install bashpod

Clone the script.

su pod
cd /home/pod
git clone https://github.com/johnramsden/bashpod.git

FreeNAS Task

In order to run from FreeNAS, create a new task that runs the bashpod script.

jexec -U pod pod /usr/local/bin/bash -c "/home/pod/bashpod/bashpod.sh"

Sabnzbd

FreeNAS

Create dataset, mount at /var/db/sabnzbd

Jail

Enter jail.

jexec sickrage tcsh

Update and install sabnzbd.

pkg update && pkg upgrade && pkg install sabnzbdplus

sysrc 'sabnzbd_enable=YES'
sysrc 'sabnzbd_user=media'
sysrc 'sabnzbd_group=media'
sysrc 'sabnzbd_conf_dir=/var/db/sabnzbd'

Restart jail

Edit config in /var/db/sabnzbd, change host to 0.0.0.0

SickRage

In Jail

Enter jail.

jexec sickrage tcsh

Update.

pkg update && pkg upgrade

Install requirements.

pkg install py27-sqlite3

Install SickRage.

cd /var/db
git clone  https://github.com/SickRage/SickRage.git temp
mv temp/.git sickrage/
rm -rf temp
chown -R media:media sickrage/
su media
cd sickrage/
git reset --hard HEAD
ls runscripts/

Copy the startup script

cp /var/db/sickrage/runscripts/init.freebsd /usr/local/etc/rc.d/sickrage

Make startup script executable

chmod 555 /usr/local/etc/rc.d/sickrage

Add settings to rc.conf

sysrc 'sickrage_enable=YES'
sysrc 'sickrage_user=media'
sysrc 'sickrage_group=media'
sysrc 'sickrage_dir=/var/db/sickrage'

Start SickRage.

service sickrage start

Syncthing

Create User Syncthing

On FreeNAS with ID 983, nologin

In Jail

Enter jail.

jexec syncthing tcsh

Update and install syncthing.

pkg update && pkg upgrade && pkg install syncthing

Add the following to rc.conf:

sysrc 'syncthing_enable=YES'
sysrc 'syncthing_user=syncthing'
sysrc 'syncthing_group=syncthing'
sysrc 'syncthing_dir=/var/db/syncthing'

Configure

Start syncthing as an initial test:

service syncthing start

Edit vim /var/db/syncthing/config.xml and change the IP address which the GUI will be accessible from. This will enable accessing the GUI from a remote computer:

Before:

<gui enabled="true" tls="false">
 <address>127.0.0.1:8384</address>;
 <apikey>xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</apikey>;
</gui>

After:

<gui enabled="true" tls="false">
 <address>0.0.0.0:8384</address>;
 <apikey>xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</apikey>;
</gui>

Restart the service for changes to apply:

service syncthing restart

Finally, access the GUI by pointing a browser to the server's address and port, ie http://SERVER_URL:8384.