Quick Start

This section describes the quickest way to get started using Roxy.

Assumptions

• You have Ruby installed (version 1.9.3 or greater) compiled with openssl support.
• You already have one or more MarkLogic Servers running somewhere that you can access from your computer. If not, get it here.*
• You know the admin logon to your MarkLogic Server(s)

Download Roxy

> git clone git://github.com/marklogic/roxy.git

Configure your application

1. Open a command prompt in the root folder of Roxy
2. Run ml init to create sample configuration files (must specify --server-version option with a value of 4, 5, 6 or 7) > ml init app-name --server-version=[version-number]
3. Modify deploy/build.properties with your application's settings.

  # Username to authenticate to ML
  user=your-ml-admin-username  
  # password for ML authentication
  password=your-ml-admin-password  
  # the authentication type for the appserver (digest|basic|application-level)
  authentication-method=application-level  
  # the default user to authenticate with. defaults to nobody
  default-user=nobody  
  # the root path of your modules. Use this to override the modules db and use your filesystem location
  modules-root=/the/path/to/your/files/on/the/filesystem  
  # either 'filesystem' or 'name of db'  
  app-modules-db=filesystem  
  # Specify the server(s) you wish to deploy to here. This tutorial assumes you are using localhost.
  local-server=localhost
  #dev-server=
  #prod-server=
  

Configure MarkLogic Server

This step is only needed when database configurations have changed or on a fresh install. In most cases you will not need to restart your server.

1. Open a command prompt in the root folder of Roxy
   If your server is not configured as local-server in build.properties then substitute your environment here ( local | dev | prod )
2. > ml local bootstrap
3. Depending on what, if anything, you changed you may need to restart MarkLogic in order to proceed. If you see output telling you to restart...
   > ml local restart

Deploying Code

This step describes how to deploy your Roxy application into your MarkLogic Server modules database. If you have elected to run your code locally out of the filesystem you do not need to do this.

1. Open a command prompt in the root folder of Roxy
2. > ml local deploy modules
3. Open your favorite web browser to http://localhost:port
   Sub in your hostname and port from build.properties

Congratulations

Congratulations! You have Roxy running on your server. Now you need to start customizing it.

Getting Help

For more information run:
> ml -h