UnRAID Installation

Pre-Release Instructions

These instructions are not applicable while TCM is in pre-release. Please refer to here.

Benefits of Docker

For more info on the benefits of Docker, see here.

On UnRAID, the Communnity Apps store can be used to load a template for configuring and launching TitleCardMaker with all the necessary Docker variables and paths.

Navigate to the UnRAID WebGUI home page for your server.
Select the APPS tab from the top toolbar.
In the search bar, search for titlecardmaker.
Click the first result, and in the actions (just below the container name), click Install.
You will be prompted to choose which branch (or tag) to install, make your selection and continue.

Choosing the Right Branch

For most users, I recommend the default latest branch. This branch is updated with the most recent public release of TitleCardMaker, and is the most stable option.

For users who are okay with the occasional bug, and would like to test out features as they are developed, then choose the develop tag.
UnRAID will take you to the Docker template, where you can edit the details of the container as you'd like. There are three settings to take note of, all other settings can be adjusted within TitleCardMaker.
1. The Config Directory. This is where TitleCardMaker will keep all images, files, databases, logs, etc. The default path is recommended.
2. The Group ID (GID). This needs to be valid group ID on your host UnRAID system that has both Read and Write access to the above directories. This is commonly 100.
3. The User ID (UID). This needs to be a valid user ID on your host UnRAID system that has both Read and Write access to the above directories. This is commonly 99.
  
  Why Specify a User and Group?
  
  Specifying a specific user and group ID allows TitleCardMaker to launch and run as that user. This is recommended over the alternative of allowing the container to run as the root user, which could theoretically have permission implications.
  Finding a Specific Group and User ID
  
  If you have a specific user on your system you'd like to use, in the UnRAID terminal, type the following command:
```
id {user}
```
  Replacing {user} with the name of the user you'd like to get the ID's of.
After finalizing your settings, select Apply.
UnRAID will begin downloading the Docker container. After it's finished, go back to the DOCKER tab, click the newly created TitleCardMaker container, and then select WebUI from the dropdown.

Success

Installation is complete, and TitleCardMaker is ready to be configured.