Skip to content

Commit

Permalink
Update Tutorial-Installation.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lvca authored Dec 22, 2016
1 parent b9a9a87 commit 9a5b9d9
Showing 1 changed file with 21 additions and 38 deletions.
59 changes: 21 additions & 38 deletions Tutorial-Installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,16 @@ OrientDB is available in two editions:

The Community Edition is available as a binary package for download or as source code on GitHub. The Enterprise Edition license is included with [Support](http://orientdb.com/support/) purchases.

## Use Docker

If you have Docker installed in your computer, this is the easiest way to run OrientDB. From the command line type:

$ docker run -d --name orientdb -p 2424:2424 -p 2480:2480
-e ORIENTDB_ROOT_PASSWORD=root orientdb:latest

Where instead of "root", type the root's password you want to use.


**Prerequisites**

Both editions of OrientDB run on any operating system that implements the Java Virtual machine (JVM). Examples of these include:
Expand All @@ -33,12 +43,12 @@ Both editions of OrientDB run on any operating system that implements the Java V
- HP-UX
- IBM AIX

OrientDB requires [Java](http://www.java.com/en/download), version 8 or higher.
OrientDB requires [Java](http://www.java.com/en/download), version 1.7 or higher.


>**Note**: In OSGi containers, OrientDB uses a `ConcurrentLinkedHashMap` implementation provided by [concurrentlinkedhashmap](https://code.google.com/p/concurrentlinkedhashmap/) to create the LRU based cache. This library actively uses the sun.misc package which is usually not exposed as a system package. To overcome this limitation you should add property `org.osgi.framework.system.packages.extra` with value `sun.misc` to your list of framework properties.
>**Note**: In OSGi containers, OrientDB uses a `ConcurrentLinkedHashMap` implementation provided by [concurrentlinkedhashmap](https://github.com/ben-manes/concurrentlinkedhashmap) to create the LRU based cache. This library actively uses the sun.misc package which is usually not exposed as a system package. To overcome this limitation you should add property `org.osgi.framework.system.packages.extra` with value `sun.misc` to your list of framework properties.
>
>It may be as simple as passing an argument to the VM starting the platform:
>It may be as simple as passing an argument to the VM starting the platform:
>
>```sh
>$ java -Dorg.osgi.framework.system.packages.extra=sun.misc
Expand All @@ -51,7 +61,9 @@ OrientDB provides a pre-compiled binary package to install the database on your
On server installations, you can use the `wget` utility:
<pre><code class="lang-sh">$ wget {{ book.download_multiOS }} - O orientdb-community-{{book.currentVersion}}.tar.gz</code></pre>
```sh
$ wget https://orientdb.com/download.php?file=orientdb-community-2.2.0.tar.gz
```
Whether you use your web browser or `wget`, unzip or extract the downloaded file into a directory convenient for your use, (for example, `/opt/orientdb/` on Linux). This creates a directory called `orientdb-community-2.2.0` with relevant files and scripts, which you will need to run OrientDB on your system.
Expand Down Expand Up @@ -83,39 +95,20 @@ As the time of writing this notes, the state of branches is:
* 2.0.x: hot fix for next 2.0.x stable release (2.0.x-SNAPSHOT)
* last tag on master is 2.2.0
The build process installs all jars in the local maven repository and creates archives under the `distribution` module inside the `target` directory. At the time of writing, building from branch 2.1.x gave:
The build process installs all jars in the local maven repository and creates archives under the `distribution` module inside the `target` directory. At the time of writing, building from branch 2.1.x gave:
```sh
$ls -l distribution/target/
total 199920
1088 26 Jan 09:57 archive-tmp
102 26 Jan 09:57 databases
102 26 Jan 09:57 orientdb-community-3.0.0-SNAPSHOT.dir
48814386 26 Jan 09:57 orientdb-community-3.0.0-SNAPSHOT.tar.gz
53542231 26 Jan 09:58 orientdb-community-3.0.0-SNAPSHOT.zip
102 26 Jan 09:57 orientdb-community-2.2.1-SNAPSHOT.dir
48814386 26 Jan 09:57 orientdb-community-2.2.1-SNAPSHOT.tar.gz
53542231 26 Jan 09:58 orientdb-community-2.2.1-SNAPSHOT.zip
$
```
The directory `orientdb-community-3.0.0-SNAPSHOT.dir` contains the OrientDB distribution uncompressed.
The directory `orientdb-community-2.2.1-SNAPSHOT.dir` contains the OrientDB distribution uncompressed.
Take a look to [Contribute to OrientDB](Contribute-to-OrientDB.md) if you want to be involved.
Each distribution package contains a sample database called *GratefulDeadConcerts*. It is possible to generate the database:
```sh
$ cd distribution/
$ mvn prepare-package
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building OrientDB Community Distribution ...
...
Importing GRAPHML database from ../graphdb/src/test/resources/graph-example-2.xml with options ()...
Done: imported 809 vertices and 8049 edges
Imported in 1141ms. Vertexes: 809
```
The database is created inside the target directory
```sh
$ ls target/databases/
GratefulDeadConcerts/
```
#### Update Permissions
Expand All @@ -128,16 +121,6 @@ $ chmod -R 777 config
These commands update the execute permissions on files in the `config/` directory and shell scripts in `bin/`, ensuring that you can run the scripts or programs that you've compiled.
## Use Docker
If you have Docker installed in your computer, this is the easiest way to run OrientDB. From the command line type:
$ docker run -d --name orientdb -p 2424:2424 -p 2480:2480
-e ORIENTDB_ROOT_PASSWORD=root orientdb:latest
Where instead of "root", type the root's password you want to use.
## Post-installation Tasks
For desktop users installing the binary, OrientDB is now installed and can be run through shell scripts found in the package `bin` directory of the installation. For servers, there are some additional steps that you need to take in order to manage the database server for OrientDB as a service. The procedure for this varies, depending on your operating system.
Expand Down

0 comments on commit 9a5b9d9

Please sign in to comment.