Merge pull request #106 from kghmanuel/feature-103-alt

Feature 103 - convert project to use Roxy

Author: eouthwaite

config/webserver-settings.sh

@@ -2,8 +2,8 @@
 
 # CREATED BY YEOMAN generator-mljsworkplace!
 
-RESTHOST=192.168.123.4
-RESTPORT=6061
+RESTHOST=localhost
+RESTPORT=8040
 DATABASE=workflow-content
 MLADMINUSER=admin
 MLADMINPASS=admin

deploy/app_specific.rb

@@ -0,0 +1,77 @@
+#
+# Put your custom functions in this class in order to keep the files under lib untainted
+#
+# This class has access to all of the private variables in deploy/lib/server_config.rb
+#
+# any public method you create here can be called from the command line. See
+# the examples below for more information.
+#
+class ServerConfig
+
+  #
+  # You can easily "override" existing methods with your own implementations.
+  # In ruby this is called monkey patching
+  #
+  # first you would rename the original method
+  # alias_method :original_deploy_modules, :deploy_modules
+
+  # then you would define your new method
+  # def deploy_modules
+  #   # do your stuff here
+  #   # ...
+
+  #   # you can optionally call the original
+  #   original_deploy_modules
+  # end
+
+  #
+  # you can define your own methods and call them from the command line
+  # just like other roxy commands
+  # ml local my_custom_method
+  #
+  # def my_custom_method()
+  #   # since we are monkey patching we have access to the private methods
+  #   # in ServerConfig
+  #   @logger.info(@properties["ml.content-db"])
+  # end
+
+  #
+  # to create a method that doesn't require an environment (local, prod, etc)
+  # you woudl define a class method
+  # ml my_static_method
+  #
+  # def self.my_static_method()
+  #   # This method is static and thus cannot access private variables
+  #   # but it can be called without an environment
+  # end
+end
+
+#
+# Uncomment, and adjust below code to get help about your app_specific
+# commands included into Roxy help. (ml -h)
+#
+
+#class Help
+#  def self.app_specific
+#    <<-DOC.strip_heredoc
+#
+#      App-specific commands:
+#        example       Installs app-specific alerting
+#    DOC
+#  end
+#
+#  def self.example
+#    <<-DOC.strip_heredoc
+#      Usage: ml {env} example [args] [options]
+#      
+#      Runs a special example task against given environment.
+#      
+#      Arguments:
+#        this    Do this
+#        that    Do that
+#        
+#      Options:
+#        --whatever=value
+#    DOC
+#  end
+#end

deploy/build.properties

