[bisq-network/bisq-docs] Updating the "How to Seednode" docs (#148)

Steve Jain notifications at github.com
Mon Aug 5 17:25:32 UTC 2019


m52go commented on this pull request.

@freimair I suggested a number of small things as 'suggested edits' so you don't have to go back and do them yourself. Feel free to disregard/reject any you don't like.

Otherwise looks good to me overall.

>  
-A default seed node can be blocked by a network message in case the seed node does not fulfill the required quality.
+- find yourself a deputy in case you are not available (travel, holiday, others, ...). Usually, one of the developers is there to help. Just inform them on your setup and all is good.
+- keep the server up and running, including patching and hardening the operating system
+- keep the seed node software up to date
+- keep an eye on Bisq's communication channels for updates, issues, countermeasures,... (see <<Getting in Touch>>)

```suggestion
- keep an eye on Bisq's communication channels for updates, issues, countermeasures, etc (see <<Getting in Touch>>)
```

>  
-A default seed node can be blocked by a network message in case the seed node does not fulfill the required quality.
+- find yourself a deputy in case you are not available (travel, holiday, others, ...). Usually, one of the developers is there to help. Just inform them on your setup and all is good.
+- keep the server up and running, including patching and hardening the operating system
+- keep the seed node software up to date
+- keep an eye on Bisq's communication channels for updates, issues, countermeasures,... (see <<Getting in Touch>>)
+- keep an eye on the logs of the seed node and the operating system, and act if something shows up
+- if necessary, report and escalate (see <<Getting in Touch>>)
+- set up a bond of 20000 BSQ to get the privilege to run a seed node. In case of severe failure of service, the bond gets confiscated (burned).

```suggestion
- set up a bond of 20,000 BSQ to get the privilege to run a seed node. In case of severe failure of service, the bond gets confiscated (burned).
```
To make the number more readable.

>  
+Bisq uses Slack to communicate via chat. As a seed node operator, you are required to
+
+- subscribe to the Bisq Slack channel `bisq-seednode` and `bisq-monitor`
+- the `bisq-seednode` channel is the place where updates, issues, countermeasures, heads-ups, ... are discussed. If you encounter a problem with your seed node and cannot solve it by yourself, this is the place to report to (with a specific question, logs, ...). A developer will get back to you.

```suggestion
- the `bisq-seednode` channel is the place where updates, issues, countermeasures, heads-ups, etc are discussed. If you encounter a problem with your seed node and cannot solve it by yourself, this is the place to report to (with a specific question, logs, etc). A developer will get back to you.
```

> -. Min. 2 GB of RAM
-. 10 GB disk space (SSD)
-. 2 TB network traffic
-. UPS (uninterruptible power supply)
-. Uptime of > 99.9%
+- Min. 4 GB of RAM
+- 400 GB of disk space
+- 2 TB network traffic
+- Uptime of > 99.9%
+- > 10000 file handles available (check `ulimit -Sn`)
+
+And please try to stay away from cheap hosting providers! They tend to not care about QOS, the hardware is slow, they occasionally even turned a service off without warning - ask us how we know...
+
+## Get a seed node up and running
+
+You can run your seed node in many ways. The guide you are currently reading applies to a (debian-based) unix system with systemd available. Furthermore, we assume that only one seed node is operated per host. Please be aware that the guide is only a guide and not a step by step copy and paste how to, as we ignore for example the need for the occasional root access and file permissions, swap, general opsec, among other things. In case your host differs from our reference system, we are sure you can handle yourself.

```suggestion
You can run your seed node in many ways. The guide you are currently reading applies to a (debian-based) unix system with systemd available. Furthermore, we assume that only one seed node is operated per host. Please be aware that the guide is only a guide and not a step-by-step copy-and-paste how-to, as we ignore for example the need for the occasional root access and file permissions, swap, general opsec, among other things. In case your host differs from our reference system, we are sure you can handle yourself.
```

> +  systemctl enable bitcoind.service
+  systemctl start bitcoind.service
+
+and observe the logs
+
+  journalctl --unit bitcoind --follow
+
+and check if everything works as expected.
+
+=== Bisq Seed Node
+
+Start by getting OpenJDK 10 up and running.
+
+For getting the Bisq binaries, we recommend cloning the Bisq Git repository and compiling the code on your server. This way, you have precise control over what version you want to deploy. Furthermore, updating is very simple, just pull the changes, recompile and restart your service.
+
+Furthermore, we recommend creating a user `bisq` in group `bisq` for service hardening reasons and using the `bisq`-users home directory to:

```suggestion
Furthermore, we recommend creating a user `bisq` in group `bisq` for service hardening reasons and using the `bisq` user's home directory to:
```

(assuming this is the intended meaning)

>  
+Use `ON = bisq.network`, `OU = seednodes` and `CN = <your seed nodes onion address here (without the ".onion" part)>` for certificate creation. The onion address can be found in the `hostname`-file mentioned before.

```suggestion
Use `ON = bisq.network`, `OU = seednodes` and `CN = <your seed nodes onion address here (without the ".onion" part)>` for certificate creation. The onion address can be found in the `hostname` file mentioned before.
```

>  
-_Side note: The seed nodes on Linux get a out of memory error after running a few days. We still have not found the reason for it (see: link: https://github.com/bisq-network/exchange/issues/599[Github issue]) but as a quick fix we check the memory usage inside the application and if it is over a certain threshold the seed node restarts itself. This happens usually once a day and cause a connection loss for about 1 minute. If you have sufficient RAM you can increase that limit with --maxMemory=1024 to 1024 MB or more, default value for maxMemory is 500 MB._
+=== Payment

```suggestion
=== Compensation
```
The term 'compensation' clearer and more consistent with other docs, I think.

> @@ -4,108 +4,308 @@
 
 == Introduction

AsciiDoc automatically makes the first line into a subtitle of sorts, so I would suggest replacing lines 5-13 with the following. It includes minor edits in spacing, commas, etc (no material changes).
```
Bisq seed nodes serve as static gateways for Bisq clients to get connected to Bisq's dynamic P2P network.

In this doc, you will find information about:

- what a seed node is and how it works
- the duties of a seed node operator
- the benefits of being a seed node operator
- how to get a seed node up and running
- where to get in touch
```

-- 
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/bisq-network/bisq-docs/pull/148#pullrequestreview-270889050
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.bisq.network/pipermail/bisq-github/attachments/20190805/a5a063cf/attachment.html>


More information about the bisq-github mailing list