README.md

   1 UnderNET Development Environment
   2 ================================
   3
   4 This repository contain a docker based development environment for UnderNET.
   5
   6 It includes the following services:
   7
   8 - hub (ircu2)
   9 - leaf server (ircu2)
  10 - PostgreSQL database
  11 - mail server (mailhog)
  12 - cservice web portal
  13 - GNUworld
  14
  15
  16 # Requirements to setup the environment
  17
  18 - docker
  19 - docker-compose
  20
  21 # Getting started
  22
  23 This project uses git submodules. After cloning this repository the submodules needs to be
  24 initialized and updated. Follow this step-by-step guide to get your new UnderNET environment
  25 up and running.
  26
  27 ```
  28 git clone https://github.com/Ratler/undernet-development-env.git
  29 cd undernet-development.env
  30 git submodule init
  31 git submodule update
  32 docker-compose up
  33 ```
  34
  35 # FAQ
  36 Q: Why do I see this message _"X (cservice@undernet.org): AUTHENTICATION FAILED as <user>
  37    (Unable to login during reconnection, please try again in 295 seconds)"_ when trying to
  38    authenticate with `x@channels.undernet.org`?
  39
  40 A: This is a burst connection mechanism in GNUworld which happen when it links to its hub.
  41    Just wait for it to complete and try again.