From 0daba99f082ac7f3a1f607d8e8cac5e5ec4e7b8c Mon Sep 17 00:00:00 2001 From: micah686 Date: Fri, 31 Mar 2023 08:42:02 -0700 Subject: [PATCH] Readme docs (#460) * Create SHOWCASE.MD * Moved screenshots * Removed most configurations, and moved them to the docs * Update README.md * Put roadmap back in * Updated ENV configuration * Cleaned up the ENV table * Update README.md * Merged Connect and Extended Universe * Update README.md * Update README.md * Added Port Collisions --- README.md | 264 +++++++++++++++++----------------------------------- SHOWCASE.MD | 18 ++++ 2 files changed, 105 insertions(+), 177 deletions(-) create mode 100644 SHOWCASE.MD diff --git a/README.md b/README.md index 098b191b..1db9dfe6 100644 --- a/README.md +++ b/README.md @@ -8,212 +8,86 @@ tubearchivist-discord +![home screenshot](assets/tube-archivist-screenshot-home.png?raw=true "Tube Archivist Home") + ## Table of contents: * [Wiki](https://github.com/tubearchivist/tubearchivist/wiki) with [FAQ](https://github.com/tubearchivist/tubearchivist/wiki/FAQ) * [Core functionality](#core-functionality) -* [Screenshots](#screenshots) -* [Problem Tube Archivist tries to solve](#problem-tube-archivist-tries-to-solve) -* [Connect](#connect) -* [Extended Universe](#extended-universe) +* [Resources](#resources) * [Installing and updating](#installing-and-updating) * [Getting Started](#getting-started) +* [Known limitations](#known-limitations) +* [Port Collisions](#port-collisions) * [Common Errors](#common-errors) * [Roadmap](#roadmap) -* [Known limitations](#known-limitations) * [Donate](#donate) ------------------------ ## Core functionality +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. THis includes: * Subscribe to your favorite YouTube channels * Download Videos using **yt-dlp** * Index and make videos searchable * Play videos * Keep track of viewed and unviewed videos -## Tube Archivist on YouTube -[![ibracorp-youtube-video-thumb](assets/tube-archivist-ibracorp-O8H8Z01c0Ys.jpg)](https://www.youtube.com/watch?v=O8H8Z01c0Ys) -## Screenshots -![home screenshot](assets/tube-archivist-screenshot-home.png?raw=true "Tube Archivist Home") -*Home Page* - -![channels screenshot](assets/tube-archivist-screenshot-channels.png?raw=true "Tube Archivist Channels") -*All Channels* - -![single channel screenshot](assets/tube-archivist-screenshot-single-channel.png?raw=true "Tube Archivist Single Channel") -*Single Channel* - -![video page screenshot](assets/tube-archivist-screenshot-video.png?raw=true "Tube Archivist Video Page") -*Video Page* - -![video page screenshot](assets/tube-archivist-screenshot-download.png?raw=true "Tube Archivist Video Page") -*Downloads Page* -## Problem Tube Archivist tries to solve -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. - -## Connect +## Resources - [Discord](https://www.tubearchivist.com/discord): Connect with us on our Discord server. - [r/TubeArchivist](https://www.reddit.com/r/TubeArchivist/): Join our Subreddit. - -## Extended Universe - [Browser Extension](https://github.com/tubearchivist/browser-extension) Tube Archivist Companion, for [Firefox](https://addons.mozilla.org/addon/tubearchivist-companion/) and [Chrome](https://chrome.google.com/webstore/detail/tubearchivist-companion/jjnkmicfnfojkkgobdfeieblocadmcie) -- [Tube Archivist Metrics](https://github.com/tubearchivist/tubearchivist-metrics) to create statistics in Prometheus/OpenMetrics format. +- [Tube Archivist Metrics](https://github.com/tubearchivist/tubearchivist-metrics) to create statistics in Prometheus/OpenMetrics format. +- [Showcase](SHOWCASE.MD) To see more screenshots and Youtube videos showing off TubeArchvist. + ## Installing and updating -There's dedicated user-contributed install steps under [docs/Installation.md](./docs/Installation.md) for podman, Unraid, Truenas and Synology which you can use instead of this section if you happen to be using one of those. Otherwise, continue on. +For minimal system requirements, the Tube Archivist stack needs around 2GB of available memory for a small testing setup and around 4GB of available memory for a mid to large sized installation. Minimal with dual core with 4 threads, better quad core plus. +This project requires docker. Ensure it is installed and running on your system. -For minimal system requirements, the Tube Archivist stack needs around 2GB of available memory for a small testing setup and around 4GB of available memory for a mid to large sized installation. Minimal with dual core with 4 threads, better quad core plus. +If you are using Podman, Unraid, TrueNAS, and Synology, visit [https://docs.tubearchivist.com](https://docs.tubearchivist.com) for more dedicated instructions for those systems. Otherwise, continue on. -This project requires docker. Ensure it is installed and running on your system. +Here are the configuration options that you will need to set to start TubeArchivist: -Note for **arm64**: Tube Archivist is a multi arch container, same for redis. For Elasitc Search use the official image for arm64 support. Other architectures are not supported. +TubeArchivist: +| Configuration Option | Value | State | +| ----------- | ----------- | ----------- | +| TA_HOST | Change to the IP/Domain Name of the machine you are running on | Required | +| TA_USERNAME | Initial username when logging into TA | Required | +| TA_PASSWORD | Initial password when logging into TA | Required | +| ELASTIC_PASSWORD | Password for ElasticSearch | Required | +| REDIS_HOST | Hostname for Redis | Required | +| TZ | Timezone. Change this to your current Timezone (like "America/Los_Angeles") | Required | +| TA_PORT | Port TA runs on | Optional | +| TA_UWSGI_PORT | Configure TA to use LDAP Authentication | Optional | +| ES_URL | URL That ElasticSearch runs on | Optional | +| HOST_GID | Allow TA to own the video files instead of container user | Optional | +| HOST_UID | Allow TA to own the video files instead of container user | Optional | +| ELASTIC_USER | Change the default ElasticSearch user | Optional | +| REDIS_PORT | Port that Redis runs on | Optional | +| TA_LDAP | Configure TA to use LDAP Authentication | Read more | +| ENABLE_CAST | Enable casting support | Read more | +| DJANGO_DEBUG | Debugs Djanjo frontend (Debug use only) | Read more | -Save the [docker-compose.yml](./docker-compose.yml) file from this reposity somewhere permanent on your system, keeping it named `docker-compose.yml`. You'll need to refer to it whenever starting this application. +Archivist-ES +| Configuration Option | Value | State | +| ----------- | ----------- | ----------- | +| ELASTIC_PASSWORD | Must be the same as `tubearchivist/environment/ELASTIC_PASSWORD` | Required | +| http.port | Change the port ElasticSearch runs on | Optional | -Edit the following values from that file: -- under `tubearchivist`->`environment`: - - `HOST_UID`: your UID, if you want TubeArchivist to create files with your UID. Remove if you are OK with files being owned by the the container user. - - `HOST_GID`: as above but GID. - - `TA_HOST`: change it to the address of the machine you're running this on. This can be an IP address or a domain name. - - `TA_PASSWORD`: pick a password to use when logging in. - - `ELASTIC_PASSWORD`: pick a password for the elastic service. You won't need to type this yourself. - - `TZ`: your time zone. If you don't know yours, you can look it up [here](https://www.timezoneconverter.com/cgi-bin/findzone/findzone). -- under `archivist-es`->`environment`: - - `"ELASTIC_PASSWORD=verysecret"`: change `verysecret` to match the ELASTIC_PASSWORD you picked above. -By default Docker will store all data, including downloaded data, in its own data-root directory (which you can find by running `docker info` and looking for the "Docker Root Dir"). If you want to use other locations, you can replace the `media:`, `cache:`, `redis:`, and `es:` volume names with absolute paths; if you do, remove them from the `volumes:` list at the bottom of the file. -From a terminal, `cd` into the directory you saved the `docker-compose.yml` file in and run `docker compose up --detach`. The first time you do this it will download the appropriate images, which can take a minute. + + +To start, `cd` into the directory where the `docker-compose.yml` file is located and run `docker compose up --detach` in terminal. The first time you do this it will download the appropriate images, which can take a minute. You can follow the logs with `docker compose logs -f`. Once it's ready it will print something like `celery@1234567890ab ready`. At this point you should be able to go to `http://your-host:8000` and log in with the `TA_USER`/`TA_PASSWORD` credentials. You can bring the application down by running `docker compose down` in the same directory. +Always use the *latest* (the default) or a named semantic version tag for the docker images, unless if you are doing development. -Use the *latest* (the default) or a named semantic version tag for the docker images. The *unstable* tag is for intermediate testing and as the name implies, is **unstable** and not be used on your main installation but in a [testing environment](CONTRIBUTING.md). - -## Installation Details - -Tube Archivist depends on three main components split up into separate docker containers: - -### Tube Archivist -The main Python application that displays and serves your video collection, built with Django. - - Serves the interface on port `8000` - - Needs a volume for the video archive at **/youtube** - - And another volume to save application data at **/cache**. - - The environment variables `ES_URL` and `REDIS_HOST` are needed to tell Tube Archivist where Elasticsearch and Redis respectively are located. - - The environment variables `HOST_UID` and `HOST_GID` allows Tube Archivist to `chown` the video files to the main host system user instead of the container user. Those two variables are optional, not setting them will disable that functionality. That might be needed if the underlying filesystem doesn't support `chown` like *NFS*. - - Set the environment variable `TA_HOST` to match with the system running Tube Archivist. This can be a domain like *example.com*, a subdomain like *ta.example.com* or an IP address like *192.168.1.20*, add without the protocol and without the port. You can add multiple hostnames separated with a space. Any wrong configurations here will result in a `Bad Request (400)` response. - - Change the environment variables `TA_USERNAME` and `TA_PASSWORD` to create the initial credentials. - - `ELASTIC_PASSWORD` is for the password for Elasticsearch. The environment variable `ELASTIC_USER` is optional, should you want to change the username from the default *elastic*. - - For the scheduler to know what time it is, set your timezone with the `TZ` environment variable, defaults to *UTC*. - - Set the environment variable `ENABLE_CAST=True` to send videos to your cast device, [read more](#enable-cast). - -### Port collisions -If you have a collision on port `8000`, best solution is to use dockers *HOST_PORT* and *CONTAINER_PORT* distinction: To for example change the interface to port 9000 use `9000:8000` in your docker-compose file. - -Should that not be an option, the Tube Archivist container takes these two additional environment variables: -- **TA_PORT**: To actually change the port where nginx listens, make sure to also change the ports value in your docker-compose file. -- **TA_UWSGI_PORT**: To change the default uwsgi port 8080 used for container internal networking between uwsgi serving the django application and nginx. - -Changing any of these two environment variables will change the files *nginx.conf* and *uwsgi.ini* at startup using `sed` in your container. - -### LDAP Authentication -You can configure LDAP with the following environment variables: - - - `TA_LDAP` (ex: `true`) Set to anything besides empty string to use LDAP authentication **instead** of local user authentication. - - `TA_LDAP_SERVER_URI` (ex: `ldap://ldap-server:389`) Set to the uri of your LDAP server. - - `TA_LDAP_DISABLE_CERT_CHECK` (ex: `true`) Set to anything besides empty string to disable certificate checking when connecting over LDAPS. - - `TA_LDAP_BIND_DN` (ex: `uid=search-user,ou=users,dc=your-server`) DN of the user that is able to perform searches on your LDAP account. - - `TA_LDAP_BIND_PASSWORD` (ex: `yoursecretpassword`) Password for the search user. - - `TA_LDAP_USER_ATTR_MAP_USERNAME` (default: `uid`) Bind attribute used to map LDAP user's username - - `TA_LDAP_USER_ATTR_MAP_PERSONALNAME` (default: `givenName`) Bind attribute used to match LDAP user's First Name/Personal Name. - - `TA_LDAP_USER_ATTR_MAP_SURNAME` (default: `sn`) Bind attribute used to match LDAP user's Last Name/Surname. - - `TA_LDAP_USER_ATTR_MAP_EMAIL` (default: `mail`) Bind attribute used to match LDAP user's EMail address - - `TA_LDAP_USER_BASE` (ex: `ou=users,dc=your-server`) Search base for user filter. - - `TA_LDAP_USER_FILTER` (ex: `(objectClass=user)`) Filter for valid users. Login usernames are matched using the attribute specified in `TA_LDAP_USER_ATTR_MAP_USERNAME` and should not be specified in this filter. - -When LDAP authentication is enabled, django passwords (e.g. the password defined in TA_PASSWORD), will not allow you to login, only the LDAP server is used. - -### Enable Cast -As Cast doesn't support authentication, enabling this functionality will make your static files like artwork and media files accessible by guessing the links. That's read only access, the application itself is still protected. - -Enabling this integration will embed an additional third party JS library from **Google**. - -**Requirements**: -- HTTPS: To use the cast integration HTTPS needs to be enabled, which can be done using a reverse proxy. This is a requirement by Google as communication to the cast device is required to be encrypted, but the content itself is not. -- Supported Browser: A supported browser is required for this integration such as Google Chrome. Other browsers, especially Chromium-based browsers, may support casting by enabling it in the settings. -- Subtitles: Subtitles are supported however they do not work out of the box and require additional configuration. Due to requirements by Google, to use subtitles you need additional headers which will need to be configured in your reverse proxy. See this [page](https://developers.google.com/cast/docs/web_sender/advanced#cors_requirements) for the specific requirements. -You need the following headers: Content-Type, Accept-Encoding, and Range. Note that the last two headers, Accept-Encoding and Range, are additional headers that you may not have needed previously. -Wildcards "*" can not be used for the Access-Control-Allow-Origin header. If the page has protected media content, it must use a domain instead of a wildcard. - -### Elasticsearch -**Note**: Tube Archivist depends on Elasticsearch 8. - -Use `bbilly1/tubearchivist-es` to automatically get the recommended version, or use the official image with the version tag in the docker-compose file. - -Use official Elastic Search for **arm64**. - -Stores video meta data and makes everything searchable. Also keeps track of the download queue. - - Needs to be accessible over the default port `9200` - - Needs a volume at **/usr/share/elasticsearch/data** to store data - -Follow the [documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html) for additional installation details. - -### Elasticsearch on a custom port -Should you need to change the port for Elasticsearch to for example *9500*, follow these steps: -- Set the environment variable `http.port=9500` to the ES container -- Change the *expose* value for the ES container to match your port number -- For the Tube Archivist container, change the *ES_URL* environment variable, e.g. `ES_URL=http://archivist-es:9500` - -### Redis JSON -Functions as a cache and temporary link between the application and the file system. Used to store and display messages and configuration variables. - - Needs to be accessible over the default port `6379` - - Needs a volume at **/data** to make your configuration changes permanent. - -### Redis on a custom port -For some architectures it might be required to run Redis JSON on a nonstandard port. To for example change the Redis port to **6380**, set the following values: -- Set the environment variable `REDIS_PORT=6380` to the *tubearchivist* service. -- For the *archivist-redis* service, change the ports to `6380:6380` -- Additionally set the following value to the *archivist-redis* service: `command: --port 6380 --loadmodule /usr/lib/redis/modules/rejson.so` - -### Updating Tube Archivist -You will see the current version number of **Tube Archivist** in the footer of the interface. There is a daily version check task querying tubearchivist.com, notifying you of any new releases in the footer. To take advantage of the latest fixes and improvements, make sure you are running the *latest and greatest*. -* This project is tested for updates between one or two releases maximum. Further updates back may or may not be supported and you might have to reset your index and configurations to update. Ideally apply new updates at least once per month. -* There can be breaking changes between updates, particularly as the application grows, new environment variables or settings might be required for you to set in the your docker-compose file. *Always* check the **release notes**: Any breaking changes will be marked there. -* All testing and development is done with the Elasticsearch version number as mentioned in the provided *docker-compose.yml* file. This will be updated when a new release of Elasticsearch is available. Running an older version of Elasticsearch is most likely not going to result in any issues, but it's still recommended to run the same version as mentioned. Use `bbilly1/tubearchivist-es` to automatically get the recommended version. - -### Helm charts - -There is a Helm Chart available at https://github.com/insuusvenerati/helm-charts. Mostly self-explanatory but feel free to ask questions in the discord / subreddit. - -## Common Errors -### vm.max_map_count -**Elastic Search** in Docker requires the kernel setting of the host machine `vm.max_map_count` to be set to at least 262144. - -To temporary set the value run: -``` -sudo sysctl -w vm.max_map_count=262144 -``` - -To apply the change permanently depends on your host operating system: -- For example on Ubuntu Server add `vm.max_map_count = 262144` to the file */etc/sysctl.conf*. -- On Arch based systems create a file */etc/sysctl.d/max_map_count.conf* with the content `vm.max_map_count = 262144`. -- On any other platform look up in the documentation on how to pass kernel parameters. - -### Permissions for elasticsearch -If you see a message similar to `Unable to access 'path.repo' (/usr/share/elasticsearch/data/snapshot)` or `failed to obtain node locks, tried [/usr/share/elasticsearch/data]` and `maybe these locations are not writable` when initially starting elasticsearch, that probably means the container is not allowed to write files to the volume. -To fix that issue, shutdown the container and on your host machine run: -``` -chown 1000:0 -R /path/to/mount/point -``` -This will match the permissions with the **UID** and **GID** of elasticsearch process within the container and should fix the issue. - -### Disk usage -The Elasticsearch index will turn to *read only* if the disk usage of the container goes above 95% until the usage drops below 90% again, you will see error messages like `disk usage exceeded flood-stage watermark`, [link](https://github.com/tubearchivist/tubearchivist#disk-usage). - -Similar to that, TubeArchivist will become all sorts of messed up when running out of disk space. There are some error messages in the logs when that happens, but it's best to make sure to have enough disk space before starting to download. +If you want more advanced options, or more detailed instructions on how to set up the containers, you can visit [https://docs.tubearchivist.com/installation/docker](https://docs.tubearchivist.com/installation/docker) or [https://github.com/tubearchivist/docs/tree/master/mkdocs/docs](https://github.com/tubearchivist/docs/tree/master/mkdocs/docs). ## Getting Started 1. Go through the **settings** page and look at the available options. Particularly set *Download Format* to your desired video quality before downloading. **Tube Archivist** downloads the best available quality by default. To support iOS or MacOS and some other browsers a compatible format must be specified. For example: @@ -224,7 +98,49 @@ bestvideo[vcodec*=avc1]+bestaudio[acodec*=mp4a]/mp4 3. On the **downloads** page, click on *Rescan subscriptions* to add videos from the subscribed channels to your Download queue or click on *Add to download queue* to manually add Video IDs, links, channels or playlists. 4. Click on *Start download* and let **Tube Archivist** to it's thing. 5. Enjoy your archived collection! - + + +## Known limitations +- Video files created by Tube Archivist need to be playable in your browser of choice. Not every codec is compatible with every browser and might require some testing with format selection. +- Every limitation of **yt-dlp** will also be present in Tube Archivist. If **yt-dlp** can't download or extract a video for any reason, Tube Archivist won't be able to either. +- There is currently no flexibility in naming of the media files. + +### Port Collisions +If you have a collision on port `8000`, best solution is to use dockers *HOST_PORT* and *CONTAINER_PORT* distinction: To for example change the interface to port 9000 use `9000:8000` in your docker-compose file. + +For more information on port collisions, check the docs. + +## Common Errors +Here is a list of common errors and their solutions. + +### `vm.max_map_count` +**Elastic Search** in Docker requires the kernel setting of the host machine `vm.max_map_count` to be set to at least 262144. + +To temporary set the value run: +``` +sudo sysctl -w vm.max_map_count=262144 +``` +To apply the change permanently depends on your host operating system: + + - For example on Ubuntu Server add `vm.max_map_count = 262144` to the file `/etc/sysctl.conf`. + - On Arch based systems create a file `/etc/sysctl.d/max_map_count.conf` with the content `vm.max_map_count = 262144`. + - On any other platform look up in the documentation on how to pass kernel parameters. + + +### Permissions for elasticsearch +If you see a message similar to `Unable to access 'path.repo' (/usr/share/elasticsearch/data/snapshot)` or `failed to obtain node locks, tried [/usr/share/elasticsearch/data]` and `maybe these locations are not writable` when initially starting elasticsearch, that probably means the container is not allowed to write files to the volume. +To fix that issue, shutdown the container and on your host machine run: +``` +chown 1000:0 -R /path/to/mount/point +``` +This will match the permissions with the **UID** and **GID** of elasticsearch process within the container and should fix the issue. + + +### Disk usage +The Elasticsearch index will turn to ***read only*** if the disk usage of the container goes above 95% until the usage drops below 90% again, you will see error messages like `disk usage exceeded flood-stage watermark`. + +Similar to that, TubeArchivist will become all sorts of messed up when running out of disk space. There are some error messages in the logs when that happens, but it's best to make sure to have enough disk space before starting to download. + ## Roadmap We have come far, nonetheless we are not short of ideas on how to improve and extend this project. Issues waiting for you to be tackled in no particular order: @@ -265,12 +181,6 @@ Implemented: - [X] Backup and restore [2021-09-22] - [X] Scan your file system to index already downloaded videos [2021-09-14] -## Known limitations -- Video files created by Tube Archivist need to be playable in your browser of choice. Not every codec is compatible with every browser and might require some testing with format selection. -- Every limitation of **yt-dlp** will also be present in Tube Archivist. If **yt-dlp** can't download or extract a video for any reason, Tube Archivist won't be able to either. -- There is currently no flexibility in naming of the media files. - - ## Donate The best donation to **Tube Archivist** is your time, take a look at the [contribution page](CONTRIBUTING.md) to get started. Second best way to support the development is to provide for caffeinated beverages: @@ -279,7 +189,6 @@ Second best way to support the development is to provide for caffeinated beverag * [Paypal Subscription](https://www.paypal.com/webapps/billing/plans/subscribe?plan_id=P-03770005GR991451KMFGVPMQ) for a monthly coffee * [ko-fi.com](https://ko-fi.com/bbilly1) for an alternative platform - ## Notable mentions This is a selection of places where this project has been featured on reddit, in the news, blogs or any other online media. Sorted by newest on the top. * **console.substack.com**: Interview With Simon of Tube Archivist, [2023-01-29] [[link](https://console.substack.com/p/console-142#%C2%A7interview-with-simon-of-tube-archivist)] @@ -299,3 +208,4 @@ Big thank you to [Digitalocean](https://www.digitalocean.com/) for generously do

+ diff --git a/SHOWCASE.MD b/SHOWCASE.MD new file mode 100644 index 00000000..ec7bf649 --- /dev/null +++ b/SHOWCASE.MD @@ -0,0 +1,18 @@ +## Tube Archivist on YouTube +[![ibracorp-youtube-video-thumb](assets/tube-archivist-ibracorp-O8H8Z01c0Ys.jpg)](https://www.youtube.com/watch?v=O8H8Z01c0Ys) + +## Screenshots +![home screenshot](assets/tube-archivist-screenshot-home.png?raw=true "Tube Archivist Home") +*Home Page* + +![channels screenshot](assets/tube-archivist-screenshot-channels.png?raw=true "Tube Archivist Channels") +*All Channels* + +![single channel screenshot](assets/tube-archivist-screenshot-single-channel.png?raw=true "Tube Archivist Single Channel") +*Single Channel* + +![video page screenshot](assets/tube-archivist-screenshot-video.png?raw=true "Tube Archivist Video Page") +*Video Page* + +![video page screenshot](assets/tube-archivist-screenshot-download.png?raw=true "Tube Archivist Video Page") +*Downloads Page*