summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRoger Gonzalez <roger@rogs.me>2023-01-07 13:16:35 -0300
committerRoger Gonzalez <roger@rogs.me>2023-01-07 13:16:35 -0300
commit19c4f2affef43b926513a7853534cbba29c5e0e1 (patch)
treef44c8ed367fda0465be33992a838935bad200476
parent4aca03906c1acd7edfc1606c27b3471f431200e0 (diff)
Updated README
-rw-r--r--README.org40
-rwxr-xr-xinstall.sh1
2 files changed, 40 insertions, 1 deletions
diff --git a/README.org b/README.org
index 96c832c..c614b9e 100644
--- a/README.org
+++ b/README.org
@@ -1,3 +1,41 @@
#+title: YAMS: Yet Another Media Server
-This is my mediaserver script. A better README comming soon.
+This is my mediaserver script.
+
+* Description
+:PROPERTIES:
+:ID: 280135a0-2cff-4e93-8679-7d1a6d56b7b2
+:END:
+This script installs the following software:
+- [[https://sonarr.tv/][Sonarr]]
+- [[https://radarr.video/][Radarr]]
+- [[https://emby.media/][Emby]]
+- [[https://www.qbittorrent.org/][qBittorrent]]
+- [[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.
+
+* Requirements
+:PROPERTIES:
+:ID: 01577a0a-852e-481a-b9b3-791b68594f96
+:END:
+First, you need to install:
+- docker
+- docker-compose
+
+* To run
+:PROPERTIES:
+:ID: a0417c61-3fd8-40a0-9385-6c5aaed37337
+:END:
+
+#+begin_src bash
+$ git clone https://gitlab.com/rogs/yams.git
+$ cd yams
+$ ./install.sh
+#+end_src
+
+And follow the instructions.
+
+So far, I've tested this in Debian 11, but it should work on Ubuntu as well.
diff --git a/install.sh b/install.sh
index e6913ea..6e49dc8 100755
--- a/install.sh
+++ b/install.sh
@@ -49,6 +49,7 @@ running_services_location() {
echo "Bazarr: http://$host_ip:6767/"
echo "Jackett: http://$host_ip:9117/"
echo "Emby: http://$host_ip:8096/"
+ echo "qBittorrent: http://$host_ip:8080/"
}
# ============================================================================================