lsiocommunity/shout-irc repository overview

undefined

The LinuxServer.io⁠ team brings you another container release featuring :-

• regular and timely application updates
• easy user mappings (PGID, PUID)
• custom base image with s6 overlay
• weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
• regular security updates

Find us at:

• Discord⁠ - realtime support / chat with the community and the team.
• IRC⁠ - on freenode at #linuxserver.io. Our primary support channel is Discord.
• Blog⁠ - all the things you can do with our containers including How-To guides, opinions and much more!

⁠linuxserver/shout-irc⁠

THIS IMAGE IS DEPRECATED. PLEASE MIGRATE TO THELOUNGE linuxserver/thelounge Shout-irc⁠ 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⁠ and our announcement here⁠.

Simply pulling linuxserver/shout-irc 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:

⁠Usage

Here are some example snippets to help you get started creating a container.

⁠docker

docker create \
  --name=shout-irc \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Europe/London \
  -p 9000:9000 \
  -v /path/to/appdata/config:/config \
  --restart unless-stopped \
  linuxserver/shout-irc

⁠docker-compose

Compatible with docker-compose v2 schemas.

---
version: "2"
services:
  shout-irc:
    image: linuxserver/shout-irc
    container_name: shout-irc
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Europe/London
    volumes:
      - /path/to/appdata/config:/config
    ports:
      - 9000:9000
    restart: unless-stopped

⁠Parameters

Container 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.

⁠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

• To log in to the application, browse to https://hostip: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.

⁠Support Info

• Shell access whilst the container is running: docker exec -it shout-irc /bin/bash
• To monitor the logs of the container in realtime: docker logs -f shout-irc
• container version number
  • docker inspect -f '{{ index .Config.Labels "build_version" }}' shout-irc
• image version number
  • docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/shout-irc

⁠Updating Info

Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), we do not recommend or support updating apps inside the container. Please consult the Application Setup⁠ section above to see if it is recommended for the image.

Below are the instructions for updating containers:

⁠Via Docker Run/Create

• Update the image: docker pull linuxserver/shout-irc
• Stop the running container: docker stop shout-irc
• Delete the container: docker rm shout-irc
• Recreate a new container with the same docker create parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)
• Start the new container: docker start shout-irc
• You can also remove the old dangling images: docker image prune

⁠Via Docker Compose

• Update all images: docker-compose pull
  • or update a single image: docker-compose pull shout-irc
• Let compose update all containers as necessary: docker-compose up -d
  • or update a single container: docker-compose up -d shout-irc
• You can also remove the old dangling images: docker image prune

⁠Via Watchtower auto-updater (especially useful if you don't remember the original parameters)

• Pull the latest image at its tag and replace it with the same env variables in one run:

  docker run --rm \
  -v /var/run/docker.sock:/var/run/docker.sock \
  containrrr/watchtower \
  --run-once shout-irc
  

  Copy
• You can also remove the old dangling images: docker image prune

⁠Building locally

If you want to make local modifications to these images for development purposes or just to customize the logic:

git clone https://github.com/linuxserver/docker-shout-irc.git
cd docker-shout-irc
docker build \
  --no-cache \
  --pull \
  -t linuxserver/shout-irc:latest .

The ARM variants can be built on x86_64 hardware using multiarch/qemu-user-static

docker run --rm --privileged multiarch/qemu-user-static:register --reset

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.

⁠Versions

• 11.06.19: - DEPRECATE IMAGE, USE THELOUNGE.
• 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: - Rebase to alpine 3.8.
• 13.12.17: - Rebase to alpine 3.7.
• 27.05.17: - Rebase to alpine 3.6.
• 09.02.17: - Rebase to alpine 3.5.
• 14.10.16: - Add version layer information.
• 31.08.16: - Rebase to alpine linux, move to lsiocommunity