kopia lustrzana https://github.com/linuxserver/docker-documentation
Bot Updating Templated Files
LinuxServer-CI
rodzic
7b5fb36219
commit
c6cf02f445
|
|
@ -1,6 +1,12 @@
|
|||
# linuxserver/shout-irc
|
||||
# [linuxserver/shout-irc](https://github.com/linuxserver/docker-shout-irc)
|
||||
|
||||
[](https://discord.gg/YWrKVTn) [](https://microbadger.com/images/linuxserver/shout-irc) [](https://microbadger.com/images/linuxserver/shout-irc)   [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-shout-irc/job/master/) [](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/shout-irc/latest/index.html)
|
||||
[](https://discord.gg/YWrKVTn)
|
||||
[](https://microbadger.com/images/linuxserver/shout-irc "Get your own version badge on microbadger.com")
|
||||
[](https://microbadger.com/images/linuxserver/shout-irc "Get your own version badge on microbadger.com")
|
||||
|
||||
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-shout-irc/job/master/)
|
||||
[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/shout-irc/latest/index.html)
|
||||
|
||||
[Shout-irc](http://shout-irc.com/) is a web IRC client that you host on your own server.
|
||||
|
||||
|
|
@ -13,18 +19,19 @@ Simply pulling `linuxserver/shout-irc` should retrieve the correct image for you
|
|||
The architectures supported by this image are:
|
||||
|
||||
| Architecture | Tag |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| x86-64 | amd64-latest |
|
||||
| arm64 | arm64v8-latest |
|
||||
| armhf | arm32v7-latest |
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
Here are some example snippets to help you get started creating a container from this image.
|
||||
|
||||
### docker
|
||||
|
||||
```text
|
||||
```
|
||||
docker create \
|
||||
--name=shout-irc \
|
||||
-e PUID=1000 \
|
||||
|
|
@ -36,6 +43,7 @@ docker create \
|
|||
linuxserver/shout-irc
|
||||
```
|
||||
|
||||
|
||||
### docker-compose
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
|
|
@ -60,44 +68,48 @@ services:
|
|||
|
||||
## Parameters
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
### Ports \(`-p`\)
|
||||
### Ports (`-p`)
|
||||
|
||||
| Parameter | Function |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `9000` | Application WebUI |
|
||||
|
||||
### Environment Variables \(`-e`\)
|
||||
|
||||
### Environment Variables (`-e`)
|
||||
|
||||
| Env | Function |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `PUID=1000` | for UserID - see below for explanation |
|
||||
| `PGID=1000` | for GroupID - see below for explanation |
|
||||
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
|
||||
|
||||
### Volume Mappings \(`-v`\)
|
||||
### Volume Mappings (`-v`)
|
||||
|
||||
| Volume | Function |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `/config` | Configuration files. |
|
||||
|
||||
|
||||
|
||||
## 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`.
|
||||
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:
|
||||
|
||||
```text
|
||||
```
|
||||
$ id username
|
||||
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
||||
```
|
||||
|
||||
## Application Setup
|
||||
|
||||
* 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 <user>` _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://<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
|
||||
|
||||
|
|
@ -121,4 +133,3 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel
|
|||
* **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
|
||||
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue