diff --git a/orientdb/README-short.txt b/orientdb/README-short.txt new file mode 100644 index 00000000..76651d13 --- /dev/null +++ b/orientdb/README-short.txt @@ -0,0 +1 @@ +OrientDB a Multi-Model Open Source NoSQL DBMS that combines graphs and documents. \ No newline at end of file diff --git a/orientdb/content.md b/orientdb/content.md new file mode 100644 index 00000000..b0e5c030 --- /dev/null +++ b/orientdb/content.md @@ -0,0 +1,70 @@ +# What is OrientDB? + +[OrientDB](http://www.orientdb.org) is the first Multi-Model Open Source NoSQL DBMS that combines the power of graphs and the flexibility of documents into one scalable, high-performance operational database. + +%%LOGO%% + +## How to use this image + +When OrientDB starts it asks for the root password. The root user is able to manage the OrientDB server: create new databases, manage users and roles. The root password can be passed to the container using an environment property: + +```console +$ docker run -d --name orientdb -p 2424:2424 -p 2480:2480 -e ORIENTDB_ROOT_PASSWORD=rootpwd orientdb:latest +``` + +The [Studio](http://orientdb.com/docs/last/Home-page.html) is accessible to http://:2480 (e.g.: http://localhost:2480) + +### Attach persistent volumes + +The docker image contains an OrientDB installation with basic configuration. If you need to provide your own config folder from which OrientDB will read its startup settings, simply attach a persistent volume for configuration folder. Providing a configuration folder enables integration with software configuration tools such as Ansible or Puppet. + +The same applies for the databases folder which if local to the running container would go away as soon as it died/you killed it. Obviously use volumes from dedicated data container is another option. + +```console +$ docker run -d --name orientdb -p 2424:2424 -p 2480:2480 \ + -v :/orientdb/config \ + -v :/orientdb/databases \ + -v :/orientdb/backup \ + -e ORIENTDB_ROOT_PASSWORD=rootpwd \ + orientdb:latest +``` + +### Running OrientDB tools + +The OrientDB image contains a full fledge installation, so it is possible to run the [console](http://orientdb.com/docs/last/Console-Commands.html) + +```console +$ docker run --rm -it orientdb:latest /orientdb/bin/console.sh +``` + +or even the etl + +```console +$ docker run --rm -it -v :/orientdb/config orientdb:latest /orientdb/bin/oetl.sh ../config/oetl-config.json +``` + +### Override configuration parameters + +Any configuration settings may be specified upon startup using the `-D` option prefix. For example, starting OrientDB in distributed configuration will work this way: + +```console +$ docker run -d --name orientdb -p 2424:2424 -p 2480:2480 \ + -v :/orientdb/config \ + -v :/orientdb/databases \ + -v :/orientdb/backup \ + -e ORIENTDB_ROOT_PASSWORD=rootpwd \ + -e ORIENTDB_NODE_NAME=odb1 \ + orientdb:latest /orientdb/bin/server.sh -Ddistributed=true +``` + +For further configuration options please refer to the [Configuration](http://orientdb.com/docs/latest/Configuration.html) section of the online documentation. + +### Environment + +Environment parameters such as heap size could be passed via command line: + +```console +$ docker run -d --name orientdb -p 2424:2424 -p 2480:2480 \ + -e ORIENTDB_ROOT_PASSWORD=rootpwd \ + orientdb:latest /orientdb/bin/server.sh -Xmx8g +``` diff --git a/orientdb/licence.md b/orientdb/licence.md new file mode 100644 index 00000000..737f4edc --- /dev/null +++ b/orientdb/licence.md @@ -0,0 +1 @@ +View [license information](https://github.com/orientechnologies/orientdb/blob/master/license.txt) for the software contained in this image. diff --git a/orientdb/logo.png b/orientdb/logo.png new file mode 100644 index 00000000..cb5bd20f Binary files /dev/null and b/orientdb/logo.png differ diff --git a/update.sh b/update.sh index 5aff4389..bb01f8b2 100755 --- a/update.sh +++ b/update.sh @@ -59,6 +59,7 @@ declare -A otherRepos=( [odoo]='https://github.com/odoo/docker' [opensuse]='https://github.com/openSUSE/docker-containers-build' [oraclelinux]='https://github.com/oracle/docker' + [orientdb]='https://github.com/orientechnologies/orientdb-docker' [perl]='https://github.com/Perl/docker-perl' [photon]='https://github.com/frapposelli/photon-docker-image' [piwik]='https://github.com/piwik/docker-piwik'