kopia lustrzana https://github.com/linuxserver/docker-documentation
Bot Updating Documentation
LinuxServer-CI
rodzic
dab4eb513f
commit
1e00e20dab
|
|
@ -0,0 +1,149 @@
|
|||
# [linuxserver/limnoria](https://github.com/linuxserver/docker-limnoria)
|
||||
|
||||
[](https://github.com/linuxserver/docker-limnoria)
|
||||
[](https://github.com/linuxserver/docker-limnoria/releases)
|
||||
[](https://github.com/linuxserver/docker-limnoria/packages)
|
||||
[](https://gitlab.com/Linuxserver.io/docker-limnoria/container_registry)
|
||||
[](https://quay.io/repository/linuxserver.io/limnoria)
|
||||
[](https://microbadger.com/images/linuxserver/limnoria "Get your own version badge on microbadger.com")
|
||||
[](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/)
|
||||
[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/limnoria/latest/index.html)
|
||||
|
||||
[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/).
|
||||
|
||||
Simply pulling `linuxserver/limnoria` 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 | Tag |
|
||||
| :----: | --- |
|
||||
| x86-64 | amd64-latest |
|
||||
| arm64 | arm64v8-latest |
|
||||
| armhf | arm32v7-latest |
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
Here are some example snippets to help you get started creating a container from this image.
|
||||
|
||||
### docker
|
||||
|
||||
```
|
||||
docker create \
|
||||
--name=limnoria \
|
||||
-e PUID=1000 \
|
||||
-e PGID=1000 \
|
||||
-e TZ=Europe/London \
|
||||
-p 8080:8080 \
|
||||
-v <path to config>:/config \
|
||||
--restart unless-stopped \
|
||||
linuxserver/limnoria
|
||||
```
|
||||
|
||||
|
||||
### docker-compose
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
|
||||
```yaml
|
||||
---
|
||||
version: "2"
|
||||
services:
|
||||
limnoria:
|
||||
image: linuxserver/limnoria
|
||||
container_name: limnoria
|
||||
environment:
|
||||
- PUID=1000
|
||||
- PGID=1000
|
||||
- TZ=Europe/London
|
||||
volumes:
|
||||
- <path to config>:/config
|
||||
ports:
|
||||
- 8080:8080
|
||||
restart: unless-stopped
|
||||
```
|
||||
|
||||
## 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. |
|
||||
|
||||
|
||||
|
||||
## 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)
|
||||
```
|
||||
|
||||
## Application Setup
|
||||
|
||||
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`
|
||||
|
||||
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.
|
||||
|
||||
Then start up the container and place your conf file and any of your existing directories in /config
|
||||
|
||||
|
||||
|
||||
## 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" }}' linuxserver/limnoria`
|
||||
|
||||
## Versions
|
||||
|
||||
* **13.01.20:** - Initial Release.
|
||||
Ładowanie…
Reference in New Issue