How to get started

Downloading

Then you need to download the MindTouch Dream source code.  You can either download an official release or grab the latest bits from the SVN repository:

• Official releases download page
• SVN Repository for nightly build: https://svn.mindtouch.com/source/public/dream/

Building

To build MindTouch Dream, either open the MindTouchDream.sln file in Microsoft Visual Studio (chose Release build) or use the build.sh command-line script to build with Mono.  In either case, the compiled and redistributable binaries will placed in the /bin sub-folder.

Running

Once compiled, you can launch the Dream host (NOTE: use "mono mindtouch.host.exe" when running on a device without Microsoft .Net 2.0):

cd bin
mindtouch.host.exe

Use your web-browser to contact the Dream host at http://localhost:8081/host/@about .  This will show the Host service  API as an HTML document.

To inspect what services are running, do a GET:services request by pointing your browser to http://localhost:8081/host/services?apikey=YOURAPIKEYHERE.  You can get your api key from the first line of output to the console.

For running Dream under IIS or as a Windows Service, read the Configuration page.

The documentation for the core Dream services can be found at here.