diff --git a/images/docker-limnoria.md b/images/docker-limnoria.md index 19b000a724..3d1017ecd4 100644 --- a/images/docker-limnoria.md +++ b/images/docker-limnoria.md @@ -1,6 +1,9 @@ --- title: limnoria --- + + + # [linuxserver/limnoria](https://github.com/linuxserver/docker-limnoria) [![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-limnoria.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-limnoria) @@ -29,6 +32,27 @@ The architectures supported by this image are: | arm64 | arm64v8-latest | | armhf | arm32v7-latest | +## 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 ## Usage @@ -58,7 +82,7 @@ services: ### docker cli -``` +```bash docker run -d \ --name=limnoria \ -e PUID=1000 \ @@ -70,7 +94,6 @@ docker run -d \ ghcr.io/linuxserver/limnoria ``` - ## Parameters Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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. @@ -81,7 +104,6 @@ Docker images are configured using parameters passed at runtime (such as those a | :----: | --- | | `8080` | Port for Limnoria's web interface. | - ### Environment Variables (`-e`) | Env | Function | @@ -96,15 +118,13 @@ Docker images are configured using parameters passed at runtime (such as those a | :----: | --- | | `/config` | Where Limnoria config is stored. | - - ## Environment variables from files (Docker secrets) You can set any environment variable from a file by using a special prepend `FILE__`. As an example: -``` +```bash -e FILE__PASSWORD=/run/secrets/mysecretpassword ``` @@ -115,7 +135,6 @@ Will set the environment variable `PASSWORD` based on the contents of the `/run/ 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. - ## 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`. @@ -124,40 +143,17 @@ Ensure any volume directories on the host are owned by the same user you specify In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below: -``` +```bash $ 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 - - ## Docker Mods + [![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=limnoria&query=%24.mods%5B%27limnoria%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=limnoria "view available mods for this container.") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal "view available universal mods.") 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. - ## Support Info * Shell access whilst the container is running: