Ombi currently does not use the plugin system that TrueNAS uses so this will require more interaction from the user than what normally would be expected.
If you are not comfortable setting up a jail or using the shell please wait until someone adds it to the community plugin libary.
If you are installing from base FreeBSD you can adopt this guide as an general overview. TrueNAS uses iocage as jail manager so jail properties listed here will use its variable naming.
dotNET binaries should work in jails on FreeBSD kernel 11.3+. FreeNAS/TrueNAS users should use 12.2+ as the previous statement does not apply to you!
Ombi requires e_sqlite3 which is not buildable for FreeBSD. However, the sqlite3 package contains something that is "close enough". The installer will create a symlink /usr/local/lib/libe_sqlite3.so to help resolve this.
Finally, a UID/GID for Ombi is created by the installer. The UID/GID used is CURRENTLY marked as "free" so it should not cause conflicts.
-
From the main screen select Jails
-
Click ADD
-
Click Advanced Jail Creation
-
Name (any name will work): Ombi
-
Jail Type: Default (Clone Jail)
-
Release: 12.2-Release (or newer)
-
Configure Basic Properties to your liking add but add
-
VNET
- (While this is not a hard requirement, you may encouter networking issues. See: troubleshooting )
- Configure Jail Properties to your liking but add
-
allow_raw_sockets
- (Highly suggested for easier troubleshooting)
-
allow_mlock
- (This is REQUIRED)
-
Configure Network Properties to your liking
-
Configure Custom Properties to your liking
-
Click Save
Back on the jails list find your newly created jail for Ombi and click "Shell"
Download the version you want. You can find the releases of Ombi here: https://github.com/Thefrank/freebsd-port-sooners/releases
You can just copy and paste the full download URL and fetch will be able to download it. Here is an example:
fetch https://github.com/Thefrank/freebsd-port-sooners/releases/download/20211221/ombi-4.7.11.pkg
Now we install it:
pkg install ombi-4.7.11.pkg
Don't close the shell out yet we still have a few more things!
Now that we have it installed a few more steps are required.
Time to enable the service but before we do, a note:
The service file uses chown to make sure Ombi can update itself. This can break things like pkg check -s and pkg remove for Ombi when the built-in updater replaces files.
To enable the service:
sysrc ombi_enable=TRUE
If you do not want to use user/group Ombi you will need to tell the service file what user/group it should be running under
sysrc ombi_user="USER_YOU_WANT"
sysrc ombi_group="GROUP_YOU_WANT"
Ombi stores its data, config, logs, and PID files in /var/db/ombi by default. The service file will create this and take ownership of it IF AND ONLY IF IT DOES NOT EXIST. If you want to store these files in a different place (e.g., a dataset mounted into the jail for easier snapshots) then you will need to change it using sysrc
sysrc ombi_data_dir="DIR_YOU_WANT"
Reminder: If you are using an existing location then you will manually need to either: change the ownership to the UID/GID Ombi uses AND/OR add Ombi to a GID that has write access.
Almost done, let's start the service:
service ombi start
If everything went according to plan then Ombi should be up and running on the IP of the jail (port 5000)!
(You can now safely close the shell)
System.Net.Sockets.SocketException (43): Protocol not supported- Make sure you have
VNETturned on for your jail. - If you do not use
VNETthen settingip6=inheritfor the jail should also fix this.
- Make sure you have
libe_sqlite3errors- In rare cases, the installer might fail to make the symbolic link needed to run Ombi. Try
ln -s /usr/local/lib/libsqlite3.so /usr/local/lib/libe_sqlite3.so
- In rare cases, the installer might fail to make the symbolic link needed to run Ombi. Try