# Configuration for kiwix-serve setup

# Name of the big-bear-kiwix-serve application
name: big-bear-kiwix-serve
# Service definitions for the big-bear-kiwix-serve application
services:
  # Service name: big-bear-kiwix-serve
  # The `big-bear-kiwix-serve` service definition
  big-bear-kiwix-serve:
    # Name of the container
    container_name: big-bear-kiwix-serve
    # Image to be used for the container
    image: ghcr.io/kiwix/kiwix-serve:3.7.0-2
    # Command to run inside the container
    command: "*.zim"
    # Container restart policy
    restart: unless-stopped
    # Volumes to be mounted to the container
    volumes:
      # Mounting the local kiwix-serve_zim directory to /data inside the container
      - /DATA/AppData/$AppID/zim:/data
    # Ports mapping between host and container
    ports:
      # Mapping port 8080 of the host to port 8080 of the container
      - "8080:8080"
    x-casaos:
      volumes:
        - container: /data
          description:
            en_us: 'Container Path: /data'
      ports:
        - container: "8080"
          description:
            en_us: 'Container Port: 8080'
x-casaos:
  # Supported CPU architectures for this application
  architectures:
    - amd64
    - arm64
  # Main service for this application
  main: big-bear-kiwix-serve
  # Detailed description for the application
  description:
    en_us: Kiwix Server is a web server for hosting .zim files
  # Brief tagline for the application
  tagline:
    en_us: Kiwix Server
  # Developer's information
  developer: kiwix
  # Author of this particular configuration
  author: BigBearTechWorld
  # Icon URL for the application
  icon: https://cdn.jsdelivr.net/gh/selfhst/icons/png/kiwix.png
  # Thumbnail image for the application (if any)
  thumbnail: ""
  # Installation tips
  tips:
    before_install:
      en_us: |
        Read this before installing: https://community.bigbeartechworld.com/t/added-kiwix-serve-to-bigbearcasaos/1554#documentation-4
  # Title for the application
  title:
    en_us: Kiwix Server
  # Category under which the application falls
  category: BigBearCasaOS
  # Default port mapping for the application
  port_map: "8080"
