Przeglądaj źródła

book: split ircd local deployment into its own page

x 2 lat temu
rodzic
commit
7602b9edad
3 zmienionych plików z 100 dodań i 90 usunięć
  1. 1 0
      doc/src/SUMMARY.md
  2. 11 90
      doc/src/misc/ircd/ircd.md
  3. 88 0
      doc/src/misc/ircd/local_deploy.md

+ 1 - 0
doc/src/SUMMARY.md

@@ -16,6 +16,7 @@
 - [DAO](testnet/dao.md)
 - [DAO](testnet/dao.md)
 - [ircd](misc/ircd/ircd.md)
 - [ircd](misc/ircd/ircd.md)
 	- [Private Message](misc/ircd/private_message.md)
 	- [Private Message](misc/ircd/private_message.md)
+	- [Local Deployment](misc/ircd/local_deploy.md)
 
 
 # Developer Doc
 # Developer Doc
 
 

+ 11 - 90
doc/src/misc/ircd/ircd.md

@@ -128,95 +128,7 @@ configured to support a Tor or Nym connection, users can connect to
 Other approaches include connecting via a cloud server or VPN. Research 
 Other approaches include connecting via a cloud server or VPN. Research 
 the risks involved in these methods before connecting.
 the risks involved in these methods before connecting.
 
 
-## Usage (Local Deployment)
-
-These steps below are only for developers who wish to make a testing
-deployment. The previous sections are sufficient to join the chat.
-
-### Seed Node
-
-First you must run a seed node. The seed node is a static host which
-nodes can connect to when they first connect to the network. The
-`seed_session` simply connects to a seed node and runs `protocol_seed`,
-which requests a list of addresses from the seed node and disconnects
-straight after receiving them.
-
-The first time you run the program, a config file will be created in
-`~/.config/darkfi` if you are using Linux or in 
-`~/Library/Application Support/darkfi/` on MacOS. 
-You must specify an inbound accept address in your config file to configure a seed node:
-
-```toml
-## P2P accept addresses
-inbound=["127.0.0.1:11001"]
-```
-
-Note that the above config doesn't specify an external address since
-the seed node shouldn't be advertised in the list of connectable
-nodes. The seed node does not participate as a normal node in the
-p2p network. It simply allows new nodes to discover other nodes in
-the network during the bootstrapping phase.
-
-### Inbound Node
-
-This is a node accepting inbound connections on the network but which
-is not making any outbound connections.
-
-The external addresses are important and must be correct.
-
-To run an inbound node, your config file must contain the following
-info:
-		
-```toml
-## P2P accept addresses
-inbound=["127.0.0.1:11002"]
-
-## P2P external addresses
-external_addr=["127.0.0.1:11002"]
-
-## Seed nodes to connect to 
-seeds=["127.0.0.1:11001"]
-```
-### Outbound Node
-
-This is a node which has 8 outbound connection slots and no inbound
-connections.  This means the node has 8 slots which will actively
-search for unique nodes to connect to in the p2p network.
-
-In your config file:
-
-```toml
-## Connection slots
-outbound_connections=8
-
-## Seed nodes to connect to 
-seeds=["127.0.0.1:11001"]
-```
-
-### Attaching the IRC Frontend
-
-Assuming you have run the above 3 commands to create a small model
-testnet, and both inbound and outbound nodes above are connected,
-you can test them out using weechat.
-
-To create separate weechat instances, use the `--dir` command:
-
-    weechat --dir /tmp/a/
-    weechat --dir /tmp/b/
-
-Then in both clients, you must set the option to connect to temporary
-servers:
-
-    /set irc.look.temporary_servers on
-
-Finally you can attach to the local ircd instances:
-
-    /connect localhost/6667
-    /connect localhost/6668
-
-And send messages to yourself.
-
-### Running a Fullnode
+## Running a Fullnode
 
 
 See the script `script/run_node.sh` for an example of how to deploy
 See the script `script/run_node.sh` for an example of how to deploy
 a full node which does seed session synchronization, and accepts both
 a full node which does seed session synchronization, and accepts both
@@ -227,4 +139,13 @@ inbound and outbound connections.
 Copy [this script](https://github.com/narodnik/weechat-global-buffer/blob/main/buffclone.py) 
 Copy [this script](https://github.com/narodnik/weechat-global-buffer/blob/main/buffclone.py) 
 to `~/.weechat/python/autoload/`, and you will create a single buffer 
 to `~/.weechat/python/autoload/`, and you will create a single buffer 
 which aggregates messages from all channels. It's useful to monitor 
 which aggregates messages from all channels. It's useful to monitor 
-activity from all channels without needing to flick through them.
+activity from all channels without needing to look at each one individually.
+
+## Emojis
+
+Install the `noto` fonts to have the full unicode set. Popular Linux distros
+should have packages for them.
+
+Once installed you can view all the emojis in your terminal. Note, you may need
+to regenerate your font cache (or just restart) after installing them.
+

+ 88 - 0
doc/src/misc/ircd/local_deploy.md

@@ -0,0 +1,88 @@
+# Ircd Local Deployment
+
+These steps below are only for developers who wish to make a testing
+deployment. The previous sections are sufficient to join the chat.
+
+## Seed Node
+
+First you must run a seed node. The seed node is a static host which
+nodes can connect to when they first connect to the network. The
+`seed_session` simply connects to a seed node and runs `protocol_seed`,
+which requests a list of addresses from the seed node and disconnects
+straight after receiving them.
+
+The first time you run the program, a config file will be created in
+`~/.config/darkfi` if you are using Linux or in 
+`~/Library/Application Support/darkfi/` on MacOS. 
+You must specify an inbound accept address in your config file to configure a seed node:
+
+```toml
+## P2P accept addresses
+inbound=["127.0.0.1:11001"]
+```
+
+Note that the above config doesn't specify an external address since
+the seed node shouldn't be advertised in the list of connectable
+nodes. The seed node does not participate as a normal node in the
+p2p network. It simply allows new nodes to discover other nodes in
+the network during the bootstrapping phase.
+
+## Inbound Node
+
+This is a node accepting inbound connections on the network but which
+is not making any outbound connections.
+
+The external addresses are important and must be correct.
+
+To run an inbound node, your config file must contain the following
+info:
+		
+```toml
+## P2P accept addresses
+inbound=["127.0.0.1:11002"]
+
+## P2P external addresses
+external_addr=["127.0.0.1:11002"]
+
+## Seed nodes to connect to 
+seeds=["127.0.0.1:11001"]
+```
+## Outbound Node
+
+This is a node which has 8 outbound connection slots and no inbound
+connections.  This means the node has 8 slots which will actively
+search for unique nodes to connect to in the p2p network.
+
+In your config file:
+
+```toml
+## Connection slots
+outbound_connections=8
+
+## Seed nodes to connect to 
+seeds=["127.0.0.1:11001"]
+```
+
+## Attaching the IRC Frontend
+
+Assuming you have run the above 3 commands to create a small model
+testnet, and both inbound and outbound nodes above are connected,
+you can test them out using weechat.
+
+To create separate weechat instances, use the `--dir` command:
+
+    weechat --dir /tmp/a/
+    weechat --dir /tmp/b/
+
+Then in both clients, you must set the option to connect to temporary
+servers:
+
+    /set irc.look.temporary_servers on
+
+Finally you can attach to the local ircd instances:
+
+    /connect localhost/6667
+    /connect localhost/6668
+
+And send messages to yourself.
+