diff options
| -rw-r--r-- | README.org | 58 |
1 files changed, 52 insertions, 6 deletions
@@ -1,6 +1,6 @@ #+title: YAMS: Yet Another Media Server -This is my mediaserver script. +This is a highly opinionated media server. * Description :PROPERTIES: @@ -14,16 +14,43 @@ This script installs the following software: - [[https://www.bazarr.media/][Bazarr]] - [[https://github.com/Jackett/Jackett][Jackett]] - Whit this combination, you can create a fully functional media server that is going to download, - categorize, subtitle and serve your favorite shows and movies. +Whit this combination, you can create a fully functional media server that is going to download, +categorize, subtitle and serve your favorite shows and movies. -* Requirements +* Features +:PROPERTIES: +:ID: 0e072c32-3158-4961-869c-49920090f3d5 +:END: +In no particular order: +- **Automatic shows/movies download**: Just add your shows and movies to the watch list and it should + automatically download the files when they are available. +- **Automatic clasification and organization**: Your media files should be completely organized by default. +- **Automatic subtitles download**: Self explanatory. Your media server should automatically download + subtitles in the languages you choose, if they are available. +- *Support for Web, Android, iOS, Android TV and whatever that can support Emby**: Since we are + leveraging from Emby, you should be able to watch your favorite media almost anywhere. + +* Dependencies :PROPERTIES: :ID: 01577a0a-852e-481a-b9b3-791b68594f96 :END: First, you need to install: -- docker -- docker-compose +- [[https://www.docker.com/][docker]] +- [[https://docs.docker.com/compose/][docker-compose]] + +* Before running +:PROPERTIES: +:ID: 1c609bfc-4e6e-4fd8-8129-1b722fd7cda8 +:END: +Before installing, make sure you have: +- **A media folder**: This is the folder where all your files are going to be downloaded and categorized. If + you choose ~/srv/media~, the script is going to create the following folders: + + ~/srv/media/tv~: For your TV shows + + ~/srv/media/movies~: For your movies + + ~/srv/media/downloads~: For your torrent downloads + + ~/srv/media/blackhole~: For your torrents blackhole +- **A regular user to run and own the media files**: You shouldn't use ~root~ for this user, but I'm not + your father, nothing is going to stop you lol * To run :PROPERTIES: @@ -38,4 +65,23 @@ $ ./install.sh And follow the instructions. + So far, I've tested this in Debian 11, but it should work on Ubuntu as well. + +* Usage +:PROPERTIES: +:ID: 9e995141-b386-4962-9842-7209bedc5651 +:END: +When the script finishes installing without issues, just run: +#+begin_src +$ yams +yams - Yet Another Media Server + +Usage: yams [--help|restart|stop|start|status] +options: +--help displays this help message +restart restarts yams services +stop stops all yams services +start starts yams services +destroy destroy yams services so you can start from scratch +#+end_src |