Statefile Manual

Name

Deluge - Deploy deluge server using LinuxServer.io image.

Tags

cargo, torrent, downloader

Synopsis

nanocl state apply -s nr.next-hat.com/v0.17/deluge -- [--help] ARGUMENTS

nanocl state rm -s nr.next-hat.com/v0.17/deluge -- [--help] ARGUMENTS

Description

Deluge is a lightweight, Free Software, cross-platform BitTorrent client. This cargo uses the LinuxServer.io image. It will allow you to manage your torrents through a web interface. Documentation: https://docs.linuxserver.io/images/docker-deluge Source: https://github.com/linuxserver/docker-deluge

Arguments

--namespace String

Nanocl namespace to deploy the cargo Default: global

--name String

Name of the cargo Default: deluge

--puid String

Change this to your user ID Default: 1000

--pgid String

Change this to your group ID Default: 1000

--timezone String

Change this to your timezone Default: Etc/UTC

--base-dir-path String

Base path for container configurations Default: /opt/nanocl/containers

--proxy-network String

The network the proxy will bind to in order to be accessible using the domain Default: All

--domain String

Domain to use for the proxy rules

--enable_internal_gateway Boolean

Add $$INTERNAL_GATEWAY to container DNS when enabled

--enable_internal_dns Boolean

Create an internal DNS rule for this cargo when enabled

Content

ApiVersion: v0.17
Args:
  - Name: namespace
    Kind: String
    Default: global
    Description: Nanocl namespace to deploy the cargo
  - Name: name
    Kind: String
    Default: deluge
    Description: Name of the cargo
  - Name: puid
    Kind: String
    Default: '1000'
    Description: Change this to your user ID
  - Name: pgid
    Kind: String
    Default: '1000'
    Description: Change this to your group ID
  - Name: timezone
    Kind: String
    Default: Etc/UTC
    Description: Change this to your timezone
  - Name: base-dir-path
    Kind: String
    Default: /opt/nanocl/containers
    Description: Base path for container configurations
  - Name: proxy-network
    Kind: String
    Default: All
    Description: >-
      The network the proxy will bind to in order to be accessible using the
      domain
  - Name: domain
    Kind: String
    Description: Domain to use for the proxy rules
  - Name: enable_internal_gateway
    Kind: Boolean
    Description: Add $$INTERNAL_GATEWAY to container DNS when enabled
  - Name: enable_internal_dns
    Kind: Boolean
    Description: Create an internal DNS rule for this cargo when enabled
Namespace: ${{ Args.namespace }}
Cargoes:
  - Name: ${{ Args.name }}
    Container:
      Image: lscr.io/linuxserver/deluge:latest
      Env:
        - PUID=${{ Args.puid }}
        - PGID=${{ Args.pgid }}
        - TZ=${{ Args.timezone }}
        - DELUGE_LOGLEVEL=error
      Dns:
        - $${INTERNAL_GATEWAY}
      HostConfig:
        Binds:
          - ${{ Args.base-dir-path }}/${{ Args.name }}/config:/config
          - ${{ Args.base-dir-path }}/${{ Args.name }}/downloads:/downloads
Resources:
  - Name: http.${{ Args.domain }}
    Kind: ncproxy.io/rule
    Data:
      Rules:
        - Domain: ${{ Args.domain }}
          Network: ${{ Args.proxy-network }}
          Locations:
            - Path: /
              Target:
                Key: ${{ Args.name }}.${{ Args.namespace }}.c
                Port: 8112
  - Name: dns.${{ Args.domain }}
    Kind: ncdns.io/rule
    Data:
      Network: Internal
      Entries:
        - Name: ${{ Args.domain }}
          IpAddress: Internal