Add simple motd examples

[irc/UndernetIRC/undernet-development-env.git] / README.md

diff --git a/README.md b/README.md
index 3c26f5fcda07492aa3eb40e8057d909bd66737ac..f2ee471301586a0dc2ce6d47d2d2b3b22b385a7a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -10,13 +10,14 @@ It includes the following services:
 - PostgreSQL database
 - mail server (mailhog)
 - cservice web portal
-- GNUworld
+- GNUworld (enabled modules: cservice, ccontrol, openchanfix, dronescan)
 
 
 # Requirements to setup the environment
 
-- docker
-- docker-compose
+- [Docker](https://www.docker.com/)
+- [docker-compose](https://docs.docker.com/compose/)
+
 
 # Getting started
 
@@ -26,12 +27,53 @@ up and running.
 
 ```
 git clone https://github.com/Ratler/undernet-development-env.git
-cd undernet-development.env
+cd undernet-development-env
 git submodule init
 git submodule update
-docker-compose up
+docker-compose up -d
 ```
 
+## Service information (hosts, ports and login information)
+
+The following ports below are mapped from your host to the container:
+
+| Service      | URL / ip:port                                        | Comments                                                                                                                                                                    |
+|--------------|------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| hub          | Server: localhost:4400 <br> Client: localhost:6669   | The default `/oper` username is `admin` with the password `admin`                                                                                                           |
+| leaf         | Server: localhost:4401 <br> 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. <br> Databases: `cservice`, `ccontrol`, `chanfix`, `dronescan`, `local_db` |
+ | 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.                                                                                           |
+ | cservice-web | http://localhost:8080                                | Default admin (level 1000) user is `Admin` with the password `temPass2020@`                                                                                                 |
+
+
+# Configuration
+
+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.
+
+# Making code changes in ircu or gnuworld
+
+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 build hub
+docker-compose restart hub
+docker-compose restart leaf
+```
+
+Rebuild and restart gnuworld:
+```
+docker-compose build gnuworld
+docker-compose restart gnuworld
+```
+
+
 # FAQ
 Q: Why do I see this message _"X (cservice@undernet.org): AUTHENTICATION FAILED as <user> 
    (Unable to login during reconnection, please try again in 295 seconds)"_ when trying to