Key Server Proxy: Difference between revisions

From Obsidian Scheduler
Jump to navigationJump to search
No edit summary
No edit summary
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
Obsidian licensing requires access to Carfey Software's servers to verify licence authenticity.  To accommodate those who wish to limit Obsidian hosts with access to the internet, we provide a key server proxy that can be deployed in any servlet container.   
Obsidian licensing requires access to Carfey Software's servers to verify license authenticity.  To accommodate those who wish to limit Obsidian hosts with access to the internet, we provide a key server proxy that can be deployed in any servlet container.   


In your software package, you would have received the key server proxy as obsidianKeyProxy.war. Within this war, under WEB-INF/classes is com.carfey.properties. Within this file you should set your licence key, based on the template provided. Note you should not need to edit the master key server url, which is fixed at "https://licence.carfey.com:8443/obsidianKeyMaster/proxy".
In your software package, you would have received the key server proxy as <code>obsidianKeyProxy.war</code>. Within this war, under <code>WEB-INF/classes</code> is <code>com.carfey.properties</code>. Note you should not need to edit the master key server url, which is fixed at "https://licence.carfey.com/proxy".


To configure use of the key server proxy by the Obsidian scheduler, simply login to Obsidian Web Admin app as an admin user, access the System tab, select the Licence category and set the address of your deployed key server proxy as the clientKeyServerUrl.  Make sure it ends with "/licence", e.g. "https://internal.server/licence".
'''Prior to Obsidian 2.5.0'''
Within the file <code>com.carfey.properties</code>, you should set your license key, based on the template provided.  


Then make sure the value for the parameter clientKeyServerUrlBackup is set to Carfey Software's key licence server at https://licence.carfey.com:8443/obsidianKeyMaster/licence. This will give you failover in case your proxy goes down.
Once the proxy is deployed, to configure use of the key server proxy by the Obsidian scheduler, simply login to Obsidian Web Admin app as an admin user, access the System tab, select the ''Licence'' category and set the address of your deployed key server proxy as the ''clientKeyServerUrl''.  Make sure it ends with "/licence", e.g. "https://internal.server/licence". 
 
Then make sure the value for the [[Admin System_(3.x.x and earlier)|system setting]] ''clientKeyServerUrlBackup'' is set to Carfey Software's key license server at https://licence.carfey.com/licence. This will give you failover in case your proxy goes down.


'''Security Note:''' By default, the proxy key server allows non-secure connections. If you wish to force secure connections through HTTPS, you can edit the web.xml in your war and uncomment the <security-constraint> element in the file. This will force all requests to redirect to an encrypted connection. For details on setting up SSL on your servlet container, refer to its documentation.
'''Security Note:''' By default, the proxy key server allows non-secure connections. If you wish to force secure connections through HTTPS, you can edit the web.xml in your war and uncomment the <security-constraint> element in the file. This will force all requests to redirect to an encrypted connection. For details on setting up SSL on your servlet container, refer to its documentation.

Latest revision as of 17:41, 1 July 2016

Obsidian licensing requires access to Carfey Software's servers to verify license authenticity. To accommodate those who wish to limit Obsidian hosts with access to the internet, we provide a key server proxy that can be deployed in any servlet container.

In your software package, you would have received the key server proxy as obsidianKeyProxy.war. Within this war, under WEB-INF/classes is com.carfey.properties. Note you should not need to edit the master key server url, which is fixed at "https://licence.carfey.com/proxy".

Prior to Obsidian 2.5.0 Within the file com.carfey.properties, you should set your license key, based on the template provided.

Once the proxy is deployed, to configure use of the key server proxy by the Obsidian scheduler, simply login to Obsidian Web Admin app as an admin user, access the System tab, select the Licence category and set the address of your deployed key server proxy as the clientKeyServerUrl. Make sure it ends with "/licence", e.g. "https://internal.server/licence".

Then make sure the value for the system setting clientKeyServerUrlBackup is set to Carfey Software's key license server at https://licence.carfey.com/licence. This will give you failover in case your proxy goes down.

Security Note: By default, the proxy key server allows non-secure connections. If you wish to force secure connections through HTTPS, you can edit the web.xml in your war and uncomment the <security-constraint> element in the file. This will force all requests to redirect to an encrypted connection. For details on setting up SSL on your servlet container, refer to its documentation.