README.md

   1 UnderNET Development Environment
   2 ================================
   3 > **Warning**
   4 > Do NOT use this in production, it is not safe and contains publicly shared credentials!
   5
   6 This repository contain a docker based development environment for UnderNET.
   7
   8 It includes the following services:
   9
  10 - hub (ircu2)
  11 - leaf server (ircu2)
  12 - PostgreSQL database
  13 - mail server (mailhog)
  14 - cservice web portal
  15 - GNUworld (enabled modules: cservice, ccontrol, openchanfix, dronescan)
  16
  17
  18 # Requirements to setup the environment
  19
  20 - [Docker](https://www.docker.com/)
  21 - [docker-compose](https://docs.docker.com/compose/)
  22
  23
  24 # Getting started
  25
  26 This project uses git submodules. After cloning this repository the submodules needs to be
  27 initialized and updated. Follow this step-by-step guide to get your new UnderNET environment
  28 up and running.
  29
  30 ```
  31 git clone https://github.com/Ratler/undernet-development-env.git
  32 cd undernet-development-env
  33 git submodule init
  34 git submodule update
  35 docker-compose up -d
  36 ```
  37
  38 ## Service information (hosts, ports and login information)
  39
  40 The following ports below are mapped from your host to the container:
  41
  42 | Service      | URL / ip:port                                        | Comments                                                                                                                                                                    |
  43 |--------------|------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
  44 | hub          | Server: localhost:4400 <br> Client: localhost:6669   | The default `/oper` username is `admin` with the password `admin`                                                                                                           |
  45 | leaf         | Server: localhost:4401 <br> Client: localhost:6667   | The default `/oper` username is `admin` with the password `admin`                                                                                                           |
  46 | db           | localhost:5432                                       | The default db username is `cservice` with the password `cservice`, works for all the databases. <br> Databases: `cservice`, `ccontrol`, `chanfix`, `dronescan`, `local_db` |
  47  | mail         | SMTP: localhost:1025 <br> WEB: http://localhost:8025 | Captures e-mails from cservice-web, <br>e-mails can be accessed from the WEB url.                                                                                           |
  48  | cservice-web | http://localhost:8080                                | Default admin (level 1000) user is `Admin` with the password `temPass2020@`                                                                                                 |
  49
  50
  51 # Configuration
  52
  53 The configuration for the `hub`, `leaf` and `gnuworld` can be changed in the folder `etc/`.
  54 All the files are mounted inside the container as volumes, so any change done on your host
  55 is reflected in the container immediately. For example after changing `etc/hub.conf`, just
  56 `/rehash` the IRC server to apply the changes.
  57
  58 For the service `cservice-web` the configuration can be changed from `cservice-web/php_includes`. Any configuration
  59 or code change will be applied immediately.
  60
  61 # Making code changes in ircu or gnuworld
  62
  63 After making any code change in either ircu or gnuworld the container need to be rebuilt and restarted.
  64
  65 Rebuild ircu (hub and leaf share the same image):
  66 ```
  67 docker-compose build hub
  68 docker-compose restart hub
  69 docker-compose restart leaf
  70 ```
  71
  72 Rebuild and restart gnuworld:
  73 ```
  74 docker-compose build gnuworld
  75 docker-compose restart gnuworld
  76 ```
  77
  78 # PostgreSQL databases
  79
  80 ## Data persistence
  81
  82 All databases are persisted by using a docker volume. To list existing volumes  run `docker volume ls`.
  83 To reset all databases you can delete the volume by running `docker volume rm undernet-development-env_pgdata`,
  84 and then restart the `db` service to recreate all databases.
  85
  86
  87 # FAQ
  88 Q: Why do I see this message _"X (cservice@undernet.org): AUTHENTICATION FAILED as <user>
  89    (Unable to login during reconnection, please try again in 295 seconds)"_ when trying to
  90    authenticate with `x@channels.undernet.org`?
  91
  92 A: This is a burst connection mechanism in GNUworld which happen when it links to its hub.
  93    Just wait for it to complete and try again. Or you can change the setting `login_delay` in
  94    `etc/gnuworld/cservice.conf`, it's currently set to 5 seconds.
  95
  96 Q: Why am I getting _"X (cservice@undernet.org): AUTHENTICATION FAILED as Admin (IPR)"_ when I try to
  97    authenticate with the `x@channels.undernet.org` with the `Admin` user?
  98
  99 A: Access IP restrictions are applied to the Admin user, to fix this, login to the `cservice-web`, and
 100    change `Access IP restrictions (ACL+)` by adding the ip address `10.5.0.1`.