diff options
Diffstat (limited to 'content')
| -rw-r--r-- | content/install/steps.md | 69 |
1 files changed, 50 insertions, 19 deletions
diff --git a/content/install/steps.md b/content/install/steps.md index 29a18b3..19ebb49 100644 --- a/content/install/steps.md +++ b/content/install/steps.md @@ -24,7 +24,7 @@ Before installing, make sure you have: + `/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 +- **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. - **A VPN service (optional but STRONGLY recommended):** If you can, choose one from [this list](/advanced/vpn#official-supported-vpns). The VPN I always recommend is [Mullvad](https://mullvad.net/en/) for reasons I will explain later in the installation process. ## To install @@ -48,7 +48,7 @@ If you can run `docker run hello-world` without `sudo`, you can continue. If you ### Inspecting the `install` script by yourself (optional). -Its always a good practice to verify and study the scripts you run on your machine. You can always inspect `install.sh` on the Gitlab repo here: https://gitlab.com/rogs/yams/-/blob/master/install.sh. You don't have to be a complete expert in `bash` (I'm definitely not lol), but if you have any experience with the Linux terminal you should be able to at understand what's happening. +Its always a good practice to verify and study the scripts you run on your machine. You can always inspect `install.sh` on the Gitlab repo here: https://gitlab.com/rogs/yams/-/blob/master/docs.org. You don't have to be a complete expert in `bash` (I'm definitely not lol), but if you have any experience with the Linux terminal you should be able to at understand what's happening. ### Cloning from Gitlab ```bash @@ -58,7 +58,7 @@ cd yams ### Installing YAMS ```bash -./install.sh +bash install.sh ``` You'll see the following prompt: @@ -106,13 +106,13 @@ 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: +Please, input your media directory [/srv/media]: ``` 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]: +Are you sure your media directory is "/srv/media"? [y/N]: ``` Select `y` or `n` if you are happy with the folder you selected. Press `[ENTER]` to continue. @@ -120,29 +120,30 @@ Select `y` or `n` if you are happy with the folder you selected. Press `[ENTER]` #### Media service ```bash Time to choose your media service. -Your media service is the one responsible for serving your files to your network. -By default, YAMS support 3 media services: +Your media service is responsible for serving your files to your network. +By default, YAMS supports 3 media services: - jellyfin (recommended, easier) - emby - plex (advanced, always online) +Choose your media service [jellyfin]: ``` It's time to configure the media service! By default, YAMS supports 3 big media services: - [Jellyfin](https://jellyfin.org) (recommended): In my opinion, Jellyfin is the best one. It's fast, easy to configure and Open Source. -- [Emby](https://emby.media): Emby its the one I use on my local config. It's very similar to Jellyfin (Jellyfin is a fork of Emby), and it has almost the same funtionalities. The reason I'm not recommending it is because it has a paid plan and it's closed source. (I'm actually migrating to Jellyfin now!). +- [Emby](https://emby.media): Emby its the one I use on my local config. It's very similar to Jellyfin (Jellyfin is a fork of Emby), and it has almost the same funtionalities. The reason I'm not recommending it is because it has a paid plan and it's closed source. - [Plex](https://plex.tv): I only recommend Plex to advanced users or people who need all the extra stuff it provides, because the interface and all the services might be a little overwhelming if this is your first time with a home server. I don’t like it that much because it’s always online, and it has more functionalities than I need. Also, at least in YAMS, it’s the hardest to configure. But if you want to share your media server with other people easily, Plex is the way to go! Jellyfin and Emby can share media outside your network, but they are a little more complicated to configure. Type one from the list and press [ENTER]. If you don't choose anything, the installer is going to default to Jellyfin. #### VPN ```bash -Time to setup the VPN. +Time to set up the VPN. You can check the supported VPN list here: https://yams.media/advanced/vpn. Do you want to configure a VPN? [Y/n]: ``` -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: +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?: - 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. @@ -157,6 +158,8 @@ What's your VPN service? (with spaces) [mullvad]: First, select your VPN provider. You can go to [this list](/advanced/vpn#official-supported-vpns) and verify the name of your VPN. ```bash +You should read mullvad's documentation in case it has different configurations for username and password. +The documentation for mullvad is here: https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/mullvad.md What's your VPN username? (without spaces): ``` Now, just enter your VPN username. If it has spaces, delete them. @@ -169,8 +172,18 @@ Then, enter your VPN password. The script is going to output `*` characters to h ### Finishing the installation ```bash -Copying /opt/yams/docker-compose.yaml... +Copying docker-compose.example.yaml to /opt/yams/docker-compose.yaml... +docker-compose.example.yaml was copied successfuly! ✅ + +Copying .env.example to /opt/yams/.env... +.env.example was copied successfuly! ✅ + +Copying docker-compose.custom.yaml to /opt/yams/docker-compose.custom.yaml... +docker-compose.custom.yaml was copied successfuly! ✅ Everything installed correctly! 🎉 +Running the server... +This is going to take a while... + ... ... @@ -181,6 +194,21 @@ Everything installed correctly! 🎉 If you get a `docker` permission error, go [here](/faqs/) to fix it. After a lot of docker installing, you'll get a message like this at the end: +```bash +We need your sudo password to install the YAMS CLI and configure permissions... +``` + +In this step, YAMS needs your `sudo` password to configure the `yams` helper. + +```bash +YAMS CLI installed successfully ✅ +Media directory ownership and permissions set successfully ✅ +Install directory ownership and permissions set successfully ✅ +Configuration folder "/opt/yams/config" exists ✅ +Configuration folder ownership and permissions set successfully ✅ +``` + +And the installer ends like this: ```bash ======================================================== @@ -201,14 +229,17 @@ You can check the installation on /opt/yams ======================================================== Everything should be running now! To check everything running, go to: -Prowlarr: http://192.168.0.169:9117/ -qBittorrent: http://192.168.0.169:8080/ -Radarr: http://192.168.0.169:7878/ -Sonarr: http://192.168.0.169:8989/ -Bazarr: http://192.168.0.169:6767/ -Emby: http://192.168.0.169:8096/ -Portainer: http://192.168.0.169:9000/ -Lidarr: http://192.168.0.169:8686/ +Service URLs: +qBittorrent: http://your.ip.address:8080/ +Radarr: http://your.ip.address:7878/ +Sonarr: http://your.ip.address:8989/ +Lidarr: http://your.ip.address:8686/ +Readarr: http://your.ip.address:8787/ +Prowlarr: http://your.ip.address:9696/ +Bazarr: http://your.ip.address:6767/ +jellyfin: http://your.ip.address:8096/ +Portainer: http://your.ip.address:9000/ + You might need to wait for a couple of minutes while everything gets up and running |