Changed "docs" for "install"

3 files changed, 254 insertions, 0 deletions

diff --git a/content/install/description.md b/content/install/description.md
new file mode 100644
index 0000000..3afec2f
--- /dev/null
+++ b/content/install/description.md
@@ -0,0 +1,46 @@
+---
+title: "What is YAMS?"
+date: 2023-01-10T15:23:19-03:00
+draft: false
+weight: 1
+summary: A brief summary on what YAMS is and its features
+---
+
+YAMS is a is a **highly opinionated** media server.
+
+With YAMS you'll be able to automate your media gathering, organization and consumption.
+
+## First, why?
+
+I wanted a setup that my non technical girlfiend could use without any problems, so I started designing my media server using multiple open source projects, and running them on top of docker.
+
+Fast forward two years and I would like to say it works very well 😎 And most importantly, I acomplished my goal: My girlfiend uses it very regularly and I've even expanded it to my Mother, who lives 5000kms from me.
+
+My friends wanted to have a media server like mine, but it was always hard to explain everything that was involved in building and connecting all the pieces together.
+
+So basically, my friends pushed me to build this script and documentation, so they (and now anyone!) could build it on their own homeservers.
+
+## Features
+
+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 as soon as 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.
+
+
+## What's installed with YAMS?
+
+- [Sonarr](https://sonarr.tv/)
+- [Radarr](https://radarr.video/)
+- [Emby](https://emby.media/)
+- [qBittorrent](https://www.qbittorrent.org/)
+- [Bazarr](https://www.bazarr.media/)
+- [Jackett](https://github.com/Jackett/Jackett)
+
+With this combination, you can create a fully functional media server that is going to download, categorize, subtitle and serve your favorite shows and movies.
+
+## Why did you choose <this_software> instead of <that_software>?
+
+Because. That's why it's _**opinionated**_, you don't _necessarily_ have to agree with me. This setup is aimed at noobs and first time media server enthusiasts. You can always use my sources and create a better project 🔥
diff --git a/content/install/install.md b/content/install/install.md
new file mode 100644
index 0000000..c0f6f40
--- /dev/null
+++ b/content/install/install.md
@@ -0,0 +1,173 @@
+---
+title: Installation
+date: 2023-01-10T15:23:20-03:00
+weight: 2
+summary: First steps to install YAMS on your server
+---
+
+## Dependencies
+
+This script only depends on:
+
+- Debian 11 (recommended) or Ubuntu 22.04.
+- [docker](https://www.docker.com/).
+- [docker-compose](https://docs.docker.com/compose/).
+
+If you haven’t installed `docker` and `docker-compose`, don’t worry! The script will attempt to run both installations (it only works in Debian and Ubuntu!)
+
+## Before running
+Before installing, make sure you have:
+
+- **An installation location:** The script is going to ask you for a install location, but it will default to `/opt/yams`. Just make sure your current user has permissions to write on the selected directory.
+- **A media folder:** This is the folder where all your files are going to be downloaded and categorized. For example, 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 install
+
+### Setup your install location (optional, you can choose any other location)
+
+The location `/opt/yams` is **recommended**, but you can use whatever you like if your current user has permissions on the directory.
+
+```bash
+sudo mkdir -p /opt/yams 
+sudo chown -R $USER:$USER /opt/yams
+```
+
+### Cloning from Gitlab
+```bash
+git clone https://gitlab.com/rogs/yams.git
+cd yams
+```
+
+### Installing docker (optional)
+If you have `docker` and `docker-compose` installed, you can skip this part.
+
+To install `docker`, just run:
+
+```bash
+./install.sh
+```
+
+You'll see the following prompt:
+
+```bash
+====================================================
+                 ___           ___           ___
+     ___        /  /\         /__/\         /  /\
+    /__/|      /  /::\       |  |::\       /  /:/_
+   |  |:|     /  /:/\:\      |  |:|:\     /  /:/ /\
+   |  |:|    /  /:/~/::\   __|__|:|\:\   /  /:/ /::\
+ __|__|:|   /__/:/ /:/\:\ /__/::::| \:\ /__/:/ /:/\:\
+/__/::::\   \  \:\/:/__\/ \  \:\~~\__\/ \  \:\/:/~/:/
+   ~\~~\:\   \  \::/       \  \:\        \  \::/ /:/
+     \  \:\   \  \:\        \  \:\        \__\/ /:/
+      \__\/    \  \:\        \  \:\         /__/:/
+                \__\/         \__\/         \__\/
+====================================================
+Welcome to YAMS (Yet Another Media Server)
+Instalation process should be really quick
+We just need you to answer some questions
+====================================================
+
+Checking prerequisites...
+ ⚠️ docker not found! ⚠️
+Do you want YAMS to install docker and docker-compose? IT ONLY WORKS ON DEBIAN AND UBUNTU! [y/N]: y
+```
+
+If you choose to install docker with YAMS, you'll see the following message:
+
+```bash
+🤔 When docker finishes the installation, run ./install again! 🧠
+Press [ENTER] to continue...
+```
+**Note:** The script will ask you for your `sudo` password in order to continue ⚠️
+
+### Installing YAMS
+
+To install YAMS, just re-run:
+
+```bash
+./install.sh
+```
+
+And you should see the following message at the bottom:
+
+```bash
+Checking prerequisites...
+docker exists ✅
+docker-compose exists ✅
+Where do you want to install the docker-compose file? [/opt/yams]:
+```
+
+You should choose the path where you want YAMS to be installed. Like I said before, the `/opt/yams` directory **is recommended**, but you can use whatever you like if your current user has permissions on the directory. Type the path you'll like to use and press `[ENTER]` to continue.
+
+```bash
+What's the user that is going to own the media server files? [your_current_user]:
+```
+
+Now, you have to choose the user that is going to own your media files. **I strongly suggest you don't use `root` for this user**, but you can do whatever you want. The script is going to default to the current `$USER` running the script. Type the user you want to own the files and press `[ENTER]` to continue.
+
+```bash
+Please, input your media folder:
+```
+
+My suggestion is to use something like `/srv/media`, but you _might_ want to use an external hard drive or a different partition on your machine. Just type the full path of the directory you want to use and press `[ENTER]` to continue. If it doesn't exist, the script is going to try to create it.
+
+```bash
+Are you sure your media folder is /srv/media? [y/N]:
+```
+
+Select `y` or `n` if you are happy with the folder you selected. Press `[ENTER]` to continue.
+
+```bash
+Copying /opt/yams/docker-compose.yaml...
+Everything installed correctly! 🎉
+...
+
+...
+
+...
+```
+
+After a lot of docker installing, you'll get this message at the end:
+
+```bash
+========================================================
+     _____          ___           ___           ___
+    /  /::\        /  /\         /__/\         /  /\
+   /  /:/\:\      /  /::\        \  \:\       /  /:/_
+  /  /:/  \:\    /  /:/\:\        \  \:\     /  /:/ /\
+ /__/:/ \__\:|  /  /:/  \:\   _____\__\:\   /  /:/ /:/_
+ \  \:\ /  /:/ /__/:/ \__\:\ /__/::::::::\ /__/:/ /:/ /\
+  \  \:\  /:/  \  \:\ /  /:/ \  \:\~~\~~\/ \  \:\/:/ /:/
+   \  \:\/:/    \  \:\  /:/   \  \:\  ~~~   \  \::/ /:/
+    \  \::/      \  \:\/:/     \  \:\        \  \:\/:/
+     \__\/        \  \::/       \  \:\        \  \::/
+                   \__\/         \__\/         \__\/
+========================================================
+All done!✅ Enjoy YAMS!
+You can check the installation on /opt/yams
+========================================================
+Everythins should be running now! To check everything running, go to:
+
+Sonarr: http://192.168.0.169:8989/
+Radarr: http://192.168.0.169:7878/
+Bazarr: http://192.168.0.169:6767/
+Jackett: http://192.168.0.169:9117/
+Emby: http://192.168.0.169:8096/
+qBittorrent: http://192.168.0.169:8080/
+
+
+You might need to wait for a couple of minutes while everything gets up and running
+
+All the services location are also saved in ~/yams_services.txt
+========================================================
+```
+
+And that's it!
+
+In your browser, you can visit each of the sites to check that they are running correctly. If one of them don't show up, you might need to wait a couple of minutes for docker to finish the full installation.
diff --git a/content/install/using-the-cli.md b/content/install/using-the-cli.md
new file mode 100644
index 0000000..9613d79
--- /dev/null
+++ b/content/install/using-the-cli.md
@@ -0,0 +1,35 @@
+---
+title: "Using the CLI"
+date: 2023-01-10T17:55:41-03:00
+draft: false
+weight: 3
+summary: YAMS comes with a very handy CLI to manage all your media server. Here's where you'll learn how to use it.
+---
+
+YAMS comes with a very handy CLI to manage all your media server. Here's where you'll learn how to use it.
+
+On your server, you can type: 
+```bash
+yams --help
+```
+
+And you'll get the following message:
+
+```bash
+yams - Yet Another Media Server
+
+Usage: yams [--help|restart|stop|start]
+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
+```
+
+Everything is very self-explanatory, but I'll go in more detail here:
+
+- `restart`: Restarts all the services. It stops them gracefully and starts them again.
+- `stop`: Stops all the services gracefully.
+- `start`: Starts all the services.
+- `destroy`: Destroys all the services so you can start the configuration from scrath. ⚠️ Be careful! ⚠️ There's no going back after this!