2021-09-14 11:33:55 +00:00
2021-09-05 17:10:14 +00:00
2021-09-17 01:18:03 +00:00
< center > < h1 > Your self hosted YouTube media server< / h1 > < / center >
2021-09-05 17:10:14 +00:00
## Core functionality
2021-09-17 01:18:03 +00:00
* Subscribe to your favorite YouTube channels
2021-09-05 17:10:14 +00:00
* Download Videos using **yt-dlp**
* Index and make videos searchable
* Play videos
* Keep track of viewed and unviewed videos
2021-09-09 09:47:37 +00:00
## Screenshots
*Home Page*
*All Channels*
*Single Channel*
*Video Page*
*Downloads Page*
2021-09-05 17:10:14 +00:00
## Problem Tube Archivist tries to solve
2021-09-17 01:18:03 +00:00
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.
2021-09-05 17:10:14 +00:00
## Installation
2021-09-17 01:18:03 +00:00
Take a look at the example `docker-compose.yml` file provided. Tube Archivist depends on three main components split up into separate docker containers:
2021-09-05 17:10:14 +00:00
### Tube Archivist
The main Python application that displays and serves your video collection, built with Django.
- Serves the interface on port `8000`
- Needs a mandatory volume for the video archive at ** /youtube**
- And another recommended volume to save the cache for thumbnails and artwork at ** /cache**.
- The environment variables `ES_URL` and `REDIS_HOST` are needed to tell Tube Archivist where Elasticsearch and Redis respectively are located.
2021-09-17 01:18:03 +00:00
- 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.
2021-09-05 17:10:14 +00:00
### Elasticsearch
Stores video meta data and makes everything searchable. Also keeps track of the download queue.
2021-09-17 01:18:03 +00:00
- Needs to be accessible over the default port `9200`
2021-09-05 17:10:14 +00:00
- 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.
### Redis JSON
2021-09-17 01:18:03 +00:00
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`
2021-09-05 17:10:14 +00:00
- Takes an optional volume at ** /data** to make your configuration changes permanent.
## Getting Started
2021-09-13 15:58:27 +00:00
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.
2021-09-17 01:18:03 +00:00
2. Subscribe to some of your favorite YouTube channels on the **channels** page.
2021-09-10 09:06:36 +00:00
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.
2021-09-05 17:10:14 +00:00
4. Click on *Download queue* and let Tube Archivist to it's thing.
5. Enjoy your archived collection!
2021-09-13 15:58:27 +00:00
## Import your existing library
2021-09-17 01:18:03 +00:00
So far this depends on the video you are trying to import to be still available on YouTube to get the metadata. Add the files you like to import to the */cache/import* folder. Then start the process from the settings page *Manual media files import* . Make sure to follow one of the two methods below.
2021-09-13 15:58:27 +00:00
### Method 1:
Add a matching *.json* file with the media file. Both files need to have the same base name, for example:
- For the media file: \<base-name>.mp4
- For the JSON file: \<base-name>.info.json
- Alternate JSON file: \<base-name>.json
**Tube Archivist** then looks for the 'id' key within the JSON file to identify the video.
### Method 2:
2021-09-17 01:18:03 +00:00
Detect the YouTube ID from filename, this accepts the default yt-dlp naming convention for file names like:
2021-09-13 15:58:27 +00:00
- \<base-name>[\<youtube-id>].mp4
2021-09-17 01:18:03 +00:00
- The YouTube ID in square brackets at the end of the filename is the crucial part.
2021-09-13 15:58:27 +00:00
### Some notes:
2021-09-17 01:18:03 +00:00
- This will **consume** the files you put into the import folder: Files will get converted to mp4 if needed (this might take a long time...) and moved to the archive, *.json* files will get deleted upon completion to avoid having duplicates on the next run.
2021-09-14 11:33:55 +00:00
- Maybe start with a subset of your files to import to make sure everything goes well...
2021-09-13 15:58:27 +00:00
- Follow the logs to monitor progress and errors: `docker-compose logs -f tubearchivist` .
2021-09-05 17:10:14 +00:00
## Potential pitfalls
**Elastic Search** in Docker requires the kernel setting of the host machine `vm.max_map_count` to be set to 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.
## Roadmap
2021-09-17 01:18:03 +00:00
This should be considered as a **minimal viable product** , there is an extensive list of future functions and improvements planned.
2021-09-13 15:58:27 +00:00
### Functionality
2021-09-17 01:18:03 +00:00
- [ ] Access control
2021-09-05 17:10:14 +00:00
- [ ] User roles
- [ ] Delete videos and channel
- [ ] Create playlists
2021-09-13 15:58:27 +00:00
- [ ] Backup and restore
- [ ] Podcast mode to serve channel as mp3
- [ ] Implement [PyFilesystem ](https://github.com/PyFilesystem/pyfilesystem2 ) for flexible video storage
2021-09-17 01:18:03 +00:00
- [X] Scan your file system to index already downloaded videos [2021-09-14]
2021-09-13 15:58:27 +00:00
### UI
2021-09-05 17:10:14 +00:00
- [ ] Show similar videos on video page
- [ ] Multi language support
2021-09-13 15:58:27 +00:00
- [ ] Grid and list view for both channel and video list pages
- [ ] Show total video downloaded vs total videos available in channel
2021-09-05 17:10:14 +00:00
## Known limitations
- Video files created by Tube Archivist need to be **mp4** video files for best browser compatibility.
2021-09-10 09:06:36 +00:00
- 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.
2021-09-05 17:10:14 +00:00
- For now this is meant to be run in a trusted network environment.
