Add images to unraid walkthrough page

This commit is contained in:
Chaz Larson 2024-05-03 19:08:29 +00:00
parent 73abdc8124
commit aa5aa85472
4 changed files with 18 additions and 9 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 89 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

View file

@ -39,7 +39,7 @@ Thats a command youre going to type or paste into your unRAID Kometa `>_Co
**IMPORTANT NOTES:** **IMPORTANT NOTES:**
* If you were not aware, the unRAID app store leverages Docker containers. As such, we are tweaking the existing Docker container walkthrough to make it work on unRAID. This walkthrough is going to be pretty pedantic. Im assuming youre reading it because you have no idea how to get this going on unRAID, so Im proceeding from the assumption that you want to be walked through every little detail. Youre going to deliberately cause errors and then fix them as you go through it. This is to help you understand what exactly is going on behind the scenes so that when you see these sorts of problems in the wild you will have some background to understand whats happening. If I only give you the happy path walkthrough, then when you make a typo later on youll have no idea where that typo might be or why its breaking things. * The unRAID app store leverages Docker containers. As such, we are tweaking the existing Docker container walkthrough to make it work on unRAID. This walkthrough is going to be pretty pedantic. Im assuming youre reading it because you have no idea how to get this going on unRAID, so Im proceeding from the assumption that you want to be walked through every little detail. Youre going to deliberately cause errors and then fix them as you go through it. This is to help you understand what exactly is going on behind the scenes so that when you see these sorts of problems in the wild you will have some background to understand whats happening. If I only give you the happy path walkthrough, then when you make a typo later on youll have no idea where that typo might be or why its breaking things.
* You may want to take an hour to get familiar with Docker fundamentals with the [official tutorial](https://www.docker.com/101-tutorial/). * You may want to take an hour to get familiar with Docker fundamentals with the [official tutorial](https://www.docker.com/101-tutorial/).
@ -60,15 +60,19 @@ To install a container from docker hub, you will need community applications - a
1. Head to the `Apps` tab of unRAID (Community Applications), and search `kometa` in the upper left search box. There will be a couple of results shown, but you should ignore them ([Why?](images.md)) and use the official image. 1. Head to the `Apps` tab of unRAID (Community Applications), and search `kometa` in the upper left search box. There will be a couple of results shown, but you should ignore them ([Why?](images.md)) and use the official image.
![](images/unraid-options.png)
2. Click the `Install` button on the Template from Sohjiro's Repository Tools. 2. Click the `Install` button on the Template from Sohjiro's Repository Tools.
3. Choose which branch you want to run `latest`, `develop`, or `nightly`. 3. Choose which branch you want to run `latest`, `develop`, or `nightly`.
4. Set the `Console shell command:` to `Bash` 4. Set the `Console shell command:` to `Bash`
5. Click `Show more settings...` to set any [Environmental Variables](../environmental.md) you wish to use. **For the purposes of this walkthrough, the** `Container Path: /config` **path for the unRAID app is** `/mnt/user/appdata/Kometa/config` (_**Note the case of Kometa**_). Other than this, set the `KOMETA_TIME` variable to `5:00` under the `Show more settings...` 5. Verify that the `Container Path: /config` path for the unRAID app is `/mnt/user/appdata/Kometa/config`
6. Hit `Apply`, and allow unRAID to download the container. ![](images/unraid-appdata.png)
6. Hit `Apply`, and allow unRAID to download the image and build the container.
#### Important note on Docker images #### Important note on Docker images
@ -239,10 +243,12 @@ Add the `develop` tag to the image name in your `Repository:` setting for the Ko
``` ```
kometateam/kometa:develop kometateam/kometa:develop
^^^^^^^ ^^^^^^^
``` ```
This may not work if you are not using the official image; for example, it does not work with the lsio image. Enter that here in the template:
![](images/unraid-repo.png)
### I want to use the nightly branch ### I want to use the nightly branch
@ -250,10 +256,12 @@ Add the `nightly` tag to the image name in your `Repository:` setting for the Ko
``` ```
kometateam/kometa:nightly kometateam/kometa:nightly
^^^^^^^ ^^^^^^^
``` ```
This may not work if you are not using the official image; for example, it does not work with the lsio image. Enter that here in the template:
![](images/unraid-repo.png)
### I want to ensure I am using the master branch ### I want to ensure I am using the master branch
@ -261,8 +269,9 @@ Add the `latest` tag to the image name in your `Repository:` setting for the Kom
``` ```
kometateam/kometa:latest kometateam/kometa:latest
^^^^^^ ^^^^^^
``` ```
Enter that here in the template:
This is the only version tag supplied by the lsio image. ![](images/unraid-repo.png)