9.6 KiB

Czysty Wina Historia

title
limnoria

linuxserver/limnoria

Limnoria A robust, full-featured, and user/programmer-friendly Python IRC bot, with many existing plugins. Successor of the well-known Supybot.

Supported Architectures

We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.

Simply pulling lscr.io/linuxserver/limnoria:latest should retrieve the correct image for your arch, but you can also pull specific arch images via tags.

The architectures supported by this image are:

Architecture	Available	Tag
x86-64	✅	amd64-<version tag>
arm64	✅	arm64v8-<version tag>
armhf	❌

Application Setup

New Configuration

If you do not have an existing config you will need to start the container and then run the following wizard command:

docker exec -it -w /config -u abc limnoria limnoria-wizard

Existing Configuration

If you have an existing config, adjust the directory settings in your conf file as follows:

supybot.directories.backup: /config/backup
supybot.directories.conf: /config/conf
supybot.directories.data: /config/data
supybot.directories.data.tmp: /config/data/tmp
supybot.directories.data.web: /config/web
supybot.directories.log: /config/logs
supybot.directories.plugins: /config/plugins

NOTE: These are not grouped together in the file. You will need to search your conf file for the variables.

Then place your conf file and any of your existing directories in /config and start up the container.

Plugin Requirements

The container will pip install any requirements.txt it finds in the /config/plugins folder on startup.

If you install a plugin using the PluginDownloader that includes a requirements.txt you can execute a shell into the container and then use pip install /config/plugins/ThePlugin/requirements.txt or restart the container and the requirements will be installed.

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.

docker-compose (recommended, click here for more info)

---
version: "2.1"
services:
  limnoria:
    image: lscr.io/linuxserver/limnoria:latest
    container_name: limnoria
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
    volumes:
      - path/to/config:/config
    ports:
      - 8080:8080
    restart: unless-stopped

docker cli (click here for more info)

docker run -d \
  --name=limnoria \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -p 8080:8080 \
  -v path/to/config:/config \
  --restart unless-stopped \
  lscr.io/linuxserver/limnoria:latest

Parameters

Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

Ports (`-p`)

Parameter	Function
`8080`	Port for Limnoria's web interface.

Environment Variables (`-e`)

Env	Function
`PUID=1000`	for UserID - see below for explanation
`PGID=1000`	for GroupID - see below for explanation
`TZ=Etc/UTC`	specify a timezone to use, see this list.

Volume Mappings (`-v`)

Volume	Function
`/config`	Where Limnoria config is stored.

Miscellaneous Options

Parameter	Function

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__PASSWORD=/run/secrets/mysecretpassword

Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword file.

Umask for running applications

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.

User / Group Identifiers

When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.

Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.

In this instance PUID=1000 and PGID=1000, to find yours use id user as below:

  $ id username
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

Docker Mods

We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.

Support Info

Shell access whilst the container is running:
- docker exec -it limnoria /bin/bash
To monitor the logs of the container in realtime:
- docker logs -f limnoria
Container version number
- docker inspect -f '{{ index .Config.Labels "build_version" }}' limnoria
Image version number
- docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/limnoria:latest

Versions

25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
22.12.22: - Rebase to alpine 3.17.
19.09.22: - Rebase to alpine 3.15.
25.05.21: - Install plugin requirements on container init.
17.05.21: - Add linuxserver wheel index.
13.02.21: - Rebasing to alpine 3.13.
01.06.20: - Rebasing to alpine 3.12.
13.01.20: - Initial Release.

9.6 KiB Czysty Wina Historia