@@ -22,7 +22,7 @@ Creates a Container which runs [$CREATOR_USERNAME's](https://github.com/$CREATOR
The [$BASE_IMAGE](https://hub.docker.com/r/$BASE_IMAGE) image is a custom base image built with [Alpine linux](https://alpinelinux.org/) and [S6 overlay](https://github.com/just-containers/s6-overlay).
Using this image allows us to use the same user/group ids in the container as on the host, making file transfers much easier
## Deployment
# Deployment
Tags | Description
-----|-------------
...
...
@@ -31,6 +31,8 @@ $DOCKERHUB_TAG_TWO | Use tag `$DOCKERHUB_TAG_TWO` if accessing $CREATOR_REPONAME
$DOCKERHUB_TAG_ONE-arm | Use tag `$DOCKERHUB_TAG_ONE-arm` if accessing $CREATOR_REPONAME via IP:PORT
$DOCKERHUB_TAG_TWO-arm | Use tag `$DOCKERHUB_TAG_TWO-arm` if accessing $CREATOR_REPONAME through a reverse proxy line NGINX
## Pre-built images
```docker-compose.yml
version: '3.6'
services:
...
...
@@ -57,7 +59,7 @@ To run this container on a Raspberry Pi, use the `arm`-prefix for the `$DOCKERHU
ports | The port where $DOCKERHUB_REPONAME will be available at. Only relevant when using `$DOCKERHUB_USERNAME/$DOCKERHUB_REPONAME:$DOCKERHUB_TAG_ONE`
## User / Group Identifiers
When using volumes, permissions issues can arise between the host OS and the container. [Linuxserver.io](https://www.linuxserver.io/) avoids 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:
D-Zone will, by default, listen to all channels on the servers which your bot is connected to.
If you want to set ignoreChannels, you need to edit your `discord-config.json`file in the folder you specified in your `volumes:`.
Edit the "servers" block on a per server basis, e.g.:
```json
"servers": [
{
...
...
@@ -95,6 +86,7 @@ Edit the "servers" block on a per server basis, e.g.:
}
]
```
If you want to define multiple servers, see https://github.com/d-zone-org/d-zone/blob/master/discord-config-example.json
## Running D-Zone behind a reverse proxy like NGINX
...
...
@@ -164,11 +156,24 @@ server {
}
```
### Building the image yourself
## User / Group Identifiers
When using volumes, permissions issues can arise between the host OS and the container. [Linuxserver.io](https://www.linuxserver.io/) avoids 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:
D-Zone is a graphical simulation meant to abstractly represent the activity in your Discord server. This is not meant for any actual monitoring or diagnostics, only an experiment in the abstraction of chatroom data represented via autonomous characters in a scene.
...
...
@@ -22,7 +22,7 @@ Creates a Container which runs [d-zone-org's](https://github.com/d-zone-org) [d-
The [lsiobase/alpine](https://hub.docker.com/r/lsiobase/alpine) image is a custom base image built with [Alpine linux](https://alpinelinux.org/) and [S6 overlay](https://github.com/just-containers/s6-overlay).
Using this image allows us to use the same user/group ids in the container as on the host, making file transfers much easier
## Deployment
# Deployment
Tags | Description
-----|-------------
...
...
@@ -31,6 +31,8 @@ proxy | Use tag `proxy` if accessing d-zone through a reverse proxy line NGINX
port-arm | Use tag `port-arm` if accessing d-zone via IP:PORT
proxy-arm | Use tag `proxy-arm` if accessing d-zone through a reverse proxy line NGINX
## Pre-built images
```docker-compose.yml
version: '3.6'
services:
...
...
@@ -47,7 +49,6 @@ services:
- PGID=1000 # Group ID
ports:
- 3000:3000
-
```
## Raspberry Pi
...
...
@@ -57,7 +58,7 @@ To run this container on a Raspberry Pi, use the `arm`-prefix for the `port`- an
`griefed/d-zone:port-arm`
`griefed/d-zone:proxy-arm`
## Configuration
# Configuration
Configuration | Explanation
------------ | -------------
...
...
@@ -69,23 +70,11 @@ PUID | for UserID
PGID | for GroupID
ports | The port where d-zone will be available at. Only relevant when using `griefed/d-zone:port`
## User / Group Identifiers
When using volumes, permissions issues can arise between the host OS and the container. [Linuxserver.io](https://www.linuxserver.io/) avoids 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:
D-Zone will, by default, listen to all channels on the servers which your bot is connected to.
If you want to set ignoreChannels, you need to edit your `discord-config.json`file in the folder you specified in your `volumes:`.
Edit the "servers" block on a per server basis, e.g.:
```json
"servers":[
{
...
...
@@ -95,6 +84,7 @@ Edit the "servers" block on a per server basis, e.g.:
}
]
```
If you want to define multiple servers, see https://github.com/d-zone-org/d-zone/blob/master/discord-config-example.json
## Running D-Zone behind a reverse proxy like NGINX
...
...
@@ -164,11 +154,24 @@ server {
}
```
### Building the image yourself
## User / Group Identifiers
When using volumes, permissions issues can arise between the host OS and the container. [Linuxserver.io](https://www.linuxserver.io/) avoids 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:
