From 706a7105876408f211a1ca94ce52be22a2a90a2a Mon Sep 17 00:00:00 2001 From: crocs <34723037+pairofcrocs@users.noreply.github.com> Date: Wed, 30 Nov 2022 21:36:07 -0600 Subject: [PATCH] Update Installation.md (#373) * Update Installation.md updated Unraid install instructions --- docs/Installation.md | 29 ++++++++++++++++------------- 1 file changed, 16 insertions(+), 13 deletions(-) diff --git a/docs/Installation.md b/docs/Installation.md index b49295a7..bd8a321e 100644 --- a/docs/Installation.md +++ b/docs/Installation.md @@ -37,32 +37,35 @@ If you want to enable this behavior, you can follow [this example](https://techb ## Unraid -Tube Archivist, and all if it's dependencies are located in the [community applications](https://forums.unraid.net/topic/38582-plug-in-community-applications/) store. The three containers you will need are as follows: +Tube Archivist, and all if it's dependencies are located in the [community applications](https://unraid.net/community/apps?q=tubearchivist) store. The three containers you will need are as follows: - **TubeArchivist-RedisJSON**: This container acts as a cache and temporary link between the application and the file system. Used to store and display messages and configuration variables. -- **TubeArchivist-ES**: ElasticSearch stores video meta data and makes everything searchable. Also keeps track of the download queue. +- **TubeArchivist-ES**: ElasticSearch stores video metadata and makes everything searchable. Also keeps track of the download queue. - **TubeArchivist**: Once your YouTube video collection grows, it becomes hard to search and find a specific video. That's where Tube Archivist comes in: By indexing your video collection with metadata from YouTube, you can organize, search and enjoy your archived YouTube videos without hassle offline through a convenient web interface. ### Step 1: Install `TubeArchivist-RedisJSON` -![enter image description here](https://i.imgur.com/ycAqFRU.png) -This is the easiest container to setup of the thee, just make sure that you do not have any port conflicts, and that your `/data` is mounted to the correct path. The other containers will map to the same directory. +![TubeArchivist-RedisJSON](https://i.imgur.com/iGJZKYd.png) +This is the easiest container to setup of the thee, just make sure that you do not have any port conflicts, and that your `/data` is mounted to the correct path. The other containers will map to the same root directory (/mnt/user/appdata/TubeArchivist). If you need to install `TubeArchivist-RedisJSON`on a different port, you'll have to follow [these steps](https://github.com/tubearchivist/tubearchivist#redis-on-a-custom-port) later on when installing the `TubeArchivist` container ### Step 2: Install `TubeArchivist-ES` -![enter image description here](https://i.imgur.com/o6tsTdt.png) -ElasticSeach is also pretty easy to setup. Again, make sure you have no port conflicts, make sure that you mapped `/usr/share/elasticsearch/data` to the same directory as `RedisJSON`, and make sure to change the default password to something more secure. +![TubeArchivist-ES](https://i.imgur.com/RC38b3u.png) +ElasticSeach is also pretty easy to setup. Again, make sure you have no port conflicts, make sure that you mapped the ElasticSearch Data to the same root directory as `RedisJSON` (/mnt/user/appdata/TubeArchivist), and make sure to change the default password to something more secure. -There is three additional settings in the "show more settings" area, but leave those as they are. +There is four additional settings in the "show more settings" area, but don't require any changes. ### Step 3: Install `TubeArchivist` -![enter image description here](https://i.imgur.com/dwSCfgO.png) +![TubeArchivist](https://i.imgur.com/oLsmwBZ.png) It's finally time to set up TubeArchivist! + - `HOST:`This is a list of IP addresses that you will host TA from. Example, 192.168.0.14 is the IP address of my Unraid server. If I was going to access TA from a VPN, or domain name, I'd put those next to my host IP with just a space separating the different addresses. More information [here.](https://github.com/tubearchivist/tubearchivist#installing-and-updating) + + - `Port:`Again, make sure that you have no port conflicts on 8000. - `Youtube Media Path:` is where you'll download all of your videos to. @@ -72,23 +75,23 @@ It's finally time to set up TubeArchivist! wiki.](https://github.com/tubearchivist/tubearchivist/wiki/Settings#manual-media-files-import) -- `Appdata:` This should be the same base path as the other two containers. +- `Appdata:` This should be the same base path as the other two containers (/mnt/user/appdata/TubeArchivist). - `TA Username:`This will be your username for TubeArchivist. - `TA Password:`This will be your password for TubeArchivist. - - `Redis` This will be JUST the ip address of your redis container + - `Redis` This will be JUST the ip address of your redis container. - `ElasticSearch Password:`This is the password you defined in the `TubeArchivist-ES` container. - `ElasticSearch:` This seems to cause some confusion, but it's a pretty simple step, just replace the IP and Port to match you `TubeArchivist-ES` container. - (example: if your IP is 192.168.1.15, the value should be http://192.168.1.15:9200) + (example: if your IP is 192.168.0.14, the value should be http://192.168.0.14:9200) - `Time Zone:` This is an important step for your scheduler, to find your timezone, use a site like [TimeZoneConverter](http://www.timezoneconverter.com/cgi-bin/findzone.tzc) ### From there, you should be able to start up your containers and you're good to go! -If you're still having trouble, join us on [discord](https://discord.gg/AFwz8nE7BK) and come to the #unraid channel. +If you're still having trouble, join us on [discord](https://discord.gg/AFwz8nE7BK) and come to the #support channel.

@@ -282,4 +285,4 @@ Once all of the folders have been created, it should have a folder structure wit ### From there, you should be able to start up your containers and you're good to go! -If you're still having trouble, join us on [discord](https://discord.gg/AFwz8nE7BK) and come to the #synology channel. +If you're still having trouble, join us on [discord](https://discord.gg/AFwz8nE7BK) and come to the #support channel.