Bot Updating Documentation

pull/38/head
LinuxServer-CI 2021-04-20 04:05:03 +00:00
rodzic e56d6c46d7
commit 007c695eaa
1 zmienionych plików z 22 dodań i 25 usunięć

Wyświetl plik

@ -1,6 +1,9 @@
---
title: thelounge
---
<!-- DO NOT EDIT THIS FILE MANUALLY -->
<!-- Please read the https://github.com/linuxserver/docker-thelounge/blob/master/.github/CONTRIBUTING.md -->
# [linuxserver/thelounge](https://github.com/linuxserver/docker-thelounge)
[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-thelounge.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-thelounge)
@ -29,6 +32,21 @@ The architectures supported by this image are:
| arm64 | arm64v8-latest |
| armhf | arm32v7-latest |
## Application Setup
* When the application first runs, it will populate its /config
* Stop the container
* Now from the host, edit `/config/config.js`, wherever you've mapped it
* In most cases you want the value `public: false` to allow named users only
* Setting the two prefetch values to true improves usability, but uses more storage
* Once you have the configuration you want, save it and start the container again
* For each user, run the command
* `docker exec -it thelounge s6-setuidgid abc thelounge add <user>`
* You will be prompted to enter a password that will not be echoed.
* Saving logs to disk is the default, this consumes more space but allows scrollback.
* To log in to the application, browse to `http://<hostip>:9000`
* You should now be prompted for a username and password on the webinterface.
* Once logged in, you can add an IRC network. Some defaults are preset for Freenode.
## Usage
@ -58,7 +76,7 @@ services:
### docker cli
```
```bash
docker run -d \
--name=thelounge \
-e PUID=1000 \
@ -70,7 +88,6 @@ docker run -d \
ghcr.io/linuxserver/thelounge
```
## 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.
@ -81,7 +98,6 @@ Docker images are configured using parameters passed at runtime (such as those a
| :----: | --- |
| `9000` | Application WebUI |
### Environment Variables (`-e`)
| Env | Function |
@ -96,15 +112,13 @@ Docker images are configured using parameters passed at runtime (such as those a
| :----: | --- |
| `/config` | Configuration files. |
## 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 +129,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,33 +137,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
* When the application first runs, it will populate its /config
* Stop the container
* Now from the host, edit `/config/config.js`, wherever you've mapped it
* In most cases you want the value `public: false` to allow named users only
* Setting the two prefetch values to true improves usability, but uses more storage
* Once you have the configuration you want, save it and start the container again
* For each user, run the command
* `docker exec -it thelounge s6-setuidgid abc thelounge add <user>`
* You will be prompted to enter a password that will not be echoed.
* Saving logs to disk is the default, this consumes more space but allows scrollback.
* To log in to the application, browse to `http://<hostip>:9000`
* You should now be prompted for a username and password on the webinterface.
* Once logged in, you can add an IRC network. Some defaults are preset for Freenode.
## Docker Mods
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=thelounge&query=%24.mods%5B%27thelounge%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=thelounge "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: