2021-02-12 23:39:06 +00:00
---
title: limnoria
---
2021-04-19 02:34:04 +00:00
<!-- DO NOT EDIT THIS FILE MANUALLY -->
<!-- Please read the https://github.com/linuxserver/docker - limnoria/blob/master/.github/CONTRIBUTING.md -->
2020-06-29 08:30:50 +00:00
# [linuxserver/limnoria](https://github.com/linuxserver/docker-limnoria)
2021-12-20 02:28:11 +00:00
[](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Flimnoria)
2020-06-29 08:30:50 +00:00
[](https://github.com/linuxserver/docker-limnoria)
[](https://github.com/linuxserver/docker-limnoria/releases)
[](https://github.com/linuxserver/docker-limnoria/packages)
2020-12-16 17:23:25 +00:00
[](https://gitlab.com/linuxserver.io/docker-limnoria/container_registry)
2021-10-04 02:25:46 +00:00
[](https://quay.io/repository/linuxserver.io/limnoria)
2020-06-29 08:30:50 +00:00
[](https://hub.docker.com/r/linuxserver/limnoria)
[](https://hub.docker.com/r/linuxserver/limnoria)
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-limnoria/job/master/)
2020-11-02 15:47:51 +00:00
[](https://ci-tests.linuxserver.io/linuxserver/limnoria/latest/index.html)
2020-01-16 01:56:41 +00:00
[Limnoria ](https://github.com/ProgVal/limnoria ) A robust, full-featured, and user/programmer-friendly Python IRC bot, with many existing plugins. Successor of the well-known Supybot.
## Supported Architectures
Our images support multiple architectures such as `x86-64` , `arm64` and `armhf` . We utilise the docker manifest for multi-platform awareness. More information is available from docker [here ](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list ) and our announcement [here ](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/ ).
2021-10-04 02:25:46 +00:00
Simply pulling `lscr.io/linuxserver/limnoria` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
2020-01-16 01:56:41 +00:00
The architectures supported by this image are:
| Architecture | Tag |
2020-06-29 08:30:50 +00:00
| :----: | --- |
2020-01-16 01:56:41 +00:00
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v7-latest |
2021-04-19 02:34:04 +00:00
## Application Setup
2021-05-29 15:53:34 +00:00
### New Configuration
2021-04-19 02:34:04 +00:00
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`
2021-05-29 15:53:34 +00:00
### Existing Configuration
2021-04-19 02:34:04 +00:00
If you have an existing config, adjust the directory settings in your conf file as follows:
```conf
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.
2021-05-29 15:53:34 +00:00
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.
2020-06-29 08:30:50 +00:00
2020-01-16 01:56:41 +00:00
## Usage
2021-07-05 02:17:39 +00:00
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
2020-01-16 01:56:41 +00:00
2021-07-05 02:17:39 +00:00
### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
2020-01-16 01:56:41 +00:00
```yaml
---
2020-04-13 08:30:55 +00:00
version: "2.1"
2020-01-16 01:56:41 +00:00
services:
limnoria:
2021-10-04 02:25:46 +00:00
image: lscr.io/linuxserver/limnoria
2020-01-16 01:56:41 +00:00
container_name: limnoria
environment:
- PUID=1000
- PGID=1000
- TZ=Europe/London
volumes:
2021-02-13 00:58:27 +00:00
- path/to/config:/config
2020-01-16 01:56:41 +00:00
ports:
- 8080:8080
restart: unless-stopped
```
2021-07-05 02:17:39 +00:00
### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))
2020-10-05 08:31:12 +00:00
2021-04-19 02:34:04 +00:00
```bash
2020-10-05 08:31:12 +00:00
docker run -d \
--name=limnoria \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Europe/London \
-p 8080:8080 \
2021-02-13 00:58:27 +00:00
-v path/to/config:/config \
2020-10-05 08:31:12 +00:00
--restart unless-stopped \
2021-10-04 02:25:46 +00:00
lscr.io/linuxserver/limnoria
2020-10-05 08:31:12 +00:00
```
2020-01-16 01:56:41 +00:00
## Parameters
2020-06-29 08:30:50 +00:00
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.
2020-01-16 01:56:41 +00:00
2020-06-29 08:30:50 +00:00
### Ports (`-p`)
2020-01-16 01:56:41 +00:00
| Parameter | Function |
2020-06-29 08:30:50 +00:00
| :----: | --- |
2020-01-16 01:56:41 +00:00
| `8080` | Port for Limnoria's web interface. |
2020-06-29 08:30:50 +00:00
### Environment Variables (`-e`)
2020-01-16 01:56:41 +00:00
| Env | Function |
2020-06-29 08:30:50 +00:00
| :----: | --- |
2020-01-16 01:56:41 +00:00
| `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. |
2020-06-29 08:30:50 +00:00
### Volume Mappings (`-v`)
2020-01-16 01:56:41 +00:00
| Volume | Function |
2020-06-29 08:30:50 +00:00
| :----: | --- |
2020-01-16 01:56:41 +00:00
| `/config` | Where Limnoria config is stored. |
2021-10-04 02:25:46 +00:00
#### Miscellaneous Options
| Parameter | Function |
| :-----: | --- |
2020-06-29 08:30:50 +00:00
## Environment variables from files (Docker secrets)
2020-06-01 08:30:56 +00:00
You can set any environment variable from a file by using a special prepend `FILE__` .
As an example:
2021-04-19 02:34:04 +00:00
```bash
2020-06-01 08:30:56 +00:00
-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
2020-06-29 08:30:50 +00:00
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 ](https://en.wikipedia.org/wiki/Umask ) before asking for support.
2020-01-16 01:56:41 +00:00
## User / Group Identifiers
2020-06-29 08:30:50 +00:00
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` .
2020-01-16 01:56:41 +00:00
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:
2021-04-19 02:34:04 +00:00
```bash
2020-01-16 01:56:41 +00:00
$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
```
2020-04-13 08:30:55 +00:00
## Docker Mods
2021-04-19 02:34:04 +00:00
2020-10-05 08:31:12 +00:00
[](https://mods.linuxserver.io/?mod=limnoria "view available mods for this container.") [](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
2020-04-13 08:30:55 +00:00
2020-10-05 08:31:12 +00:00
We publish various [Docker Mods ](https://github.com/linuxserver/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.
2020-04-13 08:30:55 +00:00
2020-01-16 01:56:41 +00:00
## 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
2021-10-04 02:25:46 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/limnoria`
2020-01-16 01:56:41 +00:00
## Versions
2021-05-29 15:53:34 +00:00
* **25.05.21:** - Install plugin requirements on container init.
2021-05-17 21:39:33 +00:00
* **17.05.21:** - Add linuxserver wheel index.
2021-02-13 00:58:27 +00:00
* **13.02.21:** - Rebasing to alpine 3.13.
2020-06-03 05:08:01 +00:00
* **01.06.20:** - Rebasing to alpine 3.12.
2020-01-16 01:56:41 +00:00
* **13.01.20:** - Initial Release.
