minor changes to configuration document

docs/configuration.md

@@ -1,3 +1,113 @@
+# Configuration
+
+## openboxes-config.properties (sample)
+```
+# Database connection settings
+dataSource.url=jdbc:mysql:https://localhost:3306/openboxes
+dataSource.username=openboxes
+dataSource.password=openboxes
+
+# OpenBoxes administrator emails
+[email protected],[email protected]
+
+# Only used on local machines when dataSource.url is overriden
+openboxes.fixtures.enabled=false
+
+# OpenBoxes Identifier Formats 
+# N: Numeric, L: Letter, A: Alphanumeric
+# For example, NNNLLL might lead to the following random identifier being generated 123ABC.
+openboxes.identifier.order.format = NNNLLL
+openboxes.identifier.product.format = LLNN
+openboxes.identifier.requisition.format = NNNLLL
+openboxes.identifier.shipment.format = NNNLLL
+openboxes.identifier.transaction.format = AAA-AAA-AAA
+
+# OpenBoxes Identifier Characters
+openboxes.identifier.numeric = 0123456789
+openboxes.identifier.alphabetic = ABCDEFGHJKMNPQRSTUVXYZ
+openboxes.identifier.alphanumeric = 0123456789ABCDEFGHJKMNPQRSTUVWXYZ
+
+# Report logo header (not supported yet)
+# openboxes.report.header.logo = file:https:///home/jmiranda/Desktop/images.jpg
+openboxes.report.header.logo = http:https://localhost:8080/openboxes/images/hands.jpg
+openboxes.report.header.title = OpenBoxes
+
+# OpenBoxes Error Email feature (bug report)
+# Use your own address if you want to handle bug reports yourself. Otherwise leave as-is and OpenBoxes
+# support these support requests.
+openboxes.mail.errors.enabled = true
+openboxes.mail.errors.recipients = [email protected]
+
+# OpenBoxes Barcode Scanner detection 
+# NOTE: This feature is an experimentation. If enabled you can scan barcode on any page and the app will 
+# try to locate an object (product, shipment, etc) that is associated with that barcode. If an object is 
+# found, the app just redirects to the details page for that database object. In the future, I'm hoping to 
+# improve the barcode scanner to integrate with workflows (e.g. add item to purchase order). 
+openboxes.scannerDetection.enabled = true
+
+# Used to specify default roles for newly registered users (implies automatic activation)
+#openboxes.signup.defaultRoles=ROLE_MANAGER,ROLE_ASSISTANT
+
+# General mail settings
+grails.mail.enabled=true
+grails.mail.host=<smtp server>
+grails.mail.port=<smtp port>
+grails.mail.username=<username>
+grails.mail.password=<password>
+grails.mail.from=<from address>
+
+# Example of general mail settings 
+#[email protected]
+#grails.mail.host=smtp.gmail.com
+#grails.mail.port=465
+#[email protected]
+#grails.mail.password=password
+#grails.mail.props = ["mail.smtp.auth":"true", "mail.smtp.socketFactory.port":"465", "mail.smtp.socketFactory.class":"javax.net.ssl.SSLSocketFactory", "mail.smtp.socketFactory.fallback":"false"]
+
+# Error email properties
+mail.error.debug=true
+mail.error.server=<smtp server>
+mail.error.username=<smtp username>
+mail.error.password=<smtp password>
+mail.error.port=<smtp port>
+mail.error.to=<to address>
+
+# Example of error email properties 
+#mail.error.server=localhost
+#mail.error.server=smtp.pih.org
+#mail.error.username=openboxes
+#mail.error.password=password
+#[email protected]
+#Possible values: default|dynamic|alternate
+mail.error.appender=dynamic
+
+# OpenBoxes > Choose Location > Required Activities
+# The supported activities required in order for a location a location to show up on Choose Location page.
+# Possible values: MANAGE_INVENTORY, PLACE_ORDER, PLACE_REQUEST, FULFILL_ORDER, FULFILL_REQUEST, SEND_STOCK, RECEIVE_STOCK, EXTERNAL
+openboxes.chooseLocation.requiredActivities = MANAGE_INVENTORY
+
+# Amazon web service (not supported yet)
+aws.s3.domain=s3.amazonaws.com
+aws.s3.accessKey=0123456789ABCDEFG
+aws.s3.secretKey=0123456789ABCDEFGHIJKLMNOPQRS
+aws.s3.bucketName=files
+
+# Google Product Search (no longer supported -- Google deprecated API)
+# URL: https://www.googleapis.com/shopping/search/v1/public/products?key=${google.productSearch.key}&country=US&q=${q}&alt=scp&crowdBy=brand:1
+google.api.key=<no longer supported>
+
+# Hipaaspace.com NDC Lookup (not supported yet)
+hipaaspace.api.key=<not supported yet>
+
+# RXNorm (not supported yet)
+# URL: http:https://rxnav.nlm.nih.gov/REST/
+rxnorm.api.key=<not supported yet>
+
+# Google analytics
+google.analytics.enabled = false 
+google.analytics.webPropertyID = <enter your google analytics property ID>
+```
+
 ## Configuration file location
 As mentioned in the installation instructions, you can override application configuration properties by creating a file called `$USER_HOME/.grails/openboxes-config.properties`. If you are a developer, `$USER_HOME` should resolve to your home directory (e.g. `/home/jmiranda` on Ubuntu). If you are deploying the application to Tomcat, the file is usually located under the `TOMCAT_HOME/.grails/openboxes-config.properties`. 
 
@@ -92,110 +202,3 @@ openboxes.identifier.shipment.format = NNNLLL
 openboxes.identifier.transaction.format = AAA-AAA-AAA
 ```
 
-## Example openboxes-config.properties
-```
-# OpenBoxes administrator emails
-[email protected],[email protected]
-
-# Only used on local machines when dataSource.url is overriden
-openboxes.fixtures.enabled=false
-
-# OpenBoxes Identifier Formats
-# N - Numeric, L - Letter, A - Alphanumeric
-openboxes.identifier.order.format = NNNLLL
-openboxes.identifier.product.format = LLNN
-openboxes.identifier.requisition.format = NNNLLL
-openboxes.identifier.shipment.format = NNNLLL
-openboxes.identifier.transaction.format = AAA-AAA-AAA
-
-# OpenBoxes Identifier Characters
-openboxes.identifier.numeric = 0123456789
-openboxes.identifier.alphabetic = ABCDEFGHJKMNPQRSTUVXYZ
-openboxes.identifier.alphanumeric = 0123456789ABCDEFGHJKMNPQRSTUVWXYZ
-
-# Report logo header (not supported yet)
-# openboxes.report.header.logo = file:https:///home/jmiranda/Desktop/images.jpg
-openboxes.report.header.logo = http:https://localhost:8080/openboxes/images/hands.jpg
-openboxes.report.header.title = Last Mile Health
-
-# OpenBoxes Error Email feature (bug report)
-# Use your own address if you want to handle bug reports yourself. Otherwise leave as-is and OpenBoxes
-# support these support requests.
-openboxes.mail.errors.enabled = true
-openboxes.mail.errors.recipients = [email protected]
-
-# OpenBoxes Barcode Scanner detection 
-#
-# NOTE: This feature is an experimentation. If enabled you can scan barcode on any page and the app will 
-# try to locate an object (product, shipment, etc) that is associated with that barcode. If an object is 
-# found, the app just redirects to the details page for that database object. In the future, I'm hoping to 
-# improve the barcode scanner to integrate with workflows (e.g. add item to purchase order). 
-openboxes.scannerDetection.enabled = true
-
-# Used to specify default roles for registered users (implies automatic activation)
-#openboxes.signup.defaultRoles=ROLE_MANAGER,ROLE_ASSISTANT
-
-# Database connection settings
-dataSource.url=jdbc:mysql:https://localhost:3306/openboxes?autoReconnect=true&zeroDateTimeBehavior=convertToNull&sessionVariables=storage_engine=InnoDB
-dataSource.username=openboxes
-dataSource.password=openboxes
-
-# General mail settings
-grails.mail.enabled=true
-grails.mail.host=<smtp server>
-grails.mail.port=<smtp port>
-grails.mail.username=<username>
-grails.mail.password=<password>
-grails.mail.from=<from address>
-
-# Example of general mail settings 
-#[email protected]
-#grails.mail.host=smtp.gmail.com
-#grails.mail.port=465
-#[email protected]
-#grails.mail.password=password
-#grails.mail.props = ["mail.smtp.auth":"true", "mail.smtp.socketFactory.port":"465", "mail.smtp.socketFactory.class":"javax.net.ssl.SSLSocketFactory", "mail.smtp.socketFactory.fallback":"false"]
-
-# Error email properties
-mail.error.debug=true
-mail.error.server=<smtp server>
-mail.error.username=<smtp username>
-mail.error.password=<smtp password>
-mail.error.port=<smtp port>
-mail.error.to=<to address>
-
-# Example of error email properties 
-#mail.error.server=localhost
-#mail.error.server=smtp.pih.org
-#mail.error.username=openboxes
-#mail.error.password=password
-#[email protected]
-#Possible values: default|dynamic|alternate
-mail.error.appender=dynamic
-
-# OpenBoxes > Choose Location > Required Activities
-# The supported activities required in order for a location a location to show up on Choose Location page.
-# Possible values: MANAGE_INVENTORY, PLACE_ORDER, PLACE_REQUEST, FULFILL_ORDER, FULFILL_REQUEST, SEND_STOCK, RECEIVE_STOCK, EXTERNAL
-openboxes.chooseLocation.requiredActivities = MANAGE_INVENTORY
-
-# Amazon web service (not supported yet)
-aws.s3.domain=s3.amazonaws.com
-aws.s3.accessKey=0123456789ABCDEFG
-aws.s3.secretKey=0123456789ABCDEFGHIJKLMNOPQRS
-aws.s3.bucketName=files
-
-# Google Product Search (no longer supported -- Google deprecated API)
-# URL: https://www.googleapis.com/shopping/search/v1/public/products?key=${google.productSearch.key}&country=US&q=${q}&alt=scp&crowdBy=brand:1
-google.api.key=<no longer supported>
-
-# Hipaaspace.com NDC Lookup (not supported yet)
-hipaaspace.api.key=<not supported yet>
-
-# RXNorm (not supported yet)
-# URL: http:https://rxnav.nlm.nih.gov/REST/
-rxnorm.api.key=<not supported yet>
-
-# Google analytics
-google.analytics.enabled = false 
-google.analytics.webPropertyID = <enter your google analytics property ID>
-```