]> jfr.im git - irc/UndernetIRC/undernet-development-env.git/blobdiff - README.md
chore: update cservice-web submodule
[irc/UndernetIRC/undernet-development-env.git] / README.md
index f2ee471301586a0dc2ce6d47d2d2b3b22b385a7a..6ff4c3dc9859d272ba569683c05d21f4071f3403 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,5 +1,8 @@
 UnderNET Development Environment
 ================================
+> **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.
 
@@ -62,17 +65,23 @@ After making any code change in either ircu or gnuworld the container need to be
 
 Rebuild ircu (hub and leaf share the same image):
 ```
-docker-compose build hub
-docker-compose restart hub
-docker-compose restart leaf
+docker-compose up --build hub
+docker-compose up leaf
 ```
 
 Rebuild and restart gnuworld:
 ```
-docker-compose build gnuworld
-docker-compose restart gnuworld
+docker-compose up --build gnuworld
 ```
 
+# PostgreSQL databases
+
+## Data persistence
+
+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.
+
 
 # FAQ
 Q: Why do I see this message _"X (cservice@undernet.org): AUTHENTICATION FAILED as <user> 
@@ -80,4 +89,11 @@ Q: Why do I see this message _"X (cservice@undernet.org): AUTHENTICATION FAILED
    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
+   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`.
\ No newline at end of file