GitBook: [docs] 4 pages and 32 assets modified

docs/SUMMARY.md

@@ -4,8 +4,8 @@
 
 ## Getting Started
 
-* [Installation](getting-started/installation.md)
-  * [Install as a Daemon](getting-started/install-as-a-daemon.md)
+* [Installation](getting-started/installation/README.md)
+  * [Install as a Daemon](getting-started/installation/install-as-a-daemon.md)
 * [Upgrading to Python 3](getting-started/upgrading-to-python-3.md)
 
 ## Using Tautulli

docs/getting-started/installation/README.md

@@ -364,7 +364,7 @@ Parameters are split into two halves separated by a colon. The left side represe
 | `-e PGID=<gid>` | Group ID \(see below\) | Optional |
 | `-e TZ=<timezone>` | Lookup `TZ` value [here](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) \(e.g. America/Toronto\) | Required |
 
-### User / Group Identifiers:
+### User / Group Identifiers
 
 When using data volumes \(`-v` flags\) permissions issues can arise between the host OS and the container. To avoid this issue you can specify the user `PUID` and group `PGID`. Ensure the data volume directory on the host is owned by the same user you specify.
 
@@ -377,7 +377,7 @@ uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
 
 ## Synology
 
-You can easily install _Tautulli_ on Synology devices using [Docker](installation.md#docker). Depending on your Synology device you may or may not have Docker pre-installed. If your device is 'unsupported' \(i.e. Docker is not pre-installed or downloadable through the Synology _Package Center_\), follow the guide [here](https://web.archive.org/web/20190730155552/https://tylermade.net/2017/09/28/how-to-install-docker-on-an-unsupported-synology-nas/) and newer versions of the Docker spk found [here](https://archive.synology.com/download/Package/Docker) to install it.
+You can easily install _Tautulli_ on Synology devices using [Docker](./#docker). Depending on your Synology device you may or may not have Docker pre-installed. If your device is 'unsupported' \(i.e. Docker is not pre-installed or downloadable through the Synology _Package Center_\), follow the guide [here](https://web.archive.org/web/20190730155552/https://tylermade.net/2017/09/28/how-to-install-docker-on-an-unsupported-synology-nas/) and newer versions of the Docker spk found [here](https://archive.synology.com/download/Package/Docker) to install it.
 
 Once you have Docker on your Synology, add the [official image](https://hub.docker.com/r/tautulli/tautulli/) for Tautulli. This is done by opening the Docker program and searching the **Registry** tab for Tautulli. At the time of this write-up, the interface looked like [this](https://imgur.com/EqxJT91). The official image is named `tautulli/tautulli` and it may not be the first option listed. Double-click the image entry to download it. Once downloaded you will see the image show up under your **Image** tab. Before installing the image you will need some additional user information.
 
@@ -439,7 +439,7 @@ Finalize the container by applying the _advanced settings_ and then following th
 
 If your container doesn't immediately run, launch it from the Docker window and give it a few dozen seconds to start completely. Your _Tautulli_ installation should now be accessible via port `8181` \(or your other _Local Port_\) on your DiskStation's local IP address. You can find this under Control Panel -&gt; Network -&gt; Network Interface under `LAN1` or `LAN2`. For example if it shows `192.168.0.5`, then Tautulli can be found at `http://192.168.0.5:8181/`.
 
-### How to update the container
+### Updating the Container
 
 * See [here](https://mendesconsulting.net/2018/03/26/updating-docker-containers-on-synology/) for instructions on updating a Docker container on Synology.
 
@@ -447,7 +447,7 @@ If your container doesn't immediately run, launch it from the Docker window and
 
 {% tabs %}
 {% tab title="Docker" %}
-Installing using [Docker](installation.md#docker) is recommended if it is supported by your NAS.
+Installing using [Docker](./#docker) is recommended if it is supported by your NAS.
 {% endtab %}
 
 {% tab title="Package" %}
@@ -463,7 +463,7 @@ You can install Tautulli on Western Digital devices using the [WD package by Tfl
 
 {% tabs %}
 {% tab title="Docker" %}
-Installing using [Docker](installation.md#docker) is recommended if it is supported by your NAS.
+Installing using [Docker](./#docker) is recommended if it is supported by your NAS.
 {% endtab %}
 
 {% tab title="Package" %}
@@ -482,7 +482,7 @@ You can install Tautulli on QNAP devices using the `.qpkg` by QNAP\_Stephane:
 
 {% tabs %}
 {% tab title="Docker" %}
-Installing using [Docker](installation.md#docker) is recommended if it is supported by your NAS.
+Installing using [Docker](./#docker) is recommended if it is supported by your NAS.
 {% endtab %}
 
 {% tab title="Package" %}
@@ -498,7 +498,7 @@ You can install Tautulli on ReadyNAS devices using the [ReadyNAS app by Mhynlo](
 
 {% tabs %}
 {% tab title="Docker" %}
-Installing using [Docker](installation.md#docker) is recommended if it is supported by your NAS.
+Installing using [Docker](./#docker) is recommended if it is supported by your NAS.
 {% endtab %}
 
 {% tab title="Package" %}
@@ -514,7 +514,7 @@ You can install Tautulli on Thecus devices using the [Thecus app by outkastm](ht
 
 {% tabs %}
 {% tab title="Docker" %}
-Installing using [Docker](installation.md#docker) is recommended if it is supported by your machine.
+Installing using [Docker](./#docker) is recommended if it is supported by your machine.
 {% endtab %}
 
 {% tab title="Package" %}

docs/getting-started/installation/install-as-a-daemon.md

@@ -0,0 +1,40 @@
+# Install as a Daemon
+
+{% hint style="danger" %}
+These steps are presented as guidelines. Your results may vary, depending on operating system, installation path and other settings.
+{% endhint %}
+
+## Windows
+
+Running Tautulli in the background on startup can be enabled by checking Tautulli Settings > Web Interface > Launch at System Startup.
+
+* **Warning**: Make sure to remove any previous Tautulli shortcut from your startup folder or task in Windows Task Scheduler to prevent conflicts with the Tautulli setting! Refer to deprecated instructions below.
+
+Deprecated instructions \#\#\# Interactive This will start Tautulli in the background when you login to Windows without the command prompt. \* Make sure Tautulli is shutdown. \`Tautulli > Settings > Shutdown\` \* Create a new shortcut \(\[screenshot\]\(./images/new\_shortcut.png\)\) in your startup folder with \* Target: \`"C:\Program Files\Python38\pythonw.exe" C:\Tautulli\Tautulli.py\` \* Start in: \`C:\Program Files\Python38\` \* Start Tautulli with the shortcut \#\#\# Non Interactive This will start Tautulli in the background when your computer starts, regardless of whether you are logged in. \* Make sure Tautulli is shutdown. \`Tautulli > Settings > Shutdown\` \* Create a new text file and \[enter the following line\]\(./images/new\_command\_file.png\): Start "C:\Program Files\Python38\pythonw.exe" C:\Tautulli\Tautulli.py \* Save the file in your Tautulli folder as \`Tautulli.cmd\` \(e.g. \`C:\Tautulli\Tautulli.cmd\`\) \* Open the "Run" dialog window \(Win+R\) and run \`%windir%\system32\taskschd.msc\` to open your Windows Task Scheduler. \* Create a new task with the following settings: \* \[General\]\(./images/create\_task\_general.png\): \* Name: Tautulli \* \(•\) Run whether user is logged on or not \* Configure for: Windows 10 \(select your own Windows version\) \* \[Triggers\]\(./images/create\_task\_triggers.png\): \* Add a new trigger: \* Begin the task: At startup \* \[✓\] Delay task for: 30 seconds \(to allow your server to start up, adjust as necessary\) \* Click OK \* \[Actions\]\(./images/create\_task\_actions.png\): \* Add a new action: \* Action: Start a program \* Program/script: \`C:\Tautulli\Tautulli.cmd\` \* Click OK \* \[Settings\]\(./images/create\_task\_settings.png\): \* \[✓\] Allow task to be run on demand \* \[✓\] Run task as soon as possible after a scheduled start is missed \* \[✓\] If the task fails, restart every: 1 minute \* Attempt to restart up to: 3 times \* \[✓\] If the running task does not end when requested, force it to stop \* If the task is already running, then the following rule applies: Do not start a new instance \* Click OK \* Tautulli should show up in the \[list of Active Tasks\]\(./images/list\_of\_active\_tasks.png\). \* Double click on the task, then \[click "Run" on the right hand side\]\(./images/click\_run\_on\_right.png\). The status will change the "Running". \* Once Tautulli has started, the \[status should change back to "Ready" and the last run result should say "The operation completed successfully \(0x0\)"\]\(./images/status\_is\_ready.png\). \* In your Windows Task Manager, there should be a \["pythonw.exe" background process running\]\(./images/pythonw\_background\_process.png\).
+
+## macOS
+
+Running Tautulli in the background on startup can be enabled by checking Tautulli Settings > Web Interface > Launch at System Startup.
+
+* **Warning**: Make sure to remove any previous Tautulli `.plist` files in your `LaunchAgents` folder to prevent conflicts with the Tautulli setting! Refer to deprecated instructions below.
+
+Deprecated instructions Tested on Mac OS X 10.11.3. Assumes Tautulli is installed to \`/Applications/Tautulli\` If you need to specify a version of Python, edit \`com.Tautulli.tautulli.plist\` \* Make sure Tautulli is shutdown. \`Tautulli > Settings > Shutdown\` \* Create the \`~/Library/LaunchAgents\` using the following command: mkdir -p ~/Library/LaunchAgents \* Copy the \`.plist\` file with the following command: cp /Applications/Tautulli/init-scripts/init.osx ~/Library/LaunchAgents/com.Tautulli.tautulli.plist \* To start Tautulli run the following command: launchctl load ~/Library/LaunchAgents/com.Tautulli.tautulli.plist \* To stop Tautulli run the following command: launchctl unload ~/Library/LaunchAgents/com.Tautulli.tautulli.plist
+
+## Linux
+
+Refer to the main \[\[Installation\]\] instructions.
+
+Deprecated instructions Use the following service script for CentOS, Fedora, Debian, Ubuntu, etc. that uses systemd. The instructions are in the script file. \* https://github.com/Tautulli/Tautulli/blob/master/init-scripts/init.systemd
+
+## FreeBSD
+
+Refer to the main \[\[Installation\]\] instructions.
+
+Deprecated instructions This assumes Tautulli is installed to \`/usr/local/share/Tautulli\` as per installation instructions, and user is \`tautulli\`. You can make your own user using: \`sudo adduser\` \* Make sure Tautulli is shutdown. \`Tautulli > Settings > Shutdown\` \* Ensure user permissions are correct: sudo chown -R tautulli:tautulli /usr/local/share/Tautulli \* Copy init script: sudo cp /usr/local/share/Tautulli/init-scripts/init.freebsd /usr/local/etc/rc.d/tautulli \* Enable at boot: sudo sysrc tautulli\_enable="YES" \* To start: sudo service tautulli start \* You can use \`service tautulli \[start \| stop \| restart \| status\]\` to start/stop/restart or check the status of the Tautulli service \* \*\*Note:\*\* You may ignore the warning \`/usr/local/etc/rc.d/tautulli: WARNING: $command\_interpreter /usr/local/bin/python3 != python\`. Optional: \* If you need to change user: sudo sysrc tautulli\_user="USERNAME" \* Set user permissions for the Tautulli directory: chown -R USERNAME:GROUPNAME /usr/local/share/Tautulli \* Run from another directory: sudo sysrc tautulli\_dir="DIRECTORY"
+
+## FreeNAS
+
+Refer to the main \[\[Installation\]\] instructions.
+
+Deprecated instructions This assumes Tautulli is installed to \`/usr/local/share/Tautulli\` as per installation instructions, and user is \`root\`. To automate the Tautulli script just do this in the jail shell \(in root directory\): \* Make sure Tautulli is shutdown. \`Tautulli > Settings > Shutdown\` \* Ensure user permissions are correct: chown -R root:wheel /usr/local/share/Tautulli \* Copy init script: cp /usr/local/share/Tautulli/init-scripts/init.freenas /usr/local/etc/rc.d/tautulli \* Set user to run: sysrc tautulli\_user="root" \* Enable at boot: sysrc tautulli\_enable="YES" \* To start: service tautulli start \* You can use \`service tautulli \[start \| stop \| restart \| status\]\` to start/stop/restart or check the status of the Tautulli service \* \*\*Note:\*\* You may ignore the warning \`/usr/local/etc/rc.d/tautulli: WARNING: $command\_interpreter /usr/local/bin/python3 != python\`. Optional: \* If you need to change user: sysrc tautulli\_user="USERNAME" \* Set user permissions for the Tautulli directory: chown -R USERNAME:GROUPNAME /usr/local/share/Tautulli \* Run from another directory: sysrc tautulli\_dir="DIRECTORY"
+