@@ -0,0 +1,210 @@
+#################################################################
+# This file contains overrides to values in default.properties
+# Make changes here, not in default.properties
+#################################################################
+
+#
+# Admin username/password that will exist on the local/dev/prod servers
+#
+user=admin
+password=admin
+
+# Your Application's name
+app-name=workflow
+
+# The root of your modules database or filesystem dir
+modules-root=/
+
+# The prefix for your modules in the modules database
+modules-prefix=/
+
+#
+# The location of your shared.properties file if you choose to use one
+# Using a shared.properties file will overwrite anything in build.properties
+# shared.properties will be overwritten by anything in environment.properties (eg. dev.properties)
+# Useful for maintaining properties in a git submodule used across multiple distinct apps
+#
+# Config file location is relative to the project root
+#
+# shared_config=shared/shared.properties
+
+#
+# the location of your marklogic configuration file
+#
+# config.file=${basedir}/deploy/ml-config.xml
+
+#
+# the location of your triggers configuration file
+# see sample at deploy/sample/triggers-config.sample.xml
+#
+# triggers.file=#{basedir}/deploy/triggers-config.xml
+
+#
+# Unit Testing
+# Leave commented out for no unit testing
+# turn these on if you are using the roxy unit tester
+# Note: to activate Unit Testing, you must have test-content-db and test-port defined
+#
+test-content-db=${app-name}-content-test
+test-modules-db=${app-name}-modules
+test-port=8042
+
+# The unit tests that come with Roxy require some privileges that we might not
+# want to grant to all users. The ${app-name}-unit-test role has those
+# privileges and also inherits from ${app-name}-role. To create a user for the
+# testing role, uncomment the two following properties. You can also run unit
+# tests as admin.
+# test-user=${app-name}-test-user
+# test-user-password=%N{7o3f;EB}RSb-N/W)l
+#
+# The authentication method used for your test appserver
+# application-level, basic, digest, digestbasic
+#
+# test-authentication-method=digest
+#
+# end of Unit Testing section
+
+#
+# Leave commented out for default
+#
+# schemas-db=${app-name}-schemas
+
+#
+# Leave commented out for default
+# turn it on if you are using triggers or CPF
+# Note: you should use an application-specific triggers database, rather than
+# the "Triggers" database that is automatically created. Using an application-
+# specific database ensures that triggers won't conflict with each other, and
+# that the "ml {env} clean triggers" command won't affect other applications.
+#
+triggers-db=${app-name}-triggers
+
+#
+# the port that the Docs appserver is running on
+# Docs appserver is required for boostrapping
+# set this to 8000 for ML 4.x and 8002 for ML 5.x
+# you should only override this if your Docs appserver
+# is running on a funky port
+#
+# bootstrap-port=
+
+#
+# The ports used by your application
+#
+app-port=8040
+xcc-port=8041
+# odbc-port=8043
+
+## Separate REST api instance
+#
+# In case you don't want to expose a REST api directly, or want to
+# run a REST api next to a different app server, uncomment the
+# rest-port property. Additionally you can override modules-db,
+# auth method, and default user as well:
+#
+# rest-port=8044
+# rest-modules-db=${app-name}-rest-modules
+# rest-authentication-method=${authentication-method}
+# rest-default-user=${default-user}
+
+#
+# set this to false if you are using an existing XCC server and
+# you don't want Roxy to manage it for you
+#
+# install-xcc=true
+
+## Security
+#
+# The authentication method used for your appserver
+# application-level, basic, digest, digestbasic
+#
+authentication-method=digest
+#
+# The authentication used for your XDBC server
+# basic, digest, digestbasic
+#
+xdbc-authentication-method=digest
+# The user used as the default user in application level authentication.
+# Using the admin user as the default user is equivalent to turning security off.
+#
+# default-user=${app-name}-user
+#
+# The password assigned to the default user for your application
+#
+appuser-password=5cPeht38`|NU32OX_?+H
+#
+# To make your http appserver use TLS/SSL, uncomment the ssl-certificate-template
+# here and uncomment the ssl-certificate-template element in ml-config.xml.
+#
+# To create a template, uncomment at least ssl-certificate-template,
+# ssl-certificate-countryName, and ssl-certificate-oranizationName
+# ssl-certificate-template=roxy
+# ssl-certificate-countryName=US
+# ssl-certificate-stateOrProvinceName=LA
+# ssl-certificate-localityName=New Orleans
+# ssl-certificate-organizationName=Zulu Krewe
+# ssl-certificate-organizationalUnitName=BeadBase
+# ssl-certificate-emailAddress=changeme@example.com
+#
+# end of Security section
+
+#
+# The type of application. Choices are:
+# bare: a bare Roxy app project
+# mvc: a normal, XQuery-based Roxy MVC app
+# rest: an app based on the ML6 REST API
+# hybrid: an app that uses Roxy rewriting and the ML6 REST API
+#
+app-type=rest
+
+#
+# The major version of MarkLogic server you are using
+# 6, 7, 8
+#
+server-version=8
+
+#
+# the location of your REST API options
+# relevant to app-types rest and hybrid.
+#
+rest-options.dir=${basedir}/rest-api/config
+
+#
+# the location of your REST API extension modules
+# relevant to app-types rest and hybrid.
+#
+rest-ext.dir=${basedir}/rest-api/ext
+
+#
+# the location of your REST API transform modules
+# relevant to app-types rest and hybrid.
+#
+rest-transforms.dir=${basedir}/rest-api/transforms
+
+#
+# The Roxy rewriter handles both Roxy MVC and the ML REST API
+#
+url-rewriter=/MarkLogic/rest-api/rewriter.xml
+error-handler=/MarkLogic/rest-api/error-handler.xqy
+rewrite-resolves-globally=true
+
+#
+# the uris or IP addresses of your servers
+# WARNING: if you are running these scripts on WINDOWS you may need to change localhost to 127.0.0.1
+# There have been reported issues with dns resolution when localhost wasn't in the hosts file.
+#
+local-server=localhost
+#dev-server=
+#prod-server=
+
+#
+# If you want to use MLCP, make sure mlcp-home is configured correctly. Using a common location as default.
+#
+mlcp-home=/usr/local/mlcp
+mlcp-vmargs=-Xmx512m
+
+# folder to ignore when deploying into modules database
+#ignore-folders=.*/src/(node_modules|.tmp)/.*
+
+# enable the following to save and upload svn/git commit info upon deploy modules
+save-commit-info=false