2023-06-19 03:11:43 +00:00
<!doctype html> < html lang = en class = no-js > < head > < meta charset = utf-8 > < meta name = viewport content = "width=device-width,initial-scale=1" > < meta name = description content = "Welcome to the home of the LinuxServer.io documentation!" > < meta name = author content = LinuxServer.io > < link href = https://docs.linuxserver.io/images/docker-shout-irc/ rel = canonical > < link href = ../docker-scrutiny/ rel = prev > < link href = ../docker-sickchill/ rel = next > < link rel = icon href = "https://gblobscdn.gitbook.com/spaces%2F-LWuIse8qFJj2MqDi90T%2Favatar-1590244439115.png?alt=media" > < meta name = generator content = "mkdocs-1.4.3, mkdocs-material-9.1.16" > < title > shout-irc - LinuxServer.io< / title > < link rel = stylesheet href = ../../assets/stylesheets/main.26e3688c.min.css > < link rel = stylesheet href = ../../assets/stylesheets/palette.ecc896b0.min.css > < link rel = preconnect href = https://fonts.gstatic.com crossorigin > < link rel = stylesheet href = "https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback" > < style > : root { --md-text-font : "Roboto" ; --md-code-font : "Roboto Mono" } < / style > < script > _ _md _scope = new URL ( "../.." , location ) , _ _md _hash = e => [ ... e ] . reduce ( ( e , _ ) => ( e << 5 ) - e + _ . charCodeAt ( 0 ) , 0 ) , _ _md _get = ( e , _ = localStorage , t = _ _md _scope ) => JSON . parse ( _ . getItem ( t . pathname + "." + e ) ) , _ _md _set = ( e , _ , t = localStorage , a = _ _md _scope ) => { try { t . setItem ( a . pathname + "." + e , JSON . stringify ( _ ) ) } catch ( e ) { } } < / script > < / head > < body dir = ltr data-md-color-scheme = default data-md-color-primary = purple data-md-color-accent = indigo > < script > var palette = _ _md _get ( "__palette" ) ; if ( palette && "object" == typeof palette . color ) for ( var key of Object . keys ( palette . color ) ) document . body . setAttribute ( "data-md-color-" + key , palette . color [ key ] ) < / script > < input class = md-toggle data-md-toggle = drawer type = checkbox id = __drawer autocomplete = off > < input class = md-toggle data-md-toggle = search type = checkbox id = __search autocomplete = off > < label class = md-overlay for = __drawer > < / label > < div data-md-component = skip > < a href = #deprecation-notice class = md-skip > Skip to content < / a > < / div > < div data-md-component = announce > < / div > < header class = "md-header md-header--shadow" data-md-component = header > < nav class = "md-header__inner md-grid" aria-label = Header > < a href = ../.. title = LinuxServer.io class = "md-header__button md-logo" aria-label = LinuxServer.io data-md-component = logo > < img src = "https://gblobscdn.gitbook.com/spaces%2F-LWuIse8qFJj2MqDi90T%2Favatar-1590244439115.png?alt=media" alt = logo > < / a > < label class = "md-header__button md-icon" for = __drawer > < svg xmlns = http://www.w3.org/2000/svg viewbox = "0 0 24 24" > < path d = "M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z" / > < / svg > < / label > < div class = md-header__title data-md-component = header-title > < div class = md-header__ellipsis > < div class = md-header__topic > < span class = md-ellipsis > LinuxServer.io < / span > < / div > < div class = md-header__topic data-md-component = header-topic > < span class = md-ellipsis > shout-irc < / span > < / div > < / div > < / div > < form class = md-header__option data-md-component = palette > < input class = md-option data-md-color-media = "(prefers-color-scheme: light)" data-md-color-scheme = default data-md-color-primary = purple data-md-color-accent = indigo aria-label = "Switch to dark mode" type = radio name = __palette id = __palette_1 > < label class = "md-header__button md-icon" title = "Switch to dark mode" for = __palette_2 hidden > < svg xmlns = http://www.w3.org/2000/svg viewbox = "0 0 24 24" > < path d = "M17 6H7c-3.31 0-6 2.69-6 6s2.69 6 6 6h10c3.31 0 6-2.69 6-6s-2.69-6-6-6zm0 10H7c-2.21 0-4-1.79-4-4s1.79-4 4-4h10c2.21 0 4 1.79 4 4s-1.79 4-4 4zM7 9c-1.66 0-3 1.34-3 3s1.34 3 3 3 3-1.34 3-3-1.34-3-3-3z" / > < / svg > < / label > < input class = md-option data-md-color-media = "(prefers-color-scheme: dark)" data-md-color-scheme = slate data-md-color-primary = purple data-md-color-accent = indigo aria-label = "Switch to light mode" type = radio name = __palette id = __palette_2 > < label class = "md-header__button md-icon" title = "Switch to light mode" for = __palette_1 hidden > < svg xmlns = http://www.w3.org/2000/svg viewbox = "0 0 24 24" > < path d = "M17 7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h10a5 5 0 0 0 5-5 5 5 0 0 0-5-5m0 8a3 3 0 0 1-3-3 3 3 0 0 1 3-3 3 3 0 0
2022-12-02 02:14:39 +00:00
--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
2023-01-08 13:57:31 +00:00
< / code > < / pre > < / div > < h3 id = docker-compose > docker-compose< / h3 > < p > Compatible with docker-compose v2 schemas.< / p > < div class = highlight > < pre > < span > < / span > < code > < span class = nn > ---< / span >
< span class = nt > version< / span > < span class = p > :< / span > < span class = w > < / span > < span class = s > " 2" < / span >
< span class = nt > services< / span > < span class = p > :< / span >
< span class = w > < / span > < span class = nt > shout-irc< / span > < span class = p > :< / span >
< span class = w > < / span > < span class = nt > image< / span > < span class = p > :< / span > < span class = w > < / span > < span class = "l l-Scalar l-Scalar-Plain" > linuxserver/shout-irc< / span >
< span class = w > < / span > < span class = nt > container_name< / span > < span class = p > :< / span > < span class = w > < / span > < span class = "l l-Scalar l-Scalar-Plain" > shout-irc< / span >
< span class = w > < / span > < span class = nt > environment< / span > < span class = p > :< / span >
< span class = w > < / span > < span class = "p p-Indicator" > -< / span > < span class = w > < / span > < span class = "l l-Scalar l-Scalar-Plain" > PUID=1000< / span >
< span class = w > < / span > < span class = "p p-Indicator" > -< / span > < span class = w > < / span > < span class = "l l-Scalar l-Scalar-Plain" > PGID=1000< / span >
< span class = w > < / span > < span class = "p p-Indicator" > -< / span > < span class = w > < / span > < span class = "l l-Scalar l-Scalar-Plain" > TZ=Europe/London< / span >
< span class = w > < / span > < span class = nt > volumes< / span > < span class = p > :< / span >
< span class = w > < / span > < span class = "p p-Indicator" > -< / span > < span class = w > < / span > < span class = "l l-Scalar l-Scalar-Plain" > < /path/to/appdata/config> :/config< / span >
< span class = w > < / span > < span class = nt > ports< / span > < span class = p > :< / span >
< span class = w > < / span > < span class = "p p-Indicator" > -< / span > < span class = w > < / span > < span class = "l l-Scalar l-Scalar-Plain" > 9000:9000< / span >
< span class = w > < / span > < span class = nt > restart< / span > < span class = p > :< / span > < span class = w > < / span > < span class = "l l-Scalar l-Scalar-Plain" > unless-stopped< / span >
< / code > < / pre > < / div > < h2 id = parameters > Parameters< / h2 > < p > Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate < code > < external> :< internal> < / code > respectively. For example, < code > -p 8080:80< / code > would expose port < code > 80< / code > from inside the container to be accessible from the host's IP on port < code > 8080< / code > outside the container.< / p > < h3 id = ports-p > Ports (< code > -p< / code > )< / h3 > < table > < thead > < tr > < th align = center > Parameter< / th > < th align = left > Function< / th > < / tr > < / thead > < tbody > < tr > < td align = center > < code > 9000< / code > < / td > < td align = left > Application WebUI< / td > < / tr > < / tbody > < / table > < h3 id = environment-variables-e > Environment Variables (< code > -e< / code > )< / h3 > < table > < thead > < tr > < th align = center > Env< / th > < th align = left > Function< / th > < / tr > < / thead > < tbody > < tr > < td align = center > < code > PUID=1000< / code > < / td > < td align = left > for UserID - see below for explanation< / td > < / tr > < tr > < td align = center > < code > PGID=1000< / code > < / td > < td align = left > for GroupID - see below for explanation< / td > < / tr > < tr > < td align = center > < code > TZ=Europe/London< / code > < / td > < td align = left > Specify a timezone to use EG Europe/London.< / td > < / tr > < / tbody > < / table > < h3 id = volume-mappings-v > Volume Mappings (< code > -v< / code > )< / h3 > < table > < thead > < tr > < th align = center > Volume< / th > < th align = left > Function< / th > < / tr > < / thead > < tbody > < tr > < td align = center > < code > /config< / code > < / td > < td align = left > Configuration files.< / td > < / tr > < / tbody > < / table > < h2 id = user-group-identifiers > User / Group Identifiers< / h2 > < p > When using volumes (< code > -v< / code > flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user < code > PUID< / code > and group < code > PGID< / code > .< / p > < p > Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.< / p > < p > In this instance < code > PUID=1000< / code > and < code > PGID=1000< / code > , to find yours use < code > id user< / code > as below:< / p > < div class = highlight > < pre > < span > < / span > < code > $ id username
2022-12-02 02:14:39 +00:00
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
2023-06-19 03:11:43 +00:00
< / code > < / pre > < / div > < h2 id = application-setup > Application Setup< / h2 > < ul > < li > To log in to the application, browse to https://:9000. < em > To setup user account(s) edit < code > /config/config.json< / code > < / em > Change the value < code > public: true,< / code > to < code > public: false,< / code > < em > restart the container and enter the following from the command line of the host:< / em > < code > docker exec -it thelounge thelounge add < user> < / code > < em > Enter a password when prompted, refresh your browser.< / em > You should now be prompted for a password on the webinterface. < / li > < / ul > < h2 id = support-info > Support Info< / h2 > < ul > < li > Shell access whilst the container is running: < / li > < li > < code > docker exec -it shout-irc /bin/bash< / code > < / li > < li > To monitor the logs of the container in realtime: < / li > < li > < code > docker logs -f shout-irc< / code > < / li > < li > Container version number < / li > < li > < code > docker inspect -f '{{ index .Config.Labels "build_version" }}' shout-irc< / code > < / li > < li > Image version number< / li > < li > < code > docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/shout-irc< / code > < / li > < / ul > < h2 id = versions > Versions< / h2 > < ul > < li > < strong > 11.06.19:< / strong > - DEPRECATE IMAGE, USE THELOUNGE.< / li > < li > < strong > 23.03.19:< / strong > - Switching to new Base images, shift to arm32v7 tag.< / li > < li > < strong > 22.02.19:< / strong > - Rebasing to alpine 3.9.< / li > < li > < strong > 28.01.19:< / strong > - Add pipeline logic and multi arch.< / li > < li > < strong > 25.08.18:< / strong > - Rebase to alpine 3.8.< / li > < li > < strong > 13.12.17:< / strong > - Rebase to alpine 3.7.< / li > < li > < strong > 27.05.17:< / strong > - Rebase to alpine 3.6.< / li > < li > < strong > 09.02.17:< / strong > - Rebase to alpine 3.5.< / li > < li > < strong > 14.10.16:< / strong > - Add version layer information.< / li > < li > < strong > 31.08.16:< / strong > - Rebase to alpine linux, move to lsiocommunity< / li > < / ul > < / article > < / div > < / div > < / main > < footer class = md-footer > < div class = "md-footer-meta md-typeset" > < div class = "md-footer-meta__inner md-grid" > < div class = md-copyright > < div class = md-copyright__highlight > Copyright © 2022 LinuxServer.io < / div > Made with < a href = https://squidfunk.github.io/mkdocs-material/ target = _blank rel = noopener > Material for MkDocs < / a > < / div > < div class = md-social > < a href = https://github.com/linuxserver target = _blank rel = noopener title = github.com class = md-social__link > < svg xmlns = http://www.w3.org/2000/svg viewbox = "0 0 448 512" > <!-- Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc. --> < path d = "M400 32H48C21.5 32 0 53.5 0 80v352c0 26.5 21.5 48 48 48h352c26.5 0 48-21.5 48-48V80c0-26.5-21.5-48-48-48zM277.3 415.7c-8.4 1.5-11.5-3.7-11.5-8 0-5.4.2-33 .2-55.3 0-15.6-5.2-25.5-11.3-30.7 37-4.1 76-9.2 76-73.1 0-18.2-6.5-27.3-17.1-39 1.7-4.3 7.4-22-1.7-45-13.9-4.3-45.7 17.9-45.7 17.9-13.2-3.7-27.5-5.6-41.6-5.6-14.1 0-28.4 1.9-41.6 5.6 0 0-31.8-22.2-45.7-17.9-9.1 22.9-3.5 40.6-1.7 45-10.6 11.7-15.6 20.8-15.6 39 0 63.6 37.3 69 74.3 73.1-4.8 4.3-9.1 11.7-10.6 22.3-9.5 4.3-33.8 11.7-48.3-13.9-9.1-15.8-25.5-17.1-25.5-17.1-16.2-.2-1.1 10.2-1.1 10.2 10.8 5 18.4 24.2 18.4 24.2 9.7 29.7 56.1 19.7 56.1 19.7 0 13.9.2 36.5.2 40.6 0 4.3-3 9.5-11.5 8-66-22.1-112.2-84.9-112.2-158.3 0-91.8 70.2-161.5 162-161.5S388 165.6 388 257.4c.1 73.4-44.7 136.3-110.7 158.3zm-98.1-61.1c-1.9.4-3.7-.4-3.9-1.7-.2-1.5 1.1-2.8 3-3.2 1.9-.2 3.7.6 3.9 1.9.3 1.3-1 2.6-3 3zm-9.5-.9c0 1.3-1.5 2.4-3.5 2.4-2.2.2-3.7-.9-3.7-2.4 0-1.3 1.5-2.4 3.5-2.4 1.9-.2 3.7.9 3.7 2.4zm-13.7-1.1c-.4 1.3-2.4 1.9-4.1 1.3-1.9-.4-3.2-1.9-2.8-3.2.4-1.3 2.4-1.9 4.1-1.5 2 .6 3.3 2.1 2.8 3.4zm-12.3-5.4c-.9 1.1-2.8.9-4.3-.6-1.5-1.3-1.9-3.2-.9-4.1.9-1.1 2.8-.9 4.3.6 1.3 1.3 1.8 3.3.9 4.1zm-9.1-9.1c-.9.6-2.6 0-3.7-1.5s-1.1-3.2 0-3.9c1.1-.9 2.8-.2 3.7 1.3 1.1 1.5 1.1 3.3 0 4.1zm-6.5-9.7c-.9.9-2.4.4-3.5-.6-1.1-1.3-1.3-2.8-.4-3.5.9-.9 2.4-.4 3.5.6 1.1 1.3 1.3 2.8.4 3.5zm-6.7-7.4c-.4.9-1.7 1.1-2.8.4-1.3-.6-1.9-1.7-1.5-2.6.4-.6 1.5-.9 2.8-.4 1.3.7 1.9 1.8 1.5 2.6z" / > < / svg > < / a > < a href = https://gitlab.com/linuxserver.io target = _b