Skip to content
Snippets Groups Projects
Griefed's avatar
Griefed authored
d490178b
History

docker-D-Zone

Homepage Blog FleetGitHub DockerHub


docker-D-Zone

Docker Pulls Docker Image Size (latest by date) Docker Cloud Build Status Docker Cloud Automated build GitHub Repo stars GitHub forks

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.

d-zone


Creates a Container which runs d-zone-org's d-zone, with lsiobase/alpine as the base image, as seen on https://pixelatomy.com/dzone/?s=default.

The lsiobase/alpine image is a custom base image built with Alpine linux and 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

Tags Description
port Use tag port if accessing d-zone via IP:PORT
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

Using docker-compose:

version: "2"
services:
  d-zone:
    image: griefed/d-zone:latest
    container_name: d-zone
    restart: unless-stopped
    environment:
      - TZ=Europe/Berlin # Timezone
      - TOKEN=YOUR_DISCORD_BOT_TOKEN # Needed for D-Zone to create the simulation. See https://discordapp.com/developers/applications/me
      - PUID=1000 # User ID
      - PGID=1000 # Group ID
    volumes:
      - /host/path/to/config:/config # Contains all application data and base-image config files
    ports:
      - 3000:3000/tcp # Website

Using CLI:

docker create \
  --name=d-zone \
  -e TZ=Europe/Berlin \
  -e TOKEN=YOUR_DISCORD_BOT_TOKEN \
  -e PUID=1000 \
  -e PGID=1000 \
  -v /host/path/to/config:/config \
  -p 3000:3000 \
  --restart unless-stopped \
  griefed/d-zone:latest

Raspberry Pi

To run this container on a Raspberry Pi, use the arm-prefix for the port- and proxy-tags. I've tested the port-tag on a Raspberry Pi 3B.

griefed/d-zone:port-arm griefed/d-zone:proxy-arm

Configuration

Configuration Explanation
Restart policy "no", always, on-failure, unless-stopped
config volume Contains config files and logs.
data volume Contains your/the containers important data.
TZ Timezone
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 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:

  $ id username
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

Building the image yourself

Use the Dockerfile to build the image yourself, in case you want to make any changes to it

docker-compose.yml:

version: '3.6'
services:
  d-zone:
    build: ./docker-D-Zone/
    container_name: d-zone
    restart: unless-stopped
    environment:
      - TZ=Europe/Berlin # Timezone
      - TOKEN=YOUR_DISCORD_BOT_TOKEN # Needed for D-Zone to create the simulation. See https://discordapp.com/developers/applications/me
      - PUID=1000 # User ID
      - PGID=1000 # Group ID
    volumes:
      - /host/path/to/config:/config # Contains all application data and base-image config files
    ports:
      - 3000:3000/tcp # Website
  1. Clone the repository: git clone https://github.com/Griefed/docker-D-Zone.git ./docker-D-Zone
  2. Rename Dockerfile.port to Dockerfile: mv Dockerfile.port Dockerfile
  3. Prepare docker-compose.yml file as seen above
  4. docker-compose up -d --build d-zone
  5. Visit IP.ADDRESS.OF.HOST:8080
  6. ???
  7. Profit!

App Information

Specify channels to ignore:

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.jsonfile in the folder you specified in your volumes:. Edit the "servers" block on a per server basis, e.g.:

  "servers": [
    {
      "id": "<YOUR_SERVER_ID_HERE",
      "default": true,
      "ignoreChannels": ["TEXTCHANNEL_ID1","TEXTCHANNEL_ID2","TEXTCHANNEL_ID3"]
    }
  ]

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

If you want to serve d-zone with a reverse proxy like nginx and HTTPS, then this may be of help to you:

version: "2"
services:
  d-zone:
    image: griefed/d-zone:latest
    container_name: d-zone
    restart: unless-stopped
    environment:
      - TZ=Europe/Berlin # Timezone
      - TOKEN=YOUR_DISCORD_BOT_TOKEN # Needed for D-Zone to create the simulation. See https://discordapp.com/developers/applications/me
      - PUID=1000 # User ID
      - PGID=1000 # Group ID
    volumes:
      - /host/path/to/config:/config # Contains all application data and base-image config files

I use a dockerized NGINX as a reverse proxy, specifically linuxserver/swag.

server {
    listen 443 ssl;
    listen [::]:443 ssl;

    server_name SUBDOMAIN.*;

    include /config/nginx/ssl.conf;

    client_max_body_size 0;

    # enable for ldap auth, fill in ldap details in ldap.conf
    #include /config/nginx/ldap.conf;

    # enable for Authelia
    #include /config/nginx/authelia-server.conf;

    location / {
        # enable the next two lines for http auth
        #auth_basic "Restricted";
        #auth_basic_user_file /config/nginx/.htpasswd;

        # enable the next two lines for ldap auth
        #auth_request /auth;
        #error_page 401 =200 /ldaplogin;

        # enable for Authelia
        #include /config/nginx/authelia-location.conf;

        include /config/nginx/proxy.conf;
        resolver 127.0.0.11 valid=30s;

        proxy_set_header HOST $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_pass_request_headers on;
        set $upstream_app d-zone;
        set $upstream_port 3000;
        set $upstream_proto http;
        proxy_pass $upstream_proto://$upstream_app:$upstream_port;
        #proxy_http_version 1.0;
        #proxy_set_header Upgrade $http_upgrade;
        #proxy_set_header Connection "Upgrade";

    }
}