/ShokoDocs

Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
Raw Blame History
548 lines (423 sloc) 22.8 KB
---
layout: main
title: Configuring Shoko Server Settings
excerpt: Explanation of all the available settings in Shoko Server.
permalink: server/config.html
---
<main class = "main-content">
<div class = "container">
<div class = "row">
<!--
|‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒
| Sidebar
|‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒
!-->
<div class = "col-md-2 col-xl-2 order-last order-md-first">
<hr class = "d-md-none">
<aside class = "sidebar sidebar-sticky sidebar-stick-shadow pr-md-5 br-1">
{% include _sidebar.html %}
</aside>
</div>
<!--
|‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒
| Content
|‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒
!-->
<div class = "col-md col-xl m2-md-auto py-8">
<article>
<h1>{{ page.title }}</h1>
<p class = "lead">You've got Shoko Server installed and have done the minimal setup required to get it properly running. Now it's time to
learn everything Shoko Server can do for you and if you want, further fine-tune it.</p>
<hr class = "my-6">
<section>
<h2 id = "actions-info">What Are Actions?</h2>
<div class = "row">
<div class = "col-xl-8 col-sm-12">
<p>By default, all tasks related to maintaining and updating your collection are done automatically. By default, every task runs
on a <strong>timer</strong>, these timers determine how often certain data sets are updated which in most cases, works just
fine. However, for various reasons you may need to run one of these tasks manually which is made possible by using an
<strong>Action</strong>. Most actions are comprised of multiple related tasks with the action name relating to the task or
tasks it performs.</p>
<p>While manually running task provides a finer control over your collection, there are a few things to remember. </p>
<ul>
<li>Actions are stackable and are added to your queue.</li>
<li>The time required to finish a task depends on your collection size and the task itself.</li>
<li>Its not possible to cancel a single task, clicking the cancel button will cancel all remaining tasks.</li>
<li>The Commands Toolbar at the bottom keeps track of your remaining tasks while showing the tasks being executed.</li>
</ul>
</div>
<div class = "col-xl-4 col-sm-12">
<a href = "/assets/img/server/Shoko-Server-Actions.png" data-lightbox = "image-1"><img
src = "/assets/img/server/Shoko-Server-Actions.png" class = "img-fluid" alt = "Shoko Server - Actions Tab"></a>
</div>
</div>
</section>
<section>
<h2 id = "actions">Available Actions</h2>
<p>Below are the available <strong>Actions</strong> that can be run manually along with their description.</p>
<table class = "table table-bordered">
<thead>
<tr>
<th width = "20%">Available Actions</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>Run Import</td>
<td>Scans your <strong>Local</strong> and <strong>Cloud</strong> import folders and adds any new files that are discovered to
your collection. If new files are found, all associated tasks are also executed.
</td>
</tr>
<tr>
<td>Remove Missing Files</td>
<td>Scans your <strong>Currently Available</strong> import folders and will remove all entries in the database that do not have
a physical file match. If you have import folders that are shared network drives or external drives, make sure they are
accessible by Shoko Server before running this command.
</td>
</tr>
<tr>
<td>Sync MyList</td>
<td>Syncs your collection metadata with your AniDB MyList.</td>
</tr>
<tr>
<td>Sync Trakt Collection</td>
<td>Syncs your collection metadata with your Trakt account.</td>
</tr>
<tr>
<td>Sync Hashes</td>
<td>Syncs your files hashes (ED2k, CRC32, MD5, SHA1) with the Web Cache.
</td>
</tr>
<tr>
<td>Upload Local Votes To AniDB</td>
<td>Syncs your votes with AniDB.
</td>
</tr>
<tr>
<td>Sync Plex Watch Status</td>
<td>Syncs your local watch states with your Plex account.
</td>
</tr>
<tr>
<td>Update All AniDB Series Info</td>
<td>Updates all AniDB series information in your collection.</td>
</tr>
<tr>
<td>Update All TvDB Info</td>
<td>Updates all series TvDB information in your collection.</td>
</tr>
<tr>
<td>Update All Trakt Info</td>
<td>Updates all Trakt series information in your collection.</td>
</tr>
<tr>
<td>Update All Stats</td>
<td>Updates all series stats such as watched state and missing files with.</td>
</tr>
<tr>
<td>Update All Media Info</td>
<td>Updates all technical details about the files in your collection.</td>
</tr>
<tr>
<td>Update Images</td>
<td>Checks current image settings and updates series images to match. Currently this action will only <strong>increase</strong>
the amount of available images, not <strong>decrease</strong> them.
</td>
</tr>
</tbody>
</table>
</section>
<section>
<h2 id = "import-folders">What Are Import Folders?</h2>
<div class = "row">
<div class = "col-xl-8 col-sm-12">
<p>Import Folders are the physical locations of where your files are. This means two things, they <strong>must be accessible
by Shoko Server</strong> and they are <strong>always online</strong>. If using<strong> removable media</strong>, make
sure its connected before running any <strong>import functions</strong> or <strong>file checking functions</strong> to
avoid Shoko removing the entries from your collection database.</p>
<p>There are <strong>two different Import Folder Systems</strong> you can use. The first is <strong>Single Folder</strong>which
has Shoko add the contents of the folder to your collection. The second is <strong>Drop Source/Destination</strong>which
has Shoko move files from the <strong>Drop Source</strong> into the <strong>Drop Destination</strong>. You can use both
of these systems at the same time and/or use them both for the same import folder.</p>
<p>There are two options available for managing Import Folders.</p>
<table class = "table table-bordered">
<thead>
<tr>
<th width = "20%">Option</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>Remove</td>
<td>Will remove the <strong>selected</strong> import folder. This will not <strong>physically</strong> delete the
files but will remove them from your collection.
</td>
</tr>
<tr>
<td>New Folder</td>
<td>Allows you to add a new Import Folder for use with Shoko Server.</td>
</tr>
</tbody>
</table>
</div>
<div class = "col-xl-4 col-sm-12">
<a href = "/assets/img/server/Shoko-Server-Import-Folders.png" data-lightbox = "image-1"><img
src = "/assets/img/server/Shoko-Server-Import-Folders.png" class = "img-fluid"
alt = "Shoko Server - Import Folders Tab"></a>
</div>
</div>
<h2 id = "import-time">How Long Will Importing Take?</h2>
<p>This is no simple answer to this question as the time required to import a file varies based on multiple criteria such as the
file size, the series it belongs to and the metadata associated with the series. However there is a process every imported file
goes through which is detailed below.</p>
<p><strong>1. Hashing The File</strong></p>
<p>The file is first hashed, the amount of time this takes depends on a couple different factors such as the file size, your CPU and
the HDD read/write speed that contains the file.</p>
<p><strong>2. Comparing Hash On AniDB</strong></p>
<p>Once the file has been hashed, the hash is sent to AniDB for comparison. If the hash is found on AniDB then the file is
associated with the episode the hash belongs to and the series the episode belongs to is added to your collection. If this is a
new series, then additional commands are added to the <strong>General Worker</strong> to pull the needed data for the series
from AniDB.</p>
<p><strong>3. Downloading Additional Metadata</strong></p>
<p>If the file belongs to a new series, information related to the series and each episode in the series is downloaded from The
TvDB. If additional community sites are enabled, such as Trakt.TV then additional commands are added to the <strong>General
Worker</strong> to update the metadata on your profile on those sites.</p>
<h2 id = "new-import-folder">Adding A New Import Folder</h2>
<div class = "row">
<div class = "col-xl-8 col-sm-12">
<p>Click<strong> New Folder</strong> to add a import folder for your collection.</p>
<p>A new window will open allowing you to specify the import folder's settings. To make things easier and reduce the chance
of making a mistake, we recommend clicking the <strong>Folder Icon</strong> to select the location of the import folder.
If your import folders are external hard drives, network drives or hosted on the cloud, make sure to update their
locations if they happen to change. Otherwise you'll start to receive errors and depending on the actions you run, the
entries for those files in your database could be deleted.
</p>
<p>Each Import Folder you add has its own setting that can be configured depending on your setup.</p>
</div>
<div class = "col-xl-4 col-sm-12">
<a href = "/assets/img/server/Shoko-Server-Add-Import-Folder.png" data-lightbox = "image-1"><img
src = "/assets/img/server/Shoko-Server-Add-Import-Folder.png" class = "img-fluid"
alt = "Shoko Server - Add Import Folder"></a>
</div>
</div>
<table class = "table table-bordered">
<thead>
<tr>
<th width = "20%">Option</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>Provider</td>
<td> The Import Folder type, if you've added a <strong>Cloud Account</strong> you'll be able to select it otherwise <strong>Local
File System</strong> will be selected by default. Please note, Import Folders are linked to
a <strong>Single </strong><strong>Provider</strong> and <strong>cannot be used with Import Folders from another
Provider</strong>.
</td>
</tr>
<tr>
<td>Import Folder Path</td>
<td> The location of the Import Folder, if it's a <strong>Local Provider </strong>then you'll select the folder and if it's
a<strong>Cloud Provider</strong> then you'll select the folder from a list of available folders.
</td>
</tr>
<tr>
<td>Drop Source</td>
<td>An Import Folder marked as a Drop Source will have it's files moved to the folder marked as a <strong>Drop
Destination</strong>. To have Shoko Server moves files automatically from a Drop Source once detected, make sure to
enable <strong>Watch For New Files</strong> for the that Drop Source.
</td>
</tr>
<tr>
<td>Drop Destination</td>
<td>Used in conjunction with at lease one <strong>Drop Source</strong>. All files will be moved and sorted into the
specified <strong>Drop Destination</strong> with files belonging to the same series automatically grouped up and placed
in a new folder with the series named based on your <strong>Preferred Language Preference</strong> setting.
You can only have one <strong>Drop Destination per Provider</strong> and cannot use <strong>Drop
Sources</strong> from a different Provider.
</td>
</tr>
<tr>
<td>Watch For New Files</td>
<td>An Import Folder marked with <strong>Watch For New Files </strong>will have any files detected imported into your
collection. Useful if use a custom sorting solution and don't want Shoko Server moving your files for you and don't want
to have to manually execute <strong>Run Import</strong> each time you add files to your Import Folder.
</td>
</tr>
</tbody>
</table>
</section>
<section>
<h2 id = "supported-hosts">Supported Cloud Hosts</h2>
<div class = "row">
<div class = "col-xl-8 col-sm-12">
<p>We currently support the following cloud hosts. While we cannot guarantee we'll add your cloud host, if it's not listed below
you can always request support for it by creating an issue on GitHub.</p>
<ul>
<li>Amazon Cloud Drive</li>
<li>Google Drive</li>
<li>One Drive</li>
</ul>
<p>Please make sure to keep <strong>the following</strong> in mind when using a cloud host.</p>
<ul>
<li>You cannot mix <strong>Import Folders</strong> from two different cloud accounts.</li>
<li>You cannot mix <strong>Local Import Folders</strong> with <strong>Cloud Import Folders</strong>.</li>
<li>If you remove a <strong>Cloud Account</strong>, all associated import folders and files will be removed from your
database.
</li>
<li>If the Import Folder option <strong>Watch For New Files</strong> is selected, the import folder will be checked <strong>every
3 minutes</strong> for new files.
</li>
</ul>
</div>
<div class = "col-xl-4 col-sm-12">
<a href = "/assets/img/server/Shoko-Server-Cloud-Accounts.png" data-lightbox = "image-1"><img
src = "/assets/img/server/Shoko-Server-Cloud-Accounts.png" class = "img-fluid"
alt = "Shoko Server - Cloud Accounts Tab"></a>
</div>
</div>
<h2 id = "add-cloud">Adding A Cloud Host</h2>
<div class = "row">
<div class = "col-xl-8 col-sm-12">
<p>First click the <strong>Add Account</strong> button to open the <strong>Cloud Accounts</strong> window.</p>
<p>Select the <strong>Service</strong> <strong>Provider</strong> you'd like to add then assign a <strong>Name</strong> for the
cloud account, you can name it whatever you'd like as it's just used as a reference for you. Once your'e done click the
<strong>Connect</strong> button, you'll be taken to your selected <strong>Service Providers</strong> website where you'll be
asked to login into your account. This is what allows Shoko access to your cloud account, we don't store your username or
password nor do you have to input it each time Shoko access your cloud account. Read and follow all prompts, once done click
the <strong>Save</strong> button to add your cloud account. </p>
</div>
<div class = "col-xl-4 col-sm-12">
<a href = "/assets/img/server/Shoko-Server-Add-Cloud-Account.png" data-lightbox = "image-1"><img
src = "/assets/img/server/Shoko-Server-Add-Cloud-Account.png" class = "img-fluid"
alt = "Shoko Server - Add Cloud Account"></a>
</div>
</div>
</section>
<section>
<h2 id = "integrity-check">What Is An Integrity Check?</h2>
<div class = "row">
<div class = "col-xl-8 col-sm-12">
<p>A <strong>Integrity Check</strong> allows you to scan your <strong>Import Folders</strong> for possible file corruption. Any
Import Folders you add to a <strong>Integrity Check</strong> will have their files rehashed with the new value compared to
the original value stored in your database from when the file was first imported. Files that have the <strong>same hash
value</strong> pass and are not marked as corrupted, however files that <strong>do not have the same hash value</strong>are
marked as corrupted and displayed in the results panel below. With this utility you can replace corrupted files in your
collection preventing playback errors from happening in the future.</p>
<h4>Managing Previous Integrity Checks</h4>
<p>You can view previous integrity checks by click the <strong>Drop-Down</strong> box and selecting the previous integrity check
you'd like to view. You can also delete an integrity check by click the <strong>Red X</strong> button, you'll be prompted to
confirm deletion.</p>
</div>
<div class = "col-xl-4 col-sm-12">
<a href = "/assets/img/server/Shoko-Server-Integrity.png" data-lightbox = "image-1"><img
src = "/assets/img/server/Shoko-Server-Integrity.png" class = "img-fluid"
alt = "Shoko Server - Integrity Tab"></a>
</div>
</div>
<h2 id = "add-check">Adding An Integrity Check</h2>
<div class = "row">
<div class = "col-xl-8 col-sm-12">
<p>Click the <strong>Add Integrity Check</strong> button to open the <strong>Select Import Folders</strong> window. Now select
the import folders whose files you wish to have checked for possible corruption, once done click the <strong>OK</strong>
button. The integrity check will already be loaded, to start it click the <strong>Green Arrow</strong>. Depending on how big
the import folder is, the integrity check may take some time. You can see how many files are left below along with the
status of the integrity check, if you'd like to pause the integrity clicking the <strong>Blue Pause</strong> button.</p>
</div>
<div class = "col-xl-4 col-sm-12">
<a href = "/assets/img/server/Shoko-Server-Add-Integrity-Check.png" data-lightbox = "image-1"><img
src = "/assets/img/server/Shoko-Server-Add-Integrity-Check.png" class = "img-fluid"
alt = "Shoko Server - Add Integrity Check"></a>
</div>
</div>
</section>
<section>
<h2 id = "available-settings">Available Settings</h2>
<div class = "row">
<div class = "col-xl-8 col-sm-12">
<p>Only a handful of settings are available for configuration in Shoko Server. The rest can be configured either in the Shoko
Server Web UI or Shoko Desktop.</p>
<table class = "table table-bordered">
<thead>
<tr>
<td width = "20%">Option</td>
<td>Description</td>
</tr>
</thead>
<tbody>
<tr>
<td>Server Port</td>
<td>The port Shoko Server will use, by default it’s set to <strong>8111</strong>.</td>
</tr>
<tr>
<td>Image Path</td>
<td>The location where Shoko Server will download and store all images. Clicking <strong>Set Default</strong> will set
the path to <strong>C:\ProgramData\ShokoServer</strong> while clicking <strong>Select Custom Folder</strong> will
allow you to choose a custom location. If using a <strong>Custom Location</strong>, it cannot be a location where
administrative rights are required.
</td>
</tr>
<tr>
<td>Minimize On Startup</td>
<td>If enabled, Shoko Server will start minimized.</td>
</tr>
<tr>
<td>Start With Windows</td>
<td>If enabled, adds a RegKey that makes Shoko Server start with Windows.</td>
</tr>
<tr>
<td>Update AniDB Info</td>
<td>Opens the AniDB account window allowing you to update your AniDB login.</td>
</tr>
<tr>
<td>Launch Web UI</td>
<td>When clicked, will open the Shoko Server Web UI.
</td>
</tr>
</tbody>
</table>
</div>
<div class = "col-xl-4 col-sm-12">
<a href = "/assets/img/server/Shoko-Server-Settings.png" data-lightbox = "image-1"><img
src = "/assets/img/server/Shoko-Server-Settings.png" class = "img-fluid"
alt = "Shoko Server - Settings Tab"></a>
</div>
</div>
<h2 id = "shoko-webui">Shoko Server Web UI</h2>
<p>The Shoko Server Web UI is the eventual replacement to the Shoko Server GUI. As its still in development, some functionality
present in Shoko Server's GUI is not available in the Web UI. However we <strong>highly recommend</strong> all users become familiar
with the Web UI as it contains additional functionality not available in Shoko Server's GUI. </p>
<p>Learn more about the <a href = "../server/webui.html" target = "_blank" rel = "noopener">Shoko Server Web UI</a>.</p>
</section>
{% include _github_callout.html %}
</article>
</div>
<div class = "col-md-2 col-xl-2 right-sidebar">
<hr class = "d-md-none">
<aside class = "sidebar sidebar-sticky">
<nav class = "nav nav-toc-2 mt-3" data-accordion = "true">
<a class = "nav-link sidenav-title">Actions Tab</a>
<a class = "nav-link" href = "#actions-info">What Are Actions?</a>
<a class = "nav-link" href = "#actions">Available Actions</a>
<a class = "nav-link sidenav-title">Import Folders Tab</a>
<a class = "nav-link" href = "#import-folders">What Are Import Folders?</a>
<a class = "nav-link" href = "#import-time">How Long Will Importing Take?</a>
<a class = "nav-link" href = "#new-import-folder">Adding A New Import Folder</a>
<a class = "nav-link sidenav-title">Cloud Tab</a>
<a class = "nav-link" href = "#supported-hosts">Supported Cloud Hosts</a>
<a class = "nav-link" href = "#add-cloud">Adding A Cloud Host</a>
<a class = "nav-link sidenav-title">Integrity Tab</a>
<a class = "nav-link" href = "#integrity-check">What Are Integrity Checks?</a>
<a class = "nav-link" href = "#add-check">Adding An Integrity Check</a>
<a class = "nav-link sidenav-title">Settings Tab</a>
<a class = "nav-link" href = "#available-settings">Available Settings</a>
<a class = "nav-link" href = "#shoko-webui">Shoko Server Web UI</a>
</nav>
</aside>
</div>
</div>
</div>
</main>