diff --git a/user/jami-distributed-network.md b/user/jami-distributed-network.md index 01c12cbf83b75e6b5d7ec8c2bce5f820de9c118b..e27091e7961f30eb18aa6d9e8929c434d2482fe3 100644 --- a/user/jami-distributed-network.md +++ b/user/jami-distributed-network.md @@ -2,54 +2,46 @@ ## Connectivity -Jami relies on a distributed network, that brings multiple -advantages when compared to federated networks: +Jami relies on a distributed network, which brings multiple advantages when compared to federated networks: -- No point of failure, -- More resilient to censorship, -- Do not depend on anything other than its users, -- Trust amongst nodes is not necessary. +* No point of failure, +* More resilient to censorship, +* Do not depend on anything other than its users, +* Trust amongst nodes is not necessary.  -This network forms a Distributed Hash Table (DHT) +This forms a Distributed Hash Table (DHT) network. -The core problem of distributed communication systems is peer -connectivity, Jami achieves it through two elements: +The core problem of distributed communication systems is peer connectivity. +Jami achieves it through two elements: -- Encrypted announcements on DHT, -- Use of standard protocols for NAT hole punching. +* Encrypted announcements on the DHT network, +* Use of standard protocols for NAT hole punching. Jami is built on two distinct distributed networks: -- the OpenDHT kademlia network to provide distributed connectivity - establishment and message distribution, -- the JamiNS blockchain to provide distributed name registration. +* the OpenDHT kademlia network to provide distributed connectivity establishment and message distribution, +* the JamiNS blockchain to provide distributed name registration. ## The OpenDHT network -See -[<https://github.com/savoirfairelinux/opendht>](https://github.com/savoirfairelinux/opendht) -for more information about OpenDHT, which provides a distributed -key-value datastore for connectivity establishment (with ICE) and -message distribution in Jami. +```{seealso} +Visit the <https://github.com/savoirfairelinux/opendht> page for more information about OpenDHT. +OpenDHT provides a distributed key-value datastore for connectivity establishment (with ICE) and message distribution in Jami. +``` -An OpenDHT network can be joined by knowing about any node already -connected to the network. This node will then share its knowledge about -other nodes on the network. +An OpenDHT network can be joined by knowing about any node already connected to the network. +This node will then share its knowledge about other nodes on the network. -Jami clients use a persistent node cache to reconnect to the network -after a first session. A configurable, known, stable "bootstrap" node is -used for the first connection or if cached nodes don't answer. +Jami clients use a persistent node cache to reconnect to the network after a first session. +A configurable, known, stable "bootstrap" node is used for the first connection or if cached nodes don't answer. -Jami clients currently use bootstrap.jami.net:4222 as the default -(configurable) bootstrap node and network ID 0 (the default, public -OpenDHT network). +Jami clients currently use bootstrap.jami.net:4222 as the default (configurable) bootstrap node and network ID 0 (the default, public OpenDHT network). ### Contribute to the OpenDHT network -Every Jami account runs an OpenDHT node, contributing to the network and -allowing Jami to scale. +Every Jami account runs an OpenDHT node, contributing to the network and allowing Jami to scale. Jami users can have full independence by running their own stable OpenDHT node and configure it as a bootstrap node in Jami, while helping @@ -61,22 +53,23 @@ utility](https://github.com/savoirfairelinux/opendht/wiki/Running-a-node-with-dh included with OpenDHT. dhtnode doesn't persist any data and has a default in-memory storage limit of 8 MiB. -Stable community-run DHT nodes will be added to the default bootstrap +Stable community-run DHT nodes will be added to the default bootstrap server list at the request of their owner, as more bootstrap nodes means a more resilient, independent network. +```{note} +To add a community-run DHT node to the default bootstrap server list, please email <contact@jami.net>. +``` + ## The JamiNS blockchain -The JamiNS blockchain is experimental and its architecture is expected -to evolve. +The JamiNS blockchain is experimental and its architecture is expected to evolve. -Jami clients don't run blockchain nodes themselves but rather -communicate with a JamiNS server using HTTP for name registration and -query, with a REST API. This is because the resources needed to run a -blockchain node are too high for most end-users. +Jami clients don't run blockchain nodes themselves but rather communicate with a JamiNS server using HTTP for name registration and query, with a REST API. +This is because the resources needed to run a blockchain node are too high for most end-users. -The nameserver can be configured by-account in Jami, allowing to connect -Jami clients to various more or less centralized user directories. +The name server is set at the account level. +This enables the Jami client to connect simultaneously to multiple user directories. ### Contribute to the JamiNS blockchain @@ -87,15 +80,14 @@ node and HTTP service, mine some Ether, and use it to pay the transaction fee needed to register their username in Jami. Code of the Ethereum contract, the blockchain genesis file, and the -NodeJS module (HTTP server) can be found here : -[1](https://git.jami.net/savoirfairelinux/jami-nameservice) +NodeJS module (HTTP server) can be found [here](https://git.jami.net/savoirfairelinux/jami-nameservice). ### Running a Jami Node -#### Pre-requisites: +#### Prerequisites -1. Geth 1.8.23+ (download from [HERE](https://geth.ethereum.org/downloads/)) -2. Jami genesis file (download from [HERE](https://git.jami.net/savoirfairelinux/jami-nameservice/blob/master/instructions/genesis.json)) +1. Geth 1.8.23+ (download from [here](https://geth.ethereum.org/downloads/)) +2. Jami genesis file (download from [here](https://git.jami.net/savoirfairelinux/jami-nameservice/blob/master/instructions/genesis.json)) #### Joining the Jami Network @@ -104,9 +96,9 @@ The process of joining the Jami network is similar to the process of joining a r 1. Download the Jami genesis file from the Jami github repo 2. Create a directory on your computer which you will use to store the Jami blockchain data - * Example for MacOS (/Users/username/jamichain) - * Example for Linux (/home/username/jamichain) - * Example for Windows (C:\Users\username\jamichain) + * Example for GNU/Linux (/home/username/jamichain) + * Example for macOS (/Users/username/jamichain) + * Example for Windows (C:\Users\username\jamichain) 3. Use geth to initialize the directory you created in (2) by running ```./geth --datadir /home/username/jamichain init genes is.json ``` 4. You can now start geth with the command-line options you need and specifying one of Jami's bootnodes as follows: