Getting Started

What is Zilean?

Zilean is a service that allows you to search for DebridMediaManager sourced content shared by users. The DMM import reruns on missing pages in the configured time interval see Configuration.

This can then be configured as a Torznab indexer in your favorite content application.

Newly added is the ability for Zilean to scrape from your running Zurg instance, and from other running Zilean instances.

Installation

The easiest way to get up and running with Zilean is to use the provided docker-compose file.

Ensure you have the following installed:

Docker, Docker Desktop or Podman

The example compose file below can be copied, and used to get the system running locally.

volumes:
  zilean_data:
  zilean_tmp:
  postgres_data:

services:
  zilean:
    image: ipromknight/zilean:latest
    restart: unless-stopped
    container_name: zilean
    tty: true
    ports:
      - "8181:8181"
    volumes:
      - zilean_data:/app/data
      - zilean_tmp:/tmp
    healthcheck:
      test: curl --connect-timeout 10 --silent --show-error --fail http://localhost:8181/healthchecks/ping
      timeout: 60s
      interval: 30s
      retries: 10
    depends_on:
      postgres:
        condition: service_healthy

  postgres:
    image: postgres:17.2-alpine
    container_name: postgres
    restart: unless-stopped
    shm_size: 2G
    environment:
      PGDATA: /var/lib/postgresql/data/pgdata
      POSTGRES_USER: postgres
      POSTGRES_PASSWORD: postgres
      POSTGRES_DB: zilean
    volumes:
      - postgres_data:/var/lib/postgresql/data/pgdata
    healthcheck:
      test: [ "CMD-SHELL", "pg_isready -U postgres" ]
      interval: 10s
      timeout: 5s
      retries: 5

This compose file will start the following services:

Zilean
Postgres (version 17)

The configuration and persistent storage of both services will be stored in docker volumes, but i recommend changing this if you are not on windows to the ./data directory, next to where the compose file resides.

Pulling Latest Image

If you would like to pull the latest image from the docker registry, you can use the following command:

docker compose pull zilean

Last modified: 24 January 2025