⛩️
shinkro
GithubDiscord
  • shinkro Documentation
  • Installation
    • Docker
    • Linux
    • Windows
  • Configuration
    • shinkro config.toml
    • shinkro MAL authentication
    • Reverse Proxy
  • Setup Plex or Tautulli
    • shinkro URL
    • Plex Webhook
    • Tautulli
  • Usage
    • General Usage FAQ
    • Correct Anime Matching
Powered by GitBook
On this page
  • Download
  • Unpack
  • Run shinkro to create example config.toml
  • Edit config.toml via nano or your preferred editor
  • Optionally, set up a reverse proxy (recommended)
  • Setup systemd service
  • Authenticate shinkro to update your MAL account
  • Setup Plex or Tautulli to use shinkro
  1. Installation

Linux

Installation instructions for Linux

PreviousDockerNextWindows

Last updated 1 year ago

Download

Download the latest release.

wget $(curl -s https://api.github.com/repos/varoOP/shinkro/releases/latest | grep download | grep linux_amd64 | cut -d\" -f4)

Unpack

sudo tar -C /usr/local/bin -xzf shinkro*.tar.gz shinkro

This will extract shinkro to /usr/local/bin.

Run shinkro to create example config.toml

shinkro

You can optionally mention the config directory using the --config flag:

shinkro --config ~/.config/shinkro

Edit config.toml via nano or your preferred editor

nano $HOME/.config/shinkro/config.toml

Follow the shinkro configuration page below to edit and save the config.toml file. At minimum, you must set shinkro.Username, shinkro.Password, plex.PlexUsername, and plex.AnimeLibraries.

Optionally, set up a reverse proxy (recommended)

Setup systemd service

On Linux-based systems, it is recommended to run shinkro as a sort of service with auto-restarting capabilities, in order to account for potential downtime. The most common way is to do it via systemd.

Create a service file in /etc/systemd/system/ called shinkro.service:

sudo touch /etc/systemd/system/shinkro@.service

Then open the file for editing via nano or your preferred editor:

sudo nano /etc/systemd/system/shinkro@.service

Add the following contents:

[Unit]
Description=shinkro service for %i
After=syslog.target network-online.target

[Service]
Type=simple
User=%i
Group=%i
ExecStart=/usr/bin/shinkro --config=/home/%i/.config/shinkro

[Install]
WantedBy=multi-user.target

Start the service. Enable will make it startup on reboot.

systemctl enable -q --now --user shinkro@$USER

Authenticate shinkro to update your MAL account

Setup Plex or Tautulli to use shinkro

The recommended way is to use the official Plex Webhook but it requires a Plex pass. If you do not have a plex pass, you can use Tautulli.

shinkro config.toml
Reverse Proxy
shinkro MAL authentication
Setup Plex or Tautulli