docker-documentation/images/docker-thelounge.md

136 wiersze
5.6 KiB
Markdown
Czysty Zwykły widok Historia

2019-09-29 09:44:22 +00:00
# linuxserver/thelounge
2019-02-08 16:52:12 +00:00
2019-09-29 09:44:22 +00:00
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-thelounge.svg?style=flat-square&color=E68523)](https://github.com/linuxserver/docker-thelounge/releases) [![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/thelounge.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/thelounge) [![MicroBadger Size](https://img.shields.io/microbadger/image-size/linuxserver/thelounge.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/thelounge) [![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/thelounge.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/thelounge) [![Docker Stars](https://img.shields.io/docker/stars/linuxserver/thelounge.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/thelounge) [![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-thelounge/job/master/badge/icon?style=flat-square)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-thelounge/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/thelounge/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/thelounge/latest/index.html)
2019-02-08 16:52:12 +00:00
2019-09-29 09:44:22 +00:00
[Thelounge](https://thelounge.github.io/) \(a fork of shoutIRC\) is a web IRC client that you host on your own server.
2019-02-08 16:52:12 +00:00
2019-02-12 14:43:09 +00:00
## Supported Architectures
2019-02-08 16:52:12 +00:00
2019-09-06 15:51:55 +00:00
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/).
2019-02-08 16:52:12 +00:00
2019-02-12 14:43:09 +00:00
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 |
2019-09-29 09:44:22 +00:00
| :---: | :--- |
2019-02-12 14:43:09 +00:00
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
2019-03-24 22:00:24 +00:00
| armhf | arm32v7-latest |
2019-02-08 16:52:12 +00:00
## Usage
2019-02-12 14:43:09 +00:00
Here are some example snippets to help you get started creating a container from this image.
### docker
2019-09-29 09:44:22 +00:00
```text
2019-02-08 16:52:12 +00:00
docker create \
--name=thelounge \
2019-03-08 16:51:40 +00:00
-e PUID=1000 \
-e PGID=1000 \
2019-02-12 14:43:09 +00:00
-e TZ=Europe/London \
2019-02-08 16:52:12 +00:00
-p 9000:9000 \
2019-02-12 14:43:09 +00:00
-v </path/to/appdata/config>:/config \
--restart unless-stopped \
2019-02-08 16:52:12 +00:00
linuxserver/thelounge
```
2019-02-12 14:43:09 +00:00
### docker-compose
Compatible with docker-compose v2 schemas.
```yaml
---
version: "2"
services:
thelounge:
image: linuxserver/thelounge
container_name: thelounge
environment:
2019-03-08 16:51:40 +00:00
- PUID=1000
- PGID=1000
2019-02-12 14:43:09 +00:00
- TZ=Europe/London
volumes:
- </path/to/appdata/config>:/config
ports:
- 9000:9000
restart: unless-stopped
```
2019-02-08 16:52:12 +00:00
2019-02-12 14:43:09 +00:00
## Parameters
2019-02-08 16:52:12 +00:00
2019-09-29 09:44:22 +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.
2019-02-08 16:52:12 +00:00
2019-09-29 09:44:22 +00:00
### Ports \(`-p`\)
2019-02-08 16:52:12 +00:00
2019-02-12 14:43:09 +00:00
| Parameter | Function |
2019-09-29 09:44:22 +00:00
| :---: | :--- |
2019-02-12 14:43:09 +00:00
| `9000` | Application WebUI |
2019-02-08 16:52:12 +00:00
2019-09-29 09:44:22 +00:00
### Environment Variables \(`-e`\)
2019-02-08 16:52:12 +00:00
2019-02-12 14:43:09 +00:00
| Env | Function |
2019-09-29 09:44:22 +00:00
| :---: | :--- |
2019-03-08 16:51:40 +00:00
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
2019-02-12 14:43:09 +00:00
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
2019-02-08 16:52:12 +00:00
2019-09-29 09:44:22 +00:00
### Volume Mappings \(`-v`\)
2019-02-08 16:52:12 +00:00
2019-02-12 14:43:09 +00:00
| Volume | Function |
2019-09-29 09:44:22 +00:00
| :---: | :--- |
2019-02-12 14:43:09 +00:00
| `/config` | Configuration files. |
2019-02-08 16:52:12 +00:00
2019-02-12 14:43:09 +00:00
## User / Group Identifiers
2019-02-08 16:52:12 +00:00
2019-09-29 09:44:22 +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`.
2019-02-08 16:52:12 +00:00
2019-02-12 14:43:09 +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.
2019-02-08 16:52:12 +00:00
2019-03-08 16:51:40 +00:00
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
2019-02-08 16:52:12 +00:00
2019-09-29 09:44:22 +00:00
```text
2019-02-12 14:43:09 +00:00
$ id username
2019-03-08 16:51:40 +00:00
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
2019-02-12 14:43:09 +00:00
```
2019-02-08 16:52:12 +00:00
2019-02-12 14:43:09 +00:00
## Application Setup
2019-02-08 16:52:12 +00:00
2019-09-29 09:44:22 +00:00
* To log in to the application, browse to https://:9000.
* To setup user account\(s\) edit `/config/config.json`
* Change the value `public: true,` to `public: false,`
* restart the container and enter the following from the command line of the host:
* `docker exec -it thelounge thelounge add <user>`
* Enter a password when prompted, refresh your browser.
* You should now be prompted for a password on the webinterface.
2019-02-08 16:52:12 +00:00
2019-02-12 14:43:09 +00:00
## Support Info
2019-02-08 16:52:12 +00:00
2019-09-06 15:51:55 +00:00
* Shell access whilst the container is running:
2019-02-12 14:43:09 +00:00
* `docker exec -it thelounge /bin/bash`
2019-09-06 15:51:55 +00:00
* To monitor the logs of the container in realtime:
2019-02-12 14:43:09 +00:00
* `docker logs -f thelounge`
2019-09-06 15:51:55 +00:00
* Container version number
2019-02-12 14:43:09 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' thelounge`
* Image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/thelounge`
2019-02-08 16:52:12 +00:00
## Versions
2019-07-05 18:48:10 +00:00
* **28.06.19:** - Rebasing to alpine 3.10.
2019-05-16 03:03:19 +00:00
* **15.05.19:** - Update Arm variant images to build sqlite3 module.
2019-03-24 22:00:24 +00:00
* **23.03.19:** - Switching to new Base images, shift to arm32v7 tag.
2019-02-24 17:32:26 +00:00
* **22.02.19:** - Rebasing to alpine 3.9.
2019-02-12 14:43:09 +00:00
* **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.
2019-09-29 09:44:22 +00:00