Installation guide

Contents:

Prerequisites
Install bundle (ElasticSearch and Gchange Pod)
Test your node
Update to latest version
Troubleshooting

Prerequisites

Install Java

Install Java JRE 8 or more.
- Windows: see Oracle web site
- Linux (Ubuntu):

sudo apt-get install openjdk-8-jre

Install libsodium

The Sodium crypto library (libsodium) is a modern, easy-to-use software library for encryption, decryption, signatures, password hashing and more.

Get libsodium (version 1.0.14 or newer)

wget -kL https://github.com/jedisct1/libsodium/releases/download/1.0.14/libsodium-1.0.14.tar.gz
tar -xvf libsodium-1.0.14.tar.gz

Installation:

cd libsodium-1.0.14
sudo apt-get install build-essential
sudo ./configure
sudo make && sudo make check
sudo make install

Install bundle (ElasticSearch and Gchange Pod)

Download lastest release of file gchange-pod-X.Y-standalone.zip

Unzip the archive:

unzip gchange-pod-X.Y-standalone.zip
cd gchange-pod-X.Y

Edit the configuration file config/elasticsearch.yml, in particular this properties:

# Your ES cluster name
cluster.name: gchange-pod-g1

# Your ES cluster public host name (optional - required for publishing peering document)
cluster.remote.host: gchange-pod.domain.com
cluster.remote.port: 443

# Use a descriptive name for the node:
node.name: ES-NODE-1

# Set the bind address to a specific IP (IPv4 or IPv6):
network.host: 127.0.0.1

# Set a custom port for HTTP:
http.port: 9200

# Duniter node to connect with
duniter.host: g1.duniter.org
duniter.port: 10900

# Initial list of hosts to perform synchronization
duniter.p2p.includes.endpoints: [
   "GCHANGE_API data.gchange.fr 443",
   "GCHANGE_SUBSCRIPTION_API data.gchange.fr 443"
]

Launch the Pod:

cd gchange-pod-X.Y/bin
./elasticsearch

Alternatively, to run as daemon:

./elasticsearch -d

You should see in console something like (example on the G1 currency):

$ ./elasticsearch
[2016-09-24 00:16:45,803][INFO ][node                     ] [ES-NODE-1] version[2.4.6], pid[15365], build[218bdf1/2016-05-17T15:40:04Z]
[2016-09-24 00:16:45,804][INFO ][node                     ] [ES-NODE-1] initializing ...
[2016-09-24 00:16:46,257][INFO ][plugins                  ] [ES-NODE-1] modules [reindex, lang-expression, lang-groovy], plugins [mapper-attachments, gchange-pod-g1], sites [gchange-pod-g1]
[2016-09-24 00:16:46,270][INFO ][env                      ] [ES-NODE-1] using [1] data paths, mounts [[/home (/dev/mapper/isw_defjaaicfj_Volume1p1)]], net usable_space [1tb], net total_space [1.7tb], spins? [possibly], types [ext4]
[2016-09-24 00:16:46,270][INFO ][env                      ] [ES-NODE-1] heap size [989.8mb], compressed ordinary object pointers [true]
[2016-09-24 00:16:47,757][INFO ][node                     ] [ES-NODE-1] initialized
[2016-09-24 00:16:47,757][INFO ][node                     ] [ES-NODE-1] starting ...
[2016-09-24 00:16:47,920][INFO ][transport                ] [ES-NODE-1] publish_address {127.0.0.1:9300}, bound_addresses {127.0.0.1:9300}
[2016-09-24 00:16:47,924][INFO ][discovery                ] [ES-NODE-1] gchange-pod-g1/jdzzh_jUTbuN26Enl-9whQ
[2016-09-24 00:16:50,982][INFO ][cluster.service          ] [ES-NODE-1] detected_master {SERVERNAME}{FD0IzkxETM6tyOqzrKuVYw}{192.168.0.28}{192.168.0.28:9300}, added {{SERVERNAME}{FD0IzkxETM6tyOqzrKuVYw}{192.168.0.28}{192.168.0.28:9300},}, reason: zen-disco-receive(from master [{SERVERNAME}{FD0IzkxETM6tyOqzrKuVYw}{192.168.0.28}{192.168.0.28:9300}])
[2016-09-24 00:16:53,570][INFO ][http                     ] [ES-NODE-1] publish_address {127.0.0.1:9200}, bound_addresses {127.0.0.1:9200}
[2016-09-24 00:16:53,570][INFO ][node                     ] [ES-NODE-1] started
[2016-09-24 00:16:57,850][INFO ][node                     ] Checking Duniter indices...
[2016-09-24 00:16:57,859][INFO ][node                     ] Checking Duniter indices... [OK]
[2016-09-24 00:17:08,026][INFO ][duniter.blockchain       ] [g1] [g1.duniter.org:10900] Indexing last blocks...
[2016-09-24 00:17:08,026][INFO ][duniter.blockchain       ] [g1] [g1.duniter.org:10900] Indexing block #999 / 41282 (2%)...
[2016-09-24 00:17:08,045][INFO ][duniter.blockchain       ] [g1] [g1.duniter.org:10900] Indexing block #1998 / 41282 (4%)...
[2016-09-24 00:17:09,026][INFO ][duniter.blockchain       ] [g1] [g1.duniter.org:10900] Indexing block #2997 / 41282 (6%)...
[2016-09-24 00:17:10,057][INFO ][duniter.blockchain       ] [g1] [g1.duniter.org:10900] Indexing block #3996 / 41282 (8%)...
...
[2016-09-24 00:17:11,026][INFO ][duniter.blockchain       ] [g1-gtest] [g1.duniter.org:10900] Indexing block #41282 - hash [00000AAD73B0E76B870E6779CD7ACCCE175802D7867C13B5C8ED077F380548C5]

Test your node

Using a web browser

The following web address should works: http://localhost:9200/node/summary

Using Gchange

You should also be able to use your Pod in the Gchange App:

Open settings, then advanced settings ;
Replace the Pod address (e.g. localhost:9200) ;
Check if you can search on Ads.

Request the ES node

When a some Ads has been indexed, you can test some fun queries :

Get market Ads:

/market/record/ID -> Access to one Ad, by an

/market/records/_search -> Launch a search, in Ads

/market/_api -> User friendly request on Ads

http://localhost:9200/market/_api?
  pretty  // Format the result
  &type=offer  // Ad type: 'offer', 'need' or 'crowdfunding'
  &size=20 // page size
  &from=0  // page offset
  &category=cat20 // Category id
  &q=photo // Search text
  &lat=47  // Spatial search: latitude
  &lon=1.1 // Spatial search: longitude
  &distance=20km // Spatial search: distance around the point lat/lon
  &ĺocation=<ID_shape>  // (Not implemented yet) shape Id (from map)

Result example:

[ {
"thumbnail" : {
  "_content_type" : "image/png"
},
"unit" : "unit", // Price unit: 'unit" ou 'ud'
"price" : 15000, // Price * 100 
"currency" : "g1", 
"type" : "offer", // Ad type
"title" : "Hachoir, mixeur, émulsionneur Seb", // Ad's title
"category" : {  // Ad's category
  "name" : "Electroménager",
  "parent" : "cat18",
  "id" : "cat20"
}
} ]

Update to latest version

Download latest stable version
Unzip into a new directory (e.g. /opt/gchange-pod-vX.Y.Z)
Stop existing pod, if running: /bin/gchange-pod stop or, if running as a systemd service: sudo service gchange-pod stop
From the old Pod directory:
- Copy the directory data, that contains all indexed data, into the new installation directory
- Merge the old file config/elasiticsearch.yml with the new configuration file (using diff to compare options).
```
cd path/to/old/gchange-pod
cp -r data /path/to/new/gchange-pod
diff config/elasticsearch.yml   /path/to/new/gchange-pod/config/elasticsearch.yml
```
Start the new pod: /bin/gchange-pod start If was running as systemd service, don't forget to update the service file, to make sure it use the new installation directory;
Check everething is fine, in logs:

tail -f /path/to/new/gchange-pod/logs/<pod_cluster_name>.log

Troubleshooting

Message:

$ ./elasticsearch
Unrecognized VM option 'UseParNewGC'
Error: Could not create the Java Virtual Machine.
Error: A fatal exception has occurred. Program will exit.

Cause:

Your Java JDK version is probably up to 8 (version 10 or 11).
Solution:

Edit the file bin/elasticsearch.in.sh and comment out the following line:
```
# ES_GC_OPTS="$ES_GC_OPTS -XX:+UseParNewGC"
```

Error `Refused GET request to [/ws/event/user/…`

Message:

Refused GET request to [/ws/event/user/<pubkey>…

Cause:

Gchange try to open a WebSocket on your pod throw HTTP v1.0, and not throw HTTP v1.1.

Solution:

Configure your web server to force HTTP 1.1 connection.

On a Nginx server:

Edit the web site configuration (usually at /etc/nginx/site-available/<site-name>);
Add this lines:

  server {

      server_name pod.domain.org;

      (...)

      location /ws/ {
          # Replace by your Pod local address:
          proxy_pass http://127.0.0.1:9200;

          proxy_http_version 1.1;
          proxy_set_header Upgrade $http_upgrade;
          proxy_set_header Connection 'upgrade';
          proxy_set_header Host $host;
          proxy_cache_bypass $http_upgrade;
          proxy_read_timeout 86400s;
          proxy_send_timeout 86400s;
      }
}

Restart Nginx service;

Error `Could not find an implementation class`

Message:

java.lang.RuntimeException: java.lang.RuntimeException: Could not find an implementation class.
        at org.duniter.core.util.websocket.WebsocketClientEndpoint.<init>(WebsocketClientEndpoint.java:56)
        at org.duniter.core.client.service.bma.BlockchainRemoteServiceImpl.addNewBlockListener(BlockchainRemoteServiceImpl.java:545)
        at org.duniter.elasticsearch.service.BlockchainService.listenAndIndexNewBlock(BlockchainService.java:106)

Cause:

Plugin use Websocket to get notification from a Duniter nodes. The current library (Tyrus) is loaded throw java Service Loader, that need access to file META-INF/services/javax.websocket.ContainerProvider contains by Tyrus. ElasticSearch use separated classloader, for each plugin, that disable access to META-INF resource.

Solution :

Move Tyrus libraries into elasticsearch lib/ directory :

cd <INSTALL_DIR>
mv plugins/gchange-pod-core/tyrus-*.jar lib
mv plugins/gchange-pod-core/javax.websocket-api-*.jar lib

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

install.md

install.md

Installation guide

Prerequisites

Install Java

Install libsodium

Install bundle (ElasticSearch and Gchange Pod)

Test your node

Using a web browser

Using Gchange

Request the ES node

Update to latest version

More documentation

Troubleshooting

Error `Refused GET request to [/ws/event/user/…`

Error `Could not find an implementation class`

Files

install.md

Latest commit

History

install.md

File metadata and controls

Installation guide

Prerequisites

Install Java

Install libsodium

Install bundle (ElasticSearch and Gchange Pod)

Test your node

Using a web browser

Using Gchange

Request the ES node

Update to latest version

More documentation

Troubleshooting

Error Refused GET request to [/ws/event/user/…

Error Could not find an implementation class

Error `Refused GET request to [/ws/event/user/…`

Error `Could not find an implementation class`