⛩️
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
  • docker-compose.yml:
  • Note on Environment Variables
  • Configure shinkro
  • Setup a Reverse Proxy (Recommended)
  • Authenticate shinkro to update your MAL account
  • Setup your Plex Media Server or Tautulli to use shinkro
  1. Installation

Docker

Install shinkro using its docker image

docker-compose.yml:

---
version: "1.0"
services:
  shinkro:
    image: ghcr.io/varoop/shinkro:latest
    container_name: shinkro
    volumes:
      - /path/to/shinkro/config:/config
    ports:
      - "7011:7011"
    restart: unless-stopped
    environment:
      #Required for first start
      - SHINKRO_USERNAME=shinkro
      - SHINKRO_PASSWORD=shinkro
      - PLEX_USERNAME=shinkro
      - ANIME_LIBRARIES=Library1,Library2,Library3
      #Optional
      #- PUID=1000
      #- PGID=1000

Note on Environment Variables

Configure shinkro

Setup a Reverse Proxy (Recommended)

Authenticate shinkro to update your MAL account

Setup your Plex Media Server or Tautulli to use shinkro

Previousshinkro DocumentationNextLinux

Last updated 1 year ago

The "Required for first start" environment variables only create the initial file of shinkro for you. They do not overwrite the config.toml file after its created once. Therefore, after the first run, you can make any required changes directly to the config.toml file. PUID and PGID can be set as required and will always take effect. They can be used to run shinkro in the container as a non-root user.

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