diff --git a/images/docker-thelounge.md b/images/docker-thelounge.md index b9b0e4913..9ad1f4958 100755 --- a/images/docker-thelounge.md +++ b/images/docker-thelounge.md @@ -1,109 +1,143 @@ -[linuxserverurl]: https://linuxserver.io -[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/ +# [linuxserver/thelounge](https://github.com/linuxserver/docker-thelounge) -[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl] +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) +[![](https://images.microbadger.com/badges/version/linuxserver/thelounge.svg)](https://microbadger.com/images/linuxserver/thelounge "Get your own version badge on microbadger.com") +[![](https://images.microbadger.com/badges/image/linuxserver/thelounge.svg)](https://microbadger.com/images/linuxserver/thelounge "Get your own version badge on microbadger.com") +![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/thelounge.svg) +![Docker Stars](https://img.shields.io/docker/stars/linuxserver/thelounge.svg) +[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-thelounge/master)](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) -The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at: -* [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! +[Thelounge](https://thelounge.github.io/) (a fork of shoutIRC) is a web IRC client that you host on your own server. -# linuxserver/thelounge -[![](https://images.microbadger.com/badges/version/linuxserver/thelounge.svg)](https://microbadger.com/images/linuxserver/thelounge "Get your own version badge on microbadger.com")[![](https://images.microbadger.com/badges/image/linuxserver/thelounge.svg)](https://microbadger.com/images/linuxserver/thelounge "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/thelounge.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/linuxserver/thelounge.svg)][hub][![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Builders/x86-64/x86-64-thelounge)](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-thelounge/) +## Supported Architectures -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?__ -- Multiple user support -- Stays connected even when you close the browser -- Connect from multiple devices at once -- Responsive layout — works well on your smartphone -- _.. and more!_ +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 | arm32v6-latest | -[![theloungeirc](https://raw.githubusercontent.com/thelounge/thelounge/master/client/img/logo-vertical-transparent-bg.svg?sanitize=true)][appurl] ## Usage +Here are some example snippets to help you get started creating a container from this image. + +### docker + ``` docker create \ --name=thelounge \ - -v :/config \ - -e PGID= -e PUID= \ - -e TZ= \ + -e PUID=1001 \ + -e PGID=1001 \ + -e TZ=Europe/London \ -p 9000:9000 \ + -v :/config \ + --restart unless-stopped \ 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: + - :/config + ports: + - 9000:9000 + mem_limit: 4096m + restart: unless-stopped +``` + ## 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. -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 -http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.` +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. + +### Ports (`-p`) + +| Parameter | Function | +| :----: | --- | +| `9000` | Application WebUI | -* `-p 9000` - the port(s) -* `-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 +### Environment Variables (`-e`) -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 + $ id username uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup) ``` -## Setting up the application +## Application Setup -To log in to the application, browse to https://:9000. - -To setup user account(s) - -+ 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 ` - -+ Enter a password when prompted, refresh your browser. - -+ You should now be prompted for a password on the webinterface. + * 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 ` +* 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` -* 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` - +* 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 -+ **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. +* **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.