Merge branch 'bonobonet:master' into master

docs/join.md

@@ -1,12 +0,0 @@
-Joining the network
-===================
-
-We welcome having more people join our IRC network by setting up new servers all around the
-world, connected over a diverse selection of networks.
-
-Follow the steps below to get linked in:
-
-1. [Additional rules](peering.md)
-2. [Configuring unrealircd](configuring.md)
-3. [Setting the motd](motd.md)
-3. [Linking your node](linking.md)

docs/network/config/daemon.md

@@ -35,7 +35,7 @@ include "<remote inclusion url>";
 
 ## Server information
 
-You will now personalise the settings of this server by setting the _name_ of your
+You will now personalize the settings of this server by setting the _name_ of your
 server to the one you chose in the e-mail. Along with this a custom **short** description
 of your server, followed by the `sid` you were sent in the e-mail.
 
@@ -65,7 +65,7 @@ admin
 ## Operator information
 
 Since this is _your_ server you will be able to configure an operator account that
-can only be used to gained priveleged control over _your_ server. You should set
+can only be used to gained privileged control over _your_ server. You should set
 the nickname for your operator user and put that in `<username>`. Also, set a strong
 password that will be used for gaining access to operator status.
 
@@ -136,7 +136,7 @@ listen
 
 There are some restraints we need to include some configuration to allow
 a certain server, namely `services.bnet`, to be able to have special rights
-aseeing as it provides IRC services to the whole network. We also add another
+seeing as it provides IRC services to the whole network. We also add another
 rules banning the use of nicknames that are used for services.
 
 ```
@@ -151,7 +151,7 @@ TODO: the above should be added into remote config?
 
 ## Server parametrs
 
-There are some parameters that are specific to your server whch are required to be set, these are shown below:
+There are some parameters that are specific to your server which are required to be set, these are shown below:
 
 ### k-line address
 
@@ -169,13 +169,9 @@ set
 
 ### Unchanging parameters
 
-The following needs to be set as is:
-
 The following settings should be set as is. They control the modes a user will have set in certain scenarios, what
 modes a channel will have when created also which channel operators (such as you) should join to.
 
-> **TODO**: Rany I suppose these should be in the common config actually?
-
 ```
 /* Modes and oper auto-join */
 set
@@ -219,18 +215,11 @@ set
     * If the user uses the command below the bound then it is considered spammy and they will be marked as spammy users
     * We recommend the default of `10s` (10 seconds)
 2. The `spamfilter` block includes some more in-depth parameters relating to spam
-    * TODO
+    * We normally don't change any of the settings here and leave them as is
-    * TODO
-    * TODO
-    * TODO
 
-1. What we can change
+### Restrictions
 
-Probably should be common maybe not sure
+One can configure the restriction of commands in a time-based manner using tje `restrict-commands` option as shown below.
-
-### Restrictions stuff
-
-TODO: Describe
 
 ```
 set
@@ -254,14 +243,11 @@ set
 }
 ```
 
-1. What we can change
+We normally leave these settings as is.
 
-Probably should be common maybe not sure
+### Connection throttling
 
-
+One can configure the throttling of connections with the `connthrottle` option as shown below.
-### COnn thrttoe stuff
-
-TODO: desribe
 
 ```
 set
@@ -283,9 +269,7 @@ set
 }
 ```
 
-1. what can we change
+We normally leave these settings as is.
-
-I don't know if this can be common config, there was a reason I kept it
 
 ### Maximum channels
 
@@ -351,4 +335,81 @@ The last thing you will place in your configuration file is an inclusion for a n
 ```
 /* Links */
 include "links.conf";
-```
+```
+
+## Network configuration
+
+This section configures the server's network information:
+
+```
+set
+{
+    network-name            "BonoboNET";
+    default-server          "rany.bnet";
+    services-server         "services.bnet";
+    sasl-server             "services.bnet";
+    stats-server            "stats.example.org";
+    help-channel            "#help";
+    hiddenhost-prefix       "cloaked";
+    prefix-quit             "Quit";
+}
+```
+
+There is nothing here which you should change.
+
+## Cloak keys
+
+The cloak keys are required to be the same on all server's participating in the BonoboNET IRC network:
+
+```
+set
+{
+    cloak-keys
+    {
+        "<key1>";
+        "<key2>";
+        "<key3>";
+    }
+}
+```
+
+1. You must fill in the keys `<key1>`, `<key2>` and `<key3>`
+    * You can get these keys once you have applied for a server link by following the [prior steps](/network/join)
+
+## Nickname restrictions
+
+Taking into account the fact that BonoboNET is an IRC network that uses IRC services there are some names which should not be available as nicknames for the average user as they are indicative of IRC services, this section places a restriction such that nobody can `/nick` as any of these.
+
+```
+/* Don't allow ChanServ to be used */
+ban nick
+{
+    mask "*C*h*a*n*S*e*r*v*";
+    reason "Reserved for Services";
+}
+
+/* Don't allow NickServ to be used */
+ban nick
+{
+    mask "*N*i*c*k*S*e*r*v*";
+    reason "Reserved for Services";
+}
+
+/* Don't allow HostServ to be used */
+ban nick
+{
+    mask "*H*o*s*t*S*e*r*v*";
+    reason "Reserved for Services";
+}
+
+/* Don't allow MemoServ to be used */
+ban nick
+{
+    mask "*M*e*m*o*S*e*r*v*";
+    reason "Reserved for Services";
+}
+```
+
+---
+
+You should next check out how one can setup monitoring of the node itself with [OpenBNET monitoring](../monitoring/)

docs/network/config/monitoring.md

@@ -0,0 +1,37 @@
+Monitoring
+==========
+
+You can setup monitoring of your node with OpenBNET which is our custom written monitoring software for thew `unrealircd` daemon.
+
+## Configuring JSON-RPC
+
+The way in which OpenBNET communicates with the `unrealircd` daemon  is via a JSON-RPC HTTP socket, however this is not enabled by default in unrealircd, therefore one must enable it by including this piece of configuration in a new file named `openbnet.conf`:
+
+```
+/* Load the JSON-RPC modules */
+include "rpc.modules.default.conf";
+
+/* Setup a block to listen for RPC calls */
+listen
+{
+    ip 127.0.0.1;
+    port 8001;
+    options { rpc; }
+}
+
+/* Set authentication details */
+rpc-user apiuser
+{
+    match { ip *; }
+    password "password";
+}
+```
+
+Once this file has been created you can place the following at the end of your `unrealircd.conf` file:
+
+```
+/* Support for OpenBNET NG */
+include "openbnet.conf";
+```
+
+Now save this file and reload your unrealircd daemon

docs/network/index.md

@@ -1,2 +0,0 @@
-Network
-=======

docs/network/join.md

@@ -0,0 +1,14 @@
+Joining the network
+===================
+
+We welcome having more people join our IRC network by setting up new servers all around the
+world, connected over a diverse selection of networks.
+
+Follow the steps below to get linked in:
+
+1. [Additional rules](../config/peering)
+2. [Credentials](../config/credentials)
+3. [Configuring unrealircd](../config/daemon)
+4. [Monitoring (optional)](../config/monitoring)
+5. [Setting the motd](../config/motd)
+6. [Linking your node](../config/linking)

docs/servers.md

@@ -5,13 +5,14 @@ Below is a list of servers you can use your IRC client to connect to in order to
 
 ## Clearnet
 
-List of clearnet-connected servers.
+List of clearnet-connected servers; all of these servers have IPv6 addresses but only some have IPv4 too; notably `rany.bnet.`
 
 | Node            | Address                    | Port            |
 |-----------------|----------------------------|-----------------|
 | reddawn648.bnet | reddawn648.irc.bnet.eu.org | 6667/6697 (TLS) |
 | worcester.bnet  | worcester.irc.bnet.eu.org  | 6667/6697 (TLS) |
 | ty3r0x.bnet     | ty3r0x.irc.bnet.eu.org     | 6667/6697 (TLS) |
+| rany.bnet       | rany.irc.bnet.eu.org       | 6667/6697 (TLS) |
 
 <!-- | reddawn648.bnet | 41.157.98.109 | 9006 | -->
 
@@ -36,6 +37,7 @@ List of servers available over the Yggdrasil network.
 | braveheart.bnet | 300:7232:2b0e:d6e9:216:3eff:fe3c:c82b  | 6667/6697 (TLS) |
 | reddawn648.bnet | 204:fb3e:d9e:9f20:7af1:27ab:6aed:df32  | 6667/6697 (TLS) |
 | ty3r0x.bnet     | 201:f742:6335:a85d:8378:9b21:1105:d0bf | 6667/6697 (TLS) |
+| rany.bnet       | 200:6f99:2afe:41fd:fc3b:b1f7:af9d:f3a0 | 6667/6697 (TLS) |
 
 ## Lokinet
 

mkdocs.yml

@@ -13,13 +13,14 @@ nav:
       - botty.md
   - blog.md
   - Network:
-      - join.md
+      - network/join.md
       - Configuration:
-          - peering.md
+          - network/config/peering.md
-          - credentials.md
+          - network/config/credentials.md
-          - daemon.md
+          - network/config/daemon.md
-          - motd.md
+          - network/config/monitoring.md
-          - linking.md
+          - network/config/motd.md
+          - network/config/linking.md
       - links.md
       - OpenBNET: openbnet.md
   - culture.md