Skip to content

docs: docs for deployment #58

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
at88mph merged 1 commit into from
Oct 28, 2025
Merged

docs: docs for deployment #58

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions download-manager/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,56 @@

## 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`:
```txt
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:
Expand Down
Loading