kopia lustrzana https://github.com/linuxserver/docker-documentation
179 wiersze
8.5 KiB
Markdown
179 wiersze
8.5 KiB
Markdown
# [linuxserver/thelounge](https://github.com/linuxserver/docker-thelounge)
|
|
|
|
[](https://github.com/linuxserver/docker-thelounge)
|
|
[](https://github.com/linuxserver/docker-thelounge/releases)
|
|
[](https://github.com/linuxserver/docker-thelounge/packages)
|
|
[](https://gitlab.com/Linuxserver.io/docker-thelounge/container_registry)
|
|
[](https://microbadger.com/images/linuxserver/thelounge "Get your own version badge on microbadger.com")
|
|
[](https://hub.docker.com/r/linuxserver/thelounge)
|
|
[](https://hub.docker.com/r/linuxserver/thelounge)
|
|
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-thelounge/job/master/)
|
|
[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/thelounge/latest/index.html)
|
|
|
|
[Thelounge](https://thelounge.github.io/) (a fork of shoutIRC) is a web IRC client that you host on your own server.
|
|
|
|
## 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/thelounge` 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=thelounge \
|
|
-e PUID=1000 \
|
|
-e PGID=1000 \
|
|
-e TZ=Europe/London \
|
|
-p 9000:9000 \
|
|
-v </path/to/appdata/config>:/config \
|
|
--restart unless-stopped \
|
|
linuxserver/thelounge
|
|
```
|
|
|
|
|
|
### docker-compose
|
|
|
|
Compatible with docker-compose v2 schemas.
|
|
|
|
```yaml
|
|
---
|
|
version: "2.1"
|
|
services:
|
|
thelounge:
|
|
image: linuxserver/thelounge
|
|
container_name: thelounge
|
|
environment:
|
|
- PUID=1000
|
|
- PGID=1000
|
|
- TZ=Europe/London
|
|
volumes:
|
|
- </path/to/appdata/config>:/config
|
|
ports:
|
|
- 9000:9000
|
|
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 |
|
|
| :----: | --- |
|
|
| `9000` | Application WebUI |
|
|
|
|
|
|
### 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` | 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:
|
|
|
|
```
|
|
-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
|
|
|
|
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`.
|
|
|
|
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
|
|
|
|
* 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
|
|
[](https://mods.linuxserver.io/?mod=thelounge "view available mods for this container.")
|
|
|
|
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) can be accessed via the dynamic badge above.
|
|
|
|
|
|
## Support Info
|
|
|
|
* Shell access whilst the container is running:
|
|
* `docker exec -it thelounge /bin/bash`
|
|
* To monitor the logs of the container in realtime:
|
|
* `docker logs -f thelounge`
|
|
* Container version number
|
|
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' thelounge`
|
|
* Image version number
|
|
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/thelounge`
|
|
|
|
## Versions
|
|
|
|
* **19.12.19:** - Rebasing to alpine 3.11.
|
|
* **28.06.19:** - Rebasing to alpine 3.10.
|
|
* **15.05.19:** - Update Arm variant images to build sqlite3 module.
|
|
* **23.03.19:** - Switching to new Base images, shift to arm32v7 tag.
|
|
* **22.02.19:** - Rebasing to alpine 3.9.
|
|
* **28.01.19:** - Add pipeline logic and multi arch.
|
|
* **25.08.18:** - Use global install, simplifies adding users.
|
|
* **20.08.18:** - Rebase to alpine 3.8.
|
|
* **06.01.18:** - Rebase to alpine 3.7.
|
|
* **26.05.17:** - Rebase to alpine 3.6.
|
|
* **06.02.17:** - Rebase to alpine 3.5.
|
|
* **14.10.16:** - Bump to pickup 2.10 release.
|
|
* **14.10.16:** - Add version layer information.
|
|
* **11.09.16:** - Add layer badges to README.
|
|
* **31.08.16:** - Initial Release.
|