Warning
Do NOT use this in production, it is not safe and contains publicly shared credentials!
This repository contain a docker based development environment for UnderNET.
It includes the following services:
- hub (ircu2)
- leaf server (ircu2)
- PostgreSQL database
- mail server (mailhog)
- cservice web portal
- GNUworld (enabled modules: cservice, ccontrol, openchanfix, dronescan)
This project uses git submodules. After cloning this repository the submodules needs to be initialized and updated. Follow this step-by-step guide to get your new UnderNET environment up and running.
git clone https://github.com/Ratler/undernet-development-env.git
cd undernet-development-env
git submodule init
git submodule update
docker-compose up -d
The following ports below are mapped from your host to the container:
| Service | URL / ip:port | Comments |
|---|---|---|
| hub | Server: localhost:4400 Client: localhost:6669 |
The default /oper username is admin with the password admin |
| leaf | Server: localhost:4401 Client: localhost:6667 |
The default /oper username is admin with the password admin |
| db | localhost:5432 | The default db username is cservice with the password cservice, works for all the databases. Databases: cservice, ccontrol, chanfix, dronescan, local_db |
| SMTP: localhost:1025 WEB: http://localhost:8025 |
Captures e-mails from cservice-web, e-mails can be accessed from the WEB url. |
|
| cservice-web | http://localhost:8080 | Default admin (level 1000) user is Admin with the password temPass2020@ |
The configuration for the hub, leaf and gnuworld can be changed in the folder etc/.
All the files are mounted inside the container as volumes, so any change done on your host
is reflected in the container immediately. For example after changing etc/hub.conf, just
/rehash the IRC server to apply the changes.
For the service cservice-web the configuration can be changed from cservice-web/php_includes. Any configuration
or code change will be applied immediately.
After making any code change in either ircu or gnuworld the container need to be rebuilt and restarted.
Rebuild ircu (hub and leaf share the same image):
docker-compose up --build hub
docker-compose up leaf
Rebuild and restart gnuworld:
docker-compose up --build gnuworld
All databases are persisted by using a docker volume. To list existing volumes run docker volume ls.
To reset all databases you can delete the volume by running docker volume rm undernet-development-env_pgdata,
and then restart the db service to recreate all databases.
Q: Why do I see this message "X (cservice@undernet.org): AUTHENTICATION FAILED as
(Unable to login during reconnection, please try again in 295 seconds)" when trying to
authenticate with x@channels.undernet.org?
A: This is a burst connection mechanism in GNUworld which happen when it links to its hub.
Just wait for it to complete and try again. Or you can change the setting login_delay in
etc/gnuworld/cservice.conf, it's currently set to 5 seconds.
Q: Why am I getting "X (cservice@undernet.org): AUTHENTICATION FAILED as Admin (IPR)" when I try to
authenticate with the x@channels.undernet.org with the Admin user?
A: Access IP restrictions are applied to the Admin user, to fix this, login to the cservice-web, and
change Access IP restrictions (ACL+) by adding the ip address 10.5.0.1.