Skip to content

Commit 3a497bd

Browse files
author
Mark
committed
added docu for server configuration
1 parent d0f0c56 commit 3a497bd

File tree

1 file changed

+72
-62
lines changed

1 file changed

+72
-62
lines changed

README.md

Lines changed: 72 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,72 @@
1-
2-
![ArangoDB-Logo](https://docs.arangodb.com/assets/arangodb_logo_2016_inverted.png)
3-
4-
# arangodb-java-driver
5-
6-
2.7: [![Build Status](https://secure.travis-ci.org/arangodb/arangodb-java-driver.svg?branch=2.7)](https://travis-ci.org/arangodb/arangodb-java-driver)
7-
3.0: [![Build Status](https://secure.travis-ci.org/arangodb/arangodb-java-driver.svg?branch=3.0)](https://travis-ci.org/arangodb/arangodb-java-driver)
8-
3.1: [![Build Status](https://secure.travis-ci.org/arangodb/arangodb-java-driver.svg?branch=3.1)](https://travis-ci.org/arangodb/arangodb-java-driver)
9-
4.0: [![Build Status](https://secure.travis-ci.org/arangodb/arangodb-java-driver.svg?branch=4.0)](https://travis-ci.org/arangodb/arangodb-java-driver)
10-
master: [![Build Status](https://secure.travis-ci.org/arangodb/arangodb-java-driver.svg?branch=master)](https://travis-ci.org/arangodb/arangodb-java-driver)
11-
12-
## Supported versions
13-
14-
<table>
15-
<tr><th>arangodb-java-driver</th><th>ArangoDB</th><th>network protocol</th><th>Java version</th></tr>
16-
<tr><td>4.0.x</td><td>3.1.x</td><td>VelocyStream</td><td>1.6+</td></tr>
17-
<tr><td>3.1.x</td><td>3.1.x</td><td>HTTP</td><td>1.6+</td></tr>
18-
<tr><td>3.0.x</td><td>3.0.x</td><td>HTTP</td><td>1.6+</td></tr>
19-
<tr><td>2.7.4</td><td>2.7.x and 2.8.x</td><td>HTTP</td><td>1.6+</td></tr>
20-
</table>
21-
22-
## Maven
23-
24-
To add the driver to your project with maven, add the following code to your pom.xml
25-
(please use a driver with a version number compatible to your ArangoDB server's version):
26-
27-
ArangoDB 3.1.X
28-
```XML
29-
<dependencies>
30-
<dependency>
31-
<groupId>com.arangodb</groupId>
32-
<artifactId>arangodb-java-driver</artifactId>
33-
<version>4.0.0</version>
34-
</dependency>
35-
....
36-
</dependencies>
37-
```
38-
39-
If you want to test with a snapshot version (e.g. 4.0.0-SNAPSHOT), add the staging repository of oss.sonatype.org to your pom.xml:
40-
41-
```XML
42-
<repositories>
43-
<repository>
44-
<id>arangodb-snapshots</id>
45-
<url>https://oss.sonatype.org/content/groups/staging</url>
46-
</repository>
47-
</repositories>
48-
```
49-
50-
## Compile java driver
51-
52-
```
53-
mvn clean install -DskipTests=true -Dgpg.skip=true -Dmaven.javadoc.skip=true -B
54-
```
55-
56-
# Learn more
57-
* [ArangoDB](https://www.arangodb.com/)
58-
* [ChangeLog](ChangeLog)
59-
* [Documentation](docs/documentation.md)
60-
* [Examples](src/test/java/com/arangodb/example)
61-
* [Tutorial](https://www.arangodb.com/tutorial-java/)
62-
* [JavaDoc](http://arangodb.github.io/arangodb-java-driver/javadoc-4_0/index.html)
1+
2+
![ArangoDB-Logo](https://docs.arangodb.com/assets/arangodb_logo_2016_inverted.png)
3+
4+
# arangodb-java-driver
5+
6+
2.7: [![Build Status](https://secure.travis-ci.org/arangodb/arangodb-java-driver.svg?branch=2.7)](https://travis-ci.org/arangodb/arangodb-java-driver)
7+
3.0: [![Build Status](https://secure.travis-ci.org/arangodb/arangodb-java-driver.svg?branch=3.0)](https://travis-ci.org/arangodb/arangodb-java-driver)
8+
3.1: [![Build Status](https://secure.travis-ci.org/arangodb/arangodb-java-driver.svg?branch=3.1)](https://travis-ci.org/arangodb/arangodb-java-driver)
9+
4.0: [![Build Status](https://secure.travis-ci.org/arangodb/arangodb-java-driver.svg?branch=4.0)](https://travis-ci.org/arangodb/arangodb-java-driver)
10+
master: [![Build Status](https://secure.travis-ci.org/arangodb/arangodb-java-driver.svg?branch=master)](https://travis-ci.org/arangodb/arangodb-java-driver)
11+
12+
## Supported versions
13+
14+
<table>
15+
<tr><th>arangodb-java-driver</th><th>ArangoDB</th><th>network protocol</th><th>Java version</th></tr>
16+
<tr><td>4.0.x</td><td>3.1.x</td><td>VelocyStream</td><td>1.6+</td></tr>
17+
<tr><td>3.1.x</td><td>3.1.x</td><td>HTTP</td><td>1.6+</td></tr>
18+
<tr><td>3.0.x</td><td>3.0.x</td><td>HTTP</td><td>1.6+</td></tr>
19+
<tr><td>2.7.4</td><td>2.7.x and 2.8.x</td><td>HTTP</td><td>1.6+</td></tr>
20+
</table>
21+
22+
##Server Configuration
23+
24+
To use the driver version 4.0.0 and above, you need to run ArangoDB server with an endpoint using VelocyStream protocol. (see [documentation](https://docs.arangodb.com/current/Manual/Administration/Configuration/Endpoint.html#server-endpoints))
25+
26+
```
27+
unix> ./arangod --server.endpoint vpp+tcp://127.0.0.1:8529
28+
--server.endpoint vpp+ssl://127.0.0.1:8530
29+
--ssl.keyfile server.pem /tmp/vocbase
30+
```
31+
32+
## Maven
33+
34+
To add the driver to your project with maven, add the following code to your pom.xml
35+
(please use a driver with a version number compatible to your ArangoDB server's version):
36+
37+
ArangoDB 3.1.X
38+
```XML
39+
<dependencies>
40+
<dependency>
41+
<groupId>com.arangodb</groupId>
42+
<artifactId>arangodb-java-driver</artifactId>
43+
<version>4.0.0</version>
44+
</dependency>
45+
....
46+
</dependencies>
47+
```
48+
49+
If you want to test with a snapshot version (e.g. 4.0.0-SNAPSHOT), add the staging repository of oss.sonatype.org to your pom.xml:
50+
51+
```XML
52+
<repositories>
53+
<repository>
54+
<id>arangodb-snapshots</id>
55+
<url>https://oss.sonatype.org/content/groups/staging</url>
56+
</repository>
57+
</repositories>
58+
```
59+
60+
## Compile java driver
61+
62+
```
63+
mvn clean install -DskipTests=true -Dgpg.skip=true -Dmaven.javadoc.skip=true -B
64+
```
65+
66+
# Learn more
67+
* [ArangoDB](https://www.arangodb.com/)
68+
* [ChangeLog](ChangeLog)
69+
* [Documentation](docs/documentation.md)
70+
* [Examples](src/test/java/com/arangodb/example)
71+
* [Tutorial](https://www.arangodb.com/tutorial-java/)
72+
* [JavaDoc](http://arangodb.github.io/arangodb-java-driver/javadoc-4_0/index.html)

0 commit comments

Comments
 (0)