kopia lustrzana https://github.com/linuxserver/docker-documentation
Bot Updating Templated Files
LinuxServer-CI
rodzic
56c6bb7071
commit
140841f693
|
|
@ -1,109 +1,143 @@
|
||||||
[linuxserverurl]: https://linuxserver.io
|
# [linuxserver/thelounge](https://github.com/linuxserver/docker-thelounge)
|
||||||
[forumurl]: https://forum.linuxserver.io
|
|
||||||
[ircurl]: https://www.linuxserver.io/irc/
|
|
||||||
[podcasturl]: https://www.linuxserver.io/podcast/
|
|
||||||
[appurl]: https://thelounge.github.io/
|
|
||||||
[hub]: https://hub.docker.com/r/linuxserver/thelounge/
|
|
||||||
|
|
||||||
[][linuxserverurl]
|
[](https://discord.gg/YWrKVTn)
|
||||||
|
[](https://microbadger.com/images/linuxserver/thelounge "Get your own version badge on microbadger.com")
|
||||||
|
[](https://microbadger.com/images/linuxserver/thelounge "Get your own version badge on microbadger.com")
|
||||||
|
|
||||||
|
|
||||||
|
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-thelounge/job/master/)
|
||||||
|
[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/thelounge/latest/index.html)
|
||||||
|
|
||||||
The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at:
|
[Thelounge](https://thelounge.github.io/) (a fork of shoutIRC) is a web IRC client that you host on your own server.
|
||||||
* [forum.linuxserver.io][forumurl]
|
|
||||||
* [IRC][ircurl] on freenode at `#linuxserver.io`
|
|
||||||
* [Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation!
|
|
||||||
|
|
||||||
# linuxserver/thelounge
|
## Supported Architectures
|
||||||
[](https://microbadger.com/images/linuxserver/thelounge "Get your own version badge on microbadger.com")[](https://microbadger.com/images/linuxserver/thelounge "Get your own image badge on microbadger.com")[][hub][][hub][](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-thelounge/)
|
|
||||||
|
|
||||||
TheLounge (a fork of shoutIRC) is a web IRC client that you host on your own server.
|
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).
|
||||||
|
|
||||||
__What features does it have?__
|
Simply pulling `linuxserver/thelounge` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
|
||||||
- Multiple user support
|
|
||||||
- Stays connected even when you close the browser
|
The architectures supported by this image are:
|
||||||
- Connect from multiple devices at once
|
|
||||||
- Responsive layout — works well on your smartphone
|
| Architecture | Tag |
|
||||||
- _.. and more!_
|
| :----: | --- |
|
||||||
|
| x86-64 | amd64-latest |
|
||||||
|
| arm64 | arm64v8-latest |
|
||||||
|
| armhf | arm32v6-latest |
|
||||||
|
|
||||||
[][appurl]
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
|
Here are some example snippets to help you get started creating a container from this image.
|
||||||
|
|
||||||
|
### docker
|
||||||
|
|
||||||
```
|
```
|
||||||
docker create \
|
docker create \
|
||||||
--name=thelounge \
|
--name=thelounge \
|
||||||
-v <path to data>:/config \
|
-e PUID=1001 \
|
||||||
-e PGID=<gid> -e PUID=<uid> \
|
-e PGID=1001 \
|
||||||
-e TZ=<timezone> \
|
-e TZ=Europe/London \
|
||||||
-p 9000:9000 \
|
-p 9000:9000 \
|
||||||
|
-v </path/to/appdata/config>:/config \
|
||||||
|
--restart unless-stopped \
|
||||||
linuxserver/thelounge
|
linuxserver/thelounge
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### docker-compose
|
||||||
|
|
||||||
|
Compatible with docker-compose v2 schemas.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
version: "2"
|
||||||
|
services:
|
||||||
|
thelounge:
|
||||||
|
image: linuxserver/thelounge
|
||||||
|
container_name: thelounge
|
||||||
|
environment:
|
||||||
|
- PUID=1001
|
||||||
|
- PGID=1001
|
||||||
|
- TZ=Europe/London
|
||||||
|
volumes:
|
||||||
|
- </path/to/appdata/config>:/config
|
||||||
|
ports:
|
||||||
|
- 9000:9000
|
||||||
|
mem_limit: 4096m
|
||||||
|
restart: unless-stopped
|
||||||
|
```
|
||||||
|
|
||||||
## Parameters
|
## Parameters
|
||||||
|
|
||||||
`The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side.
|
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.
|
||||||
For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container.
|
|
||||||
So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080
|
### Ports (`-p`)
|
||||||
http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.`
|
|
||||||
|
| Parameter | Function |
|
||||||
|
| :----: | --- |
|
||||||
|
| `9000` | Application WebUI |
|
||||||
|
|
||||||
|
|
||||||
* `-p 9000` - the port(s)
|
### Environment Variables (`-e`)
|
||||||
* `-v /config` -
|
|
||||||
* `-e PGID` for GroupID - see below for explanation
|
|
||||||
* `-e PUID` for UserID - see below for explanation
|
|
||||||
* `-e TZ` for timezone information, eg Europe/London
|
|
||||||
|
|
||||||
It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it thelounge /bin/bash`.
|
| Env | Function |
|
||||||
|
| :----: | --- |
|
||||||
|
| `PUID=1001` | for UserID - see below for explanation |
|
||||||
|
| `PGID=1001` | for GroupID - see below for explanation |
|
||||||
|
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
|
||||||
|
|
||||||
### User / Group Identifiers
|
### Volume Mappings (`-v`)
|
||||||
|
|
||||||
Sometimes when using data 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 the data volume directory on the host is owned by the same user you specify and it will "just work" ™.
|
| Volume | Function |
|
||||||
|
| :----: | --- |
|
||||||
|
| `/config` | Configuration files. |
|
||||||
|
|
||||||
In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below:
|
|
||||||
|
|
||||||
|
## 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=1001` and `PGID=1001`, to find yours use `id user` as below:
|
||||||
|
|
||||||
```
|
```
|
||||||
$ id <dockeruser>
|
$ id username
|
||||||
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
|
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
|
||||||
```
|
```
|
||||||
|
|
||||||
## Setting up the application
|
## Application Setup
|
||||||
|
|
||||||
To log in to the application, browse to https://<hostip>:9000.
|
* To log in to the application, browse to https://<hostip>:9000.
|
||||||
|
* To setup user account(s) edit `/config/config.json`
|
||||||
To setup user account(s)
|
* Change the value `public: true,` to `public: false,`
|
||||||
|
* restart the container and enter the following from the command line of the host:
|
||||||
+ edit /config/config.json changing 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.
|
||||||
+ `docker exec -it thelounge thelounge add <user>`
|
* You should now be prompted for a password on the webinterface.
|
||||||
|
|
||||||
+ Enter a password when prompted, refresh your browser.
|
|
||||||
|
|
||||||
+ You should now be prompted for a password on the webinterface.
|
|
||||||
|
|
||||||
|
|
||||||
|
## Support Info
|
||||||
|
|
||||||
## Info
|
* Shell access whilst the container is running:
|
||||||
|
* `docker exec -it thelounge /bin/bash`
|
||||||
* Shell access whilst the container is running: `docker exec -it thelounge /bin/bash`
|
* To monitor the logs of the container in realtime:
|
||||||
* To monitor the logs of the container in realtime: `docker logs -f thelounge`
|
* `docker logs -f thelounge`
|
||||||
|
* Container version number
|
||||||
* container version number
|
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' thelounge`
|
||||||
|
* Image version number
|
||||||
`docker inspect -f '{{ index .Config.Labels "build_version" }}' thelounge`
|
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/thelounge`
|
||||||
|
|
||||||
* image version number
|
|
||||||
|
|
||||||
`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/thelounge`
|
|
||||||
|
|
||||||
|
|
||||||
## Versions
|
## Versions
|
||||||
|
|
||||||
+ **28.01.19:** Add pipeline logic and multi arch.
|
* **28.01.19:** - Add pipeline logic and multi arch.
|
||||||
+ **25.08.18:** Use global install, simplifies adding users.
|
* **25.08.18:** - Use global install, simplifies adding users.
|
||||||
+ **20.08.18:** Rebase to alpine 3.8.
|
* **20.08.18:** - Rebase to alpine 3.8.
|
||||||
+ **06.01.18:** Rebase to alpine 3.7.
|
* **06.01.18:** - Rebase to alpine 3.7.
|
||||||
+ **26.05.17:** Rebase to alpine 3.6.
|
* **26.05.17:** - Rebase to alpine 3.6.
|
||||||
+ **06.02.17:** Rebase to alpine 3.5.
|
* **06.02.17:** - Rebase to alpine 3.5.
|
||||||
+ **14.10.16:** Bump to pickup 2.10 release.
|
* **14.10.16:** - Bump to pickup 2.10 release.
|
||||||
+ **14.10.16:** Add version layer information.
|
* **14.10.16:** - Add version layer information.
|
||||||
+ **11.09.16:** Add layer badges to README.
|
* **11.09.16:** - Add layer badges to README.
|
||||||
+ **31.08.16:** Initial Release.
|
* **31.08.16:** - Initial Release.
|
||||||
|
|
|
||||||
Ładowanie…
Reference in New Issue