tubearchivist/docs
1
0
Fork 0
mirror of https://github.com/tubearchivist/docs.git synced 2025-06-26 12:21:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update Unraid instructions to v0.5.x (#59)

Browse Source 
* Update unraid Instructions

update for v0.5.0+ changes, plus fixing a few broken links

* Delete mkdocs/docs/assets/unraid_redis_port.png

TA v0.5.0+ no longer uses the REDIS_PORT env variable.

* update unraid redis image

Updated unraid redis install screenshot per v0.5.0+

* update unraid ta container screenshot

per v0.5.0 changes, show redis connection string.

* Update unraid.md

fix image/text wraparound

* fix unraid relative links
This commit is contained in:
Styloy 2025-06-02 09:27:22 -04:00 committed by GitHub
parent 7e7779a640
commit 2ea97f67c2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 17 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
mkdocs/docs/assets/unraid_redis_install.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 43 KiB

After

Width:  |  Height:  |  Size: 39 KiB

BIN
mkdocs/docs/assets/unraid_redis_port.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 17 KiB

BIN
mkdocs/docs/assets/unraid_ta_install.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 86 KiB

After

Width:  |  Height:  |  Size: 84 KiB

41
mkdocs/docs/installation/unraid.md
View File

@ -1,23 +1,21 @@
!!! abstract "Installation Instructions - Community Guides"
These are beginner's guides/installation instructions for additional platforms generously provided by users of these platforms. When in doubt, verify the details with the [project README](https://github.com/tubearchivist/tubearchivist#installing). If you see any issues here while using these instructions, please contribute.
!!! warning "Outdated"
Please review these instructions and update it to the changes introduced in [v0.5.0](https://github.com/tubearchivist/tubearchivist/releases/tag/v0.5.0).
**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**: Redis functions as a cache and temporary link between the application and the file system. Redis is used to store and display messages and configuration variables.
- **TubeArchivist-Redis**: Redis functions as a cache and temporary link between the application and the file system. Redis is used to store and display messages and configuration variables.
- **TubeArchivist-ES**: Elasticsearch stores the video metadata and enables searchable functionality for all fields. Elasticsearch is also used to keep 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, and offline, through a convenient web interface.
## Installing Tube Archivist Applications
### Install `TubeArchivist-RedisJSON`
### Install `TubeArchivist-Redis`
![TubeArchivist-Redis](../assets/unraid_redis_install.png)
![TubeArchivist-RedisJSON](../assets/unraid_redis_install.png)
This is the easiest container to setup of the three, just make sure that you do not have any port conflicts and `/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](docker-compose.md#redis-on-a-custom-port) later on when installing the `TubeArchivist` container.
If you need to install `TubeArchivist-Redis` on a different port, you'll have to follow [these steps](docker-compose.md#redis-on-a-custom-port) later on when installing the `TubeArchivist` container.
If you're running into port collision errors, recreate the steps outline in the [docker compose installation instructions.](docker-compose.md/#redis-on-a-custom-port)
!!! tip
@ -26,9 +24,9 @@ If you're running into port collision errors, recreate the steps outline in the
### Install `TubeArchivist-ES`
![TubeArchivist-ES](../assets/unraid_es_install.png)
ElasticSeach is also pretty easy to setup. Again, make sure you have no port conflicts, that you mapped the ElasticSearch Data directory to the same root directory as `RedisJSON` (/mnt/user/appdata/TubeArchivist), and make sure to change the default password to something more secure.
ElasticSeach is also pretty easy to setup. Again, make sure you have no port conflicts, that you mapped the ElasticSearch Data directory to the `es` directory in the TubeArchivist root directory (/mnt/user/appdata/TubeArchivist/es), and make sure to change the default password to something more secure.
There are four additional settings in the "show more settings" area, but they don't usually require any changes.
There are four additional settings in the "show more settings" area that you should be aware of, particularlly the Java Options field that controls how much memory ES is allowed to use. This doesn't usually require any changes but you might want to tune these for your systems avaliable RAM.
!!! tip
Make sure and start Redis and the ElasticSearch containers approximately one minute before starting `TubeArchivist`
@ -39,31 +37,26 @@ There are four additional settings in the "show more settings" area, but they do
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 a space separating the different addresses. More information [here.](https://github.com/tubearchivist/tubearchivist#installing-and-updating)
- `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 a space separating the different addresses. More information [here.](env-vars.md#ta_host).
- `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.
Make sure that this is an empty directory to not cause confusion when
starting the application. If you have existing videos that you'd like
to import into Tube Archivist, please checkout the [settings
wiki.](https://github.com/tubearchivist/tubearchivist/wiki/Settings#manual-media-files-import)
to import into Tube Archivist, please checkout the [Manual Import Documentation.](../settings/actions.md#manual-media-files-import)
- `Appdata:` This should be the same base path as the other two containers (/mnt/user/appdata/TubeArchivist).
- `Appdata:` This should be the root path from the other two containers (/mnt/user/appdata/TubeArchivist).
- `TA Username:` This will be your username for TubeArchivist.
- `TA Username:` This will be your initial username for TubeArchivist.
- `TA Password:` This will be your password for TubeArchivist.
- `TA Password:` This will be your initial password for TubeArchivist.
- `Redis:` This will **ONLY** be the ip address of your Redis container.
- If you want to host Redis on a differnt port than the default 6379, simply add a new variable as show below.
![TubeArchivist](../assets/unraid_redis_port.png)
- `Redis:`Connection string to your Redis container. replace `archivist-redis` with your host IP address, and port.
E.g.: if your unraid has the IP 192.168.0.14 it would be `redis://192.168.0.14:6379`
- `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 your `TubeArchivist-ES` container.
(example: if your IP is 192.168.0.14, the value should be http://192.168.0.14:9200)
- `ElasticSearch:` similar to the Redis variable, just replace the IP and Port to match your `TubeArchivist-ES` container. E.g.: `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)
@ -73,7 +66,7 @@ It's finally time to set up TubeArchivist!
### Permissions Errors
If you run into permission errors, try ```'newperms /mnt/user/appdata/TubeArchivist/'``` to reset the permissions to the root of your TubeArchivist appdata folder.
If you run into permission errors, stop all containers and try ```'newperms /mnt/user/appdata/TubeArchivist/'``` to reset the permissions to the root of your TubeArchivist appdata folder.
### Support