Skip to content
Snippets Groups Projects
Commit 076029d1 authored by Benoit Lavenier's avatar Benoit Lavenier
Browse files

fix doc

parent 796e07b2
No related branches found
No related tags found
No related merge requests found
...@@ -118,8 +118,9 @@ ...@@ -118,8 +118,9 @@
<!-- distribution management --> <!-- distribution management -->
<projectId>${project.artifactId}</projectId> <projectId>${project.artifactId}</projectId>
<site.server>eis-public-reports</site.server> <site.server>eis-public-reports</site.server>
<distribution.site.host>doc.e-is.pro</distribution.site.host> <site.host>doc.e-is.pro</site.host>
<site.repository>scpexe://${distribution.site.host}/var/www/doc.e-is.pro/duniter4j</site.repository> <site.path>/var/www/doc.e-is.pro/duniter4j</site.path>
<site.repository>scpexe://${site.host}${site.path}</site.repository>
<release.server>eis-nexus-deploy</release.server> <release.server>eis-nexus-deploy</release.server>
<release.repository>http://nexus.e-is.pro/nexus/content/repositories/duniter4j-releases</release.repository> <release.repository>http://nexus.e-is.pro/nexus/content/repositories/duniter4j-releases</release.repository>
<snapshot.server>eis-nexus-deploy</snapshot.server> <snapshot.server>eis-nexus-deploy</snapshot.server>
......
...@@ -2,20 +2,49 @@ ...@@ -2,20 +2,49 @@
# Build from source # Build from source
## Get source and compile ## Get source and compile
### Install Java JDK
- Linux (Debian, Ubuntu):
```bash
sudo apt-get install openjdk-8-jdk
```
- Windows: download then unzip JDK (8 ou +) from [Oracle web site](http://oracle.com/java/index.html)
### Install LibSodium
Install required dependencies: - Linux : follow [this instructions](https://download.libsodium.org/doc/installation/index.html) (anglais).
- Install Java JDK (8 or more) * After install, check that the file `libsodium.so` exists inside directory `/usr/local/lib` or `/opt/local/lib`.
- Install [libsodium](http://doc.libsodium.org/installation/index.html) * If not exists, but at another location, please create a symbolic link under directory `/usr/local/lib` or `/opt/local/lib`.
* Linux: after [installation](http://doc.libsodium.org/installation/index.html), make sure the file 'libsodium.so' exists on: `/usr/local/lib` or `/opt/local/lib`. - Windows : Aucune instalation nécessaire (fichier `sodium.dll` déjà présent dans `duniter4j-core-shared/lib`);
If not, create a symbolic link.
* Windows: copy the file 'sodium.dll' into directory 'duniter4j-core/lib/' * Windows: copy the file 'sodium.dll' into directory 'duniter4j-core/lib/'
### Installer Apache Maven 3
Install [Apache Maven 3](http://maven.apache.org):
- Linux (Debian, Ubuntu):
```bash
sudo apt-get install maven
```
- Windows : [download here](http://maven.apache.org/download.cgi) (version 3.x) then install using [this instructions](http://maven.apache.org/install.html).
- Install [Maven 3](http://maven.apache.org/): `sudo apt-get install maven` - Install [Maven 3](http://maven.apache.org/): `sudo apt-get install maven`
### Get source the compile
- Get the source code, then compile using Maven: - Get the source code, then compile using Maven:
``` ```
......
...@@ -200,12 +200,14 @@ La compilation du projet utilise Maven, par la commande `mvn` (à ne pas confon ...@@ -200,12 +200,14 @@ La compilation du projet utilise Maven, par la commande `mvn` (à ne pas confon
#### Tout compiler #### Tout compiler
Executez la commande suivante pour compiler l'ensemble du projet : Executez la commande suivante pour compiler l'ensemble du projet :
```bash ```bash
mvn install mvn install
``` ```
Si tout c'est bien passé, vous devriez obtenir quelque chose qui ressemble à cela : Si tout c'est bien passé, vous devriez obtenir quelque chose qui ressemble à cela :
```bash ```bash
(...) (...)
[INFO] Building zip: /home/eis/git/duniter/duniter4j/duniter4j-es-assembly/target/duniter4j-es-0.3.5-SNAPSHOT-standalone.zip [INFO] Building zip: /home/eis/git/duniter/duniter4j/duniter4j-es-assembly/target/duniter4j-es-0.3.5-SNAPSHOT-standalone.zip
...@@ -243,6 +245,7 @@ Par la suite, vous pourrez **ignorer les tests unitaires**, de cette manière : ...@@ -243,6 +245,7 @@ Par la suite, vous pourrez **ignorer les tests unitaires**, de cette manière :
```bash ```bash
mvn install -DskipTests mvn install -DskipTests
``` ```
Cela permet une compilation plus rapide. Cela permet une compilation plus rapide.
### Lancer un noeud ElasticSearch ### Lancer un noeud ElasticSearch
...@@ -338,11 +341,21 @@ En utilisant un navigateur, vous allez requêter . ...@@ -338,11 +341,21 @@ En utilisant un navigateur, vous allez requêter .
- [GET-1] Visualisez un bloc quelconque (par exemple le premier #0): http://localhost:9200/g1-test/block/0 - [GET-1] Visualisez un bloc quelconque (par exemple le premier #0): http://localhost:9200/g1-test/block/0
Etudiez ensuite le format du résultat : Etudiez ensuite le format du résultat :
```json ```json
{"_index":"g1-test","_type":"block","_id":"0","_version":1,"found":true,"_source":{ {
... "_index":"g1-test",
"_type":"block",
"_id":"0",
"_version":1,
"found":true,
"_source": {
"number": 0,
"...": "..."
}
} }
``` ```
> Observez qu'ElasticSeach a ajouté des informations : `_index`, `_type`, etc. > Observez qu'ElasticSeach a ajouté des informations : `_index`, `_type`, etc.
- [GET-2] Pour éviter d'avoir les informations additionnelles, ajoutez `/_source` : http://localhost:9200/g1-test/block/0/_source - [GET-2] Pour éviter d'avoir les informations additionnelles, ajoutez `/_source` : http://localhost:9200/g1-test/block/0/_source
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment