diff --git a/doc/en/user/install-durs.md b/doc/en/user/install-durs.md new file mode 100644 index 0000000000000000000000000000000000000000..21c9f9a4d4f7c8e15976c998300583e37d302c98 --- /dev/null +++ b/doc/en/user/install-durs.md @@ -0,0 +1,75 @@ +# Installing DURS on your computer + +## Basic install + +In any case, you will have to: + +1. choose between server version or desktop version +2. which version number you want +3. select the release corresponding to your operating system and processor architecture + +### `durs-server` or `durs-desktop` + +`durs-desktop` comes with a graphic user interface and is made for people who want to install it in their desktop computer + +`durs-server` is much lighter but only has a terminal user interface. It's recommended for: + +* Installing on a remote server +* Installing on a low performance computer +* For users who are confortable with command line interfaces + +Note: it's possible to remotely control `durs-server` via a graphic user interface (see [durs remote admin]). + +## Choose the durs version to install + +<s>You can get the last stable version on [the official Durs website](durs.info)</s> + +If you have any question about which version to install, ask it on the [duniter forum](https://forum.duniter.org/). + +You will find all available version on [this gitlab page](https://git.duniter.org/nodes/rust/duniter-rs/tags) + +The 4 types of version are: + +* **alpha**: the most advanced test version, likely to have unstable behavior, suitable for alpha-testers +* **beta** : more usable test version, open to all testers +* **RC**: release candidate, a version that can be used in production by advanced users provided they check for updates in case of security issue +* **stable** : the more stable version, intended for all users + +### Choose the release correspondig to your operating system and processor architecture + +The `Category` column of the releases table tells you which system the release targets. (in case of GNU/Linux system, the distribution is in brackets) + +If no release has been made for you, fall back to the manual installation below. + +## Manual installation + +To install Durs manually, you must first [install Rust](https://www.rust-lang.org/tools/install). + +Then install Durs dependencies. Here is how to do on Debian based systems: + + apt-get install pkg-config libssl-dev # install required packages + git clone https://git.duniter.org/nodes/rust/duniter-rs.git # clone the Durs repository + +Change your current directory to the folder correspondig to the variant you want to build: + +* For `durs-server`, go into `bin/durs-server` + + cd bin/durs-server + +* For `durs-desktop`, go into `bin/durs-desktop` + + cd bin/durs-desktop + +Then build Durs with the command: + + cargo build --release --features ssl + +In case of problem with `openssl`, you can try building without the `ssl` feature: + + cargo build --release + +This just means that your node will not be able to contact the WS2P endpoints that are behind an SSL/TLS layer. +Your node should still work normally if there is enough unencrypted WS2P endpoints. + +If the build succeeds, your binary will lay in `duniter-rs/target/release` with the name `durs` or `durs-desktop`. +You can place it anywhere and run it without other requirement. diff --git a/doc/en/user/synchronise-durs-node.md b/doc/en/user/synchronise-durs-node.md new file mode 100644 index 0000000000000000000000000000000000000000..fc576013c287ceb58013b4bec14061c52bb1a4a8 --- /dev/null +++ b/doc/en/user/synchronise-durs-node.md @@ -0,0 +1,31 @@ +# Synchronise your Durs node + +## Synchronise from the network + +This feature is not yet available in Durs. + +## Synchronise from a local Duniter node + +Make sure you have a Duniter node (duniter-ts) syncronised on the same computer. + +If you run Durs with the same system user, you only need to use the `--type` option as follows: + + durs sync --type ts + +`ts` refers to the fact that Duniter is written in TypeScript. + +If you run Durs and Duniter with a different system user, you must tell Durs the path of the raw blockchain in JSON format. +It is usually located in `~/.config/duniter/<profile>/<currency>`. + +Example: + +for a GNU/Linux system, with a duniter user called `user`, the path is: + + home/user/.config/duniter/duniter-default/g1 + +append it to the end of the command like this: + + durs sync --type ts home/user/.config/duniter/duniter-default/g1 + +/!\ it is only necessary if you run Durs and Duniter with two different system users. +For the same user, Durs should find the blockchain path automatically.