From c582125c40bf4c9452493e80e4ec921506a740e3 Mon Sep 17 00:00:00 2001
From: Dustin Jenkins <djenkins.cadc@gmail.com>
Date: Tue, 28 Oct 2025 12:47:05 -0700
Subject: [PATCH] docs: docs for deployment

---
 download-manager/README.md | 43 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)

diff --git a/download-manager/README.md b/download-manager/README.md
index 01c6077..9c8be40 100644
--- a/download-manager/README.md
+++ b/download-manager/README.md
@@ -2,6 +2,8 @@
 
 ## Running it
 
+### WAR Deployment
+
 For backwards compatibility with existing scripts, the download manager app should be run with a [WAR rename configuration](https://github.com/opencadc/docker-base/tree/main/cadc-tomcat#war-renameconf):
 
 `war-rename.conf`:
@@ -9,6 +11,47 @@ For backwards compatibility with existing scripts, the download manager app shou
 mv download-manager.war downloadManager.war
 ```
 
+### Configuration
+
+Download Manager requires a file called `org.opencadc.dlm-server.properties` to be placed in `$CATALINA_BASE/config/` with the following properties set:
+
+`org.opencadc.dlm-server.properties`:
+```properties
+# Whether to enable the Java Webstart option for bulk downloading.  Setting to true will enable that button, and false will hide it.
+org.opencadc.dlm.webstart.enable = false
+
+# The URI in the Registry of the package download service.  In CADC, this is caom2ops, but on a developer machine it could be anything.
+org.opencadc.dlm.package-download.service.id = ivo://cadc.nrc.ca/caom2ops
+```
+
+`cadc-log.properties` (See the [cadc-log](https://github.com/opencadc/core/tree/main/cadc-log#cadc-logproperties-optional) module):
+```properties
+group = <IVOA URI>
+username = <CADC username>
+```
+
+Sample `cadc-registry.properties` (See the [cadc-registry](https://github.com/opencadc/reg/tree/main/cadc-registry#cadc-registryproperties) module):
+```properties
+#  RegistryClient.baseURL replaces RegistryClient.host and is more useful
+#
+ca.nrc.cadc.reg.client.RegistryClient.baseURL=https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg
+
+# The following authority lines are only required for services.
+# this is moved from LocalAuthority.properties.
+#
+ivo://ivoa.net/std/GMS#search-1.0 = ivo://cadc.nrc.ca/gms
+ivo://ivoa.net/std/CDP#delegate-1.0 = ivo://cadc.nrc.ca/cred
+ivo://ivoa.net/std/CDP#proxy-1.0 = ivo://cadc.nrc.ca/cred
+
+ivo://ivoa.net/sso#OAuth = ivo://cadc.nrc.ca/gms
+ivo://ivoa.net/sso#OpenID = ivo://cadc.nrc.ca/gms
+ivo://ivoa.net/sso#tls-with-password = ivo://cadc.nrc.ca/gms
+
+ivo://ivoa.net/std/GMS#groups-1.0 = ivo://cadc.nrc.ca/gms
+```
+
+A file that contains the public key to verify Cookie tokens called `RsaSignaturePub.key` is also required. This file should be placed in `$CATALINA_BASE/config/`.  See the existing configuration.
+
 ## Testing it
 
 Running integration tests requires: