mirror
/
docker-documentation
kopia lustrzana https://github.com/linuxserver/docker-documentation
1
0
Forkuj 0
Kod Zgłoszenia Packages Projekty Wydania Wiki Aktywność

Bot Updating Templated Files

LICENSE
LinuxServer-CI 2019-02-12 14:42:14 +00:00
rodzic 2ab6f91230
commit 56c6bb7071
1 zmienionych plików z 100 dodań i 70 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

170
images/docker-shout-irc.md
Wyświetl plik

@ -1,104 +1,134 @@
[linuxserverurl]: https://linuxserver.io # [linuxserver/shout-irc](https://github.com/linuxserver/docker-shout-irc)
[forumurl]: https://forum.linuxserver.io
[ircurl]: https://www.linuxserver.io/irc/
[podcasturl]: https://www.linuxserver.io/podcast/
[appurl]: http://shout-irc.com/
[hub]: https://hub.docker.com/r/lsiocommunity/shout-irc/
[![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/shout-irc.svg)](https://microbadger.com/images/linuxserver/shout-irc "Get your own version badge on microbadger.com")
[![](https://images.microbadger.com/badges/image/linuxserver/shout-irc.svg)](https://microbadger.com/images/linuxserver/shout-irc "Get your own version badge on microbadger.com")
![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/shout-irc.svg)
![Docker Stars](https://img.shields.io/docker/stars/linuxserver/shout-irc.svg)
[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-shout-irc/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-shout-irc/job/master/)
[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/shout-irc/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/shout-irc/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: [Shout-irc](http://shout-irc.com/) 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!
# lsiocommunity/shout-irc ## Supported Architectures
[![](https://images.microbadger.com/badges/version/lsiocommunity/shout-irc.svg)](https://microbadger.com/images/lsiocommunity/shout-irc "Get your own version badge on microbadger.com")[![](https://images.microbadger.com/badges/image/lsiocommunity/shout-irc.svg)](http://microbadger.com/images/lsiocommunity/shout-irc "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/lsiocommunity/shout-irc.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/lsiocommunity/shout-irc.svg)][hub][![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Builders/lsiocommunity/x86-64-shout-irc)](https://ci.linuxserver.io/job/Docker-Builders/job/lsiocommunity/job/x86-64-shout-irc/)
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/shout-irc` 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 |
[![shoutirc](https://raw.githubusercontent.com/linuxserver/community-templates/master/lsiocommunity/img/shout-icon.png)][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=shout \ --name=shout-irc \
-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 \
lsiocommunity/shout-irc -v </path/to/appdata/config>:/config \
--restart unless-stopped \
linuxserver/shout-irc
```
### docker-compose
Compatible with docker-compose v2 schemas.
```yaml
---
version: "2"
services:
shout-irc:
image: linuxserver/shout-irc
container_name: shout-irc
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 shout /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` * 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.
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. ## Support Info
+ `docker exec -it shout shout --home /config add <user>`
+ Enter a password when prompted, refresh your browser.
+ You should now be prompted for a password on the webinterface.
## Info
* Shell access whilst the container is running: `docker exec -it shout /bin/bash`
* To monitor the logs of the container in realtime: `docker logs -f shout`
* container version number
`docker inspect -f '{{ index .Config.Labels "build_version" }}' shout`
* image version number
`docker inspect -f '{{ index .Config.Labels "build_version" }}' lsiocommnunity/shout`
* 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`
## Versions ## Versions
+ **28.01.19:** Add pipeline logic and multi arch. * **28.01.19:** - Add pipeline logic and multi arch.
+ **25.08.18:** Rebase to alpine 3.8. * **25.08.18:** - Rebase to alpine 3.8.
+ **13.12.17:** Rebase to alpine 3.7. * **13.12.17:** - Rebase to alpine 3.7.
+ **27.05.17:** Rebase to alpine 3.6. * **27.05.17:** - Rebase to alpine 3.6.
+ **09.02.17:** Rebase to alpine 3.5. * **09.02.17:** - Rebase to alpine 3.5.
+ **14.10.16:** Add version layer information. * **14.10.16:** - Add version layer information.
+ **31.08.16:** Rebase to alpine linux, move to lsiocommunity * **31.08.16:** - Rebase to alpine linux, move to lsiocommunity