]> jfr.im git - irc/UndernetIRC/undernet-development-env.git/commitdiff
WIP: README
authorStefan Wold <redacted>
Sun, 11 Dec 2022 13:24:14 +0000 (14:24 +0100)
committerStefan Wold <redacted>
Sun, 11 Dec 2022 13:24:14 +0000 (14:24 +0100)
README.md [new file with mode: 0644]

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..74bf668
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+UnderNET Development Environment
+================================
+
+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
+
+
+# Requirements to setup the environment
+
+- docker
+- docker-compose
+
+
+# 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 
+   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.
\ No newline at end of file