linuxserver/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
✅
arm32v7-<version tag>
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:
1
supybot.directories.backup: /config/backup
2
supybot.directories.conf: /config/conf
3
supybot.directories.data: /config/data
4
supybot.directories.data.tmp: /config/data/tmp
5
supybot.directories.data.web: /config/web
6
supybot.directories.log: /config/logs
7
supybot.directories.plugins: /config/plugins
Copied!
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)
1
---
2
version: "2.1"
3
services:
4
  limnoria:
5
    image: lscr.io/linuxserver/limnoria:latest
6
    container_name: limnoria
7
    environment:
8
      - PUID=1000
9
      - PGID=1000
10
      - TZ=Europe/London
11
    volumes:
12
      - path/to/config:/config
13
    ports:
14
      - 8080:8080
15
    restart: unless-stopped
Copied!
docker cli (click here for more info)
1
docker run -d \
2
  --name=limnoria \
3
  -e PUID=1000 \
4
  -e PGID=1000 \
5
  -e TZ=Europe/London \
6
  -p 8080:8080 \
7
  -v path/to/config:/config \
8
  --restart unless-stopped \
9
  lscr.io/linuxserver/limnoria:latest
Copied!
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=Europe/London
Specify a timezone to use EG Europe/London.
Volume Mappings (-v)
Volume
Function
/config
Where Limnoria config is stored.
Miscellaneous Options
Environment variables from files (Docker secrets)
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
1
-e FILE__PASSWORD=/run/secrets/mysecretpassword
Copied!
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:
1
  $ id username
2
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
Copied!
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.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.