npm install
bower install
./ml local bootstrap
./ml local deploy modules
./ml local deploy content
gulpIf the app-port specified in build.properties is already occupied and you want to change it for your local environment, do the follow:
Likewise, if you are running MarkLogic on a different host than where you are running the user interface, pass --ml-host to the gulp server command.
You can find the sample data set at ssh.marklogic.com:/home/dcassel/projects/demo-cat/demo-cat.zip. Load it with:
$ ./ml local mlcp import -input_file_path <path to dir with zips or zip itself> -input_compressed –document_type xmlYou will need to set the mlcp-home property in your local.properties file for this to work. For instance:
mlcp-home=/Users/dcassel/software/mlcp-Hadoop2-1.2-1A local git repo has been setup on the server, add it as a remote to your local git:
Then run the following each time you want to update code on the demo server:
Ask IT for sudo rights, you might need to chown files to a shared group to have write access.
Once done that, you can run all above deployment steps on the server, just go to /space/projects/demo-cat.live/. A few ml commands might return an error, but only after having done what needed to be done.
The code includes service scripts, and service configs to make installing express server service and gulp watch service as easy as possible. The following files are involved:
The conf.sh is 'sourced' by the service scripts, and allows overriding the built-in defaults. Usually you only need to override SOURCE_DIR, APP_PORT, and ML_PORT. Make sure they match the appropriate environment.
Next step is to push all source files to the appropriate server. The following assumes it was dropped under /space/projects/ in a folder called demo-cat.live. Take these steps to install the services:
Next to start them, use the following commands (from any directory):
These services will also print usage without param, but they support info, restart, start, status, and stop. The info param is very useful to check the settings.
Easiest way to do this is to configure SSL in httpd. Make sure mod_ssl and openssl are installed:
Then use openssl to generate a key, a CSR (Cert Sign Request), and self-cert the CSR:
You will need to enter Country, Company, and server name for the CSR. You can also use the CSR to get a Certificate signed by a third party (IT will likely be able to help with that).
Copy the output files in the right location:
Next is configuring httpd. Make sure the ssl.conf points to the correct catalog.key (SSLCertificateKeyFile) and catalog.crt (SSLCertificateFile)
You probably also want to unwrap ssl.conf from the
Make sure you have both of these enabled:
NameVirtualHost *:80
NameVirtualHost *:443And then insert the following at the end:
<VirtualHost *:80>
ServerName catalog-new.demo.marklogic.com
Redirect permanent / https://catalog-new.demo.marklogic.com/
</VirtualHost>
<VirtualHost *:443>
SSLEngine on
ServerName catalog-new.demo.marklogic.com
RewriteEngine On
RewriteCond %{HTTPS} on
RewriteRule ^(.*)$ http://localhost:4000$1 [P]
</VirtualHost>You can verify httpd config with:
For official signing, you need to forward the catalog.csr to IT. They will send two pem files in return: one for the Cert Authority (ca.cert.pem), and a replacement for the catalog.crt file (catalog.demo.cert.pem). Put both in the certs folder, and make sure SSLCertificateFile points to catalog.demo.cert.pem, and SSLCACertificateFile to ca.cert.pem.
Roxy (RObust XQuerY Framework) is a lightweight framework for quickly developing well-structured, easily maintained XQuery applications. Roxy was heavily inspired by Ruby On Rails and CakePHP.
To get help with Roxy,
Roxy Deployer makes managing MarkLogic application easy. Simply edit a few configuration files and you have full access to create and deploy applications to MarkLogic servers, local or remote. Roxy Deployer is written in Ruby and is easily extended to add additional functionality.
The meat and potatoes of Roxy, the mVC (with a de-emphasis on m) is a light-weight MVC framework fashioned after Ruby on Rails and CakePHP. It relies heavily on Convention over Configuration.
What good is your code if it doesn't work? Testing is paramount to the development process. The Roxy Unit Tester tests XQuery with XQuery. Write your tests in XQuery and run them from the UI or from the command line. Roxy Unit Tester produces JUnit XML output so you can use it with your favorite continuous testing tool.
This section describes the quickest way to get started using Roxy.
$ git clone git://github.com/marklogic/roxy.git
$ ml init app-name --server-version=[version-number]# 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
# Specify the server(s) you wish to deploy to here. This tutorial assumes you are using localhost.
local-server=localhost
#dev-server=
#cert-server=
#prod-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.
$ ./ml local bootstrap$ ml local restartThis 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.
$ ml local deploy modulesOpen your favorite web browser to http://localhost:port
Sub in your hostname and port from build.properties
Congratulations! You have Roxy running on your server. Now you need to start customizing it.
For more information run:
$ ./ml -h