diff options
Diffstat (limited to 'content/install')
| -rw-r--r-- | content/install/description.md | 19 | ||||
| -rw-r--r-- | content/install/steps.md | 10 | ||||
| -rw-r--r-- | content/install/using-the-cli.md | 6 |
3 files changed, 18 insertions, 17 deletions
diff --git a/content/install/description.md b/content/install/description.md index 27d9823..33b61e4 100644 --- a/content/install/description.md +++ b/content/install/description.md @@ -6,28 +6,28 @@ weight: 1 summary: A brief summary on what YAMS is and its features --- -YAMS is a is a **highly opinionated** media server. +YAMS is a **highly opinionated** media server. -With YAMS you'll be able to automate your media gathering, organization and consumption. +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. +In 2019 I wanted a setup that my non-technical girlfriend 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. +Fast forward two years and I would like to say it works very well 😎 And most importantly, I accomplished my goal: My girlfriend uses it regularly and I've even added my mom, who lives 5000 kms 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. +So basically, my friends pushed me to build this script and documentation, so they (and now anyone!) could build it on their own home servers. ## 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. +- **Automatic classification 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 using Emby, you should be able to watch your favorite media almost anywhere. ## What's installed with YAMS? @@ -38,6 +38,7 @@ In no particular order: - [Sonarr](https://sonarr.tv/) - [Bazarr](https://www.bazarr.media/) - [Emby](https://emby.media/) +- [gluetun](https://github.com/qdm12/gluetun) -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. +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. diff --git a/content/install/steps.md b/content/install/steps.md index 15abab4..be9db11 100644 --- a/content/install/steps.md +++ b/content/install/steps.md @@ -18,7 +18,7 @@ If you haven’t installed `docker` and `docker-compose`, don’t worry! The scr ## 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. +- **An installation location:** The script is going to ask you for an 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. @@ -112,13 +112,13 @@ You can check the supported VPN list here: https://yams.media/advanced/vpn. Do you want to configure a VPN? [Y/n]: ``` -Now its time to configure the VPN. The automatic installer supports all the VPNs on [this list](/advanced/vpn#official-supported-vpns), but **I strongly recommend using Mullvad**. Why? Basically: +Now it's time to configure the VPN. The automatic installer supports all the VPNs on [this list](/advanced/vpn#official-supported-vpns), but **I strongly recommend using Mullvad**. Why? Basically: - They don't require your email or information to create a new account. - It's simple to configure. - They only have monthly subscriptions, so you can leave them whenever you want. - You can pay with crypto. -If want to configure a VPN, select `Y` and continue with this instructions. If you don't have a VPN or don't want to use a VPN, choose `N` and move to [finishing the installation](#finishing-the-installation). You can set your VPN later in the [qBittorrent configuration](/config/qbittorrent). **You should always use a VPN when downloading torrents!** +If want to configure a VPN, select `Y` and continue with these instructions. If you don't have a VPN or don't want to use a VPN, choose `N` and move to [finishing the installation](#finishing-the-installation). You can set your VPN later in the [qBittorrent configuration](/config/qbittorrent). **You should always use a VPN when downloading torrents!** ```bash What's your VPN service? (with spaces) [mullvad]: @@ -176,7 +176,7 @@ After a lot of docker installing, you'll get a message like this at the end: All done!✅ Enjoy YAMS! You can check the installation on /opt/yams ======================================================== -Everythins should be running now! To check everything running, go to: +Everything should be running now! To check everything running, go to: Jackett: http://192.168.0.169:9117/ qBittorrent: http://192.168.0.169:8080/ @@ -199,4 +199,4 @@ https://yams.media/config 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. +In your browser, you can visit each of the sites to check that they are running correctly. If one of them doesn'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 index afbe8ea..4c023c5 100644 --- a/content/install/using-the-cli.md +++ b/content/install/using-the-cli.md @@ -6,7 +6,7 @@ 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. +YAMS comes with a very handy CLI to manage your media server. Here's where you'll learn how to use it. On your server, you can type: ```bash @@ -33,8 +33,8 @@ 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! -- `check-vpn`: Checks the IP of the qBittorrent service and compares it to your own IP. If they are the same, it's goign to warn you. +- `destroy`: Destroys all the services so you can start the configuration from scratch. ⚠️ Be careful! ⚠️ There's no going back after this! +- `check-vpn`: Checks the IP of the qBittorrent service and compares it to your own IP. If they are the same, it's going to warn you. If you get a `docker` permission error trying to use the CLI, go [here](/faqs/) to fix it. |