Install

Installing is fairly simple. Start by downloading and unpacking the latest binary distribution package. Don't worry about disk size, data will be stored elsewhere. The following folders are created:

  • /x86 - 32-bit binaries
  • /x64 - 64-bit binaries
  • /scripts

The scripts folder contains examples for installing, running, starting and stopping the the server and a default configuration file. Feel free to modify or use as templates. Pro tip: Copy any modified or custom files to a different location to avoid having them overwritten when upgrading.

Configure

Most configuration is done using the web based interface. However, some information needs to be passed to the server during startup. Modify the scripts/origo.config xml file if you need to change any of the following defaults:

Key Default Description
AdminHost 127.0.0.1 The host name used to access the web based administration app.
AdminPort 8088 TCP port of the web based administration app
DefaultDataDirectory c:\data The default location for data (model binaries, command journal and snapshots)
<log4net> custom xml The logging configuration, for details see the log4net documentation

If you change the admin server host and/or port you need to adjust the url in scripts/set-env.cmd accordingly.

Install as a service

In a production Windows environment OrigoDB should be run as a Windows service. To install as a service run scripts/install-service.cmd

Multiple instances

You can create or attach multiple databases to a single OrigoDB server process. However, the current version only supports a single database online at a time. If you need multiple databases, you can run multiple server processes. Setting it up is a bit tricky. You need a separate data directory for the master database, a unique endpoint for the web based ui and a unique service name. Here's the procedure for setting up a second server instance as a windows service:

  1. Make a copy of the entire scripts folder
  2. Modify data directory and host/port in the scripts/origo.config file
  3. Modify set-env.cmd, including:
    • A service instance name, example set instancename=second
    • The service name, example: set servicename=origodb.second
    • The admin url to reflect the host/port as per the config file
    • the config parameter pointing to the modified file
  4. Run install-service.cmd as administrator

The rest of the scripts will use the settings from set-env.cmd

Important!When running multiple instances, make sure the native and sync interfaces have unique ip/port combinations. This is configured on the "Configuration" tab of each database.

System requirements

OrigoDB Server requires the .NET Framework 4 or Mono 3. Note: We don't test every build against Mono, so there's a good chance it's broken. If you find a bug please let us know using the community support forum on Google Groups and we'll jump right on it!

Choosing between 32-bit and 64-bit binaries

The maximum amount of memory available to a 32-bit process is < 4GB due to pointers being 32-bits long. 64-bit processes use 64-bit pointers thus can address more memory. The drawback is that every object reference in the in-memory model uses 8 bytes instead of 4 AND every object on the heap consumes few bytes extra internally. We recommend you to use the 64-bit version unless you know for sure that you won't need more than 4GB RAM and you wan't to keep the actual memory consumed to a minimum.

Modify scripts/set-env.cmd to switch to 64-bit binaries. You will need to reinstall the windows service if switching between x32/x64.