Skip to content

NO_JIRA maintenance tool for updates and uninstalls #96

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
emyers-ccdc merged 3 commits into from
Mar 11, 2026
Merged

NO_JIRA maintenance tool for updates and uninstalls #96

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d0acd18
NO_JIRA maintenance tool for updates and uninstalls
emyers-ccdc Mar 10, 2026
be5d983
Full maintenance tool commands NO_JIRA
emyers-ccdc Mar 10, 2026
d65ee9f
NO_JIRA fix typo
emyers-ccdc Mar 10, 2026
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
20 changes: 17 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
- [Updates](#updates)
- [Installer](#installer)
- [Manual Updates](#manual-updates)
- [Uninstallation](#uninstallation)
- [Known Issues](#known-issues)
- [Restart the message queue](#restart-the-message-queue)
- [Contacting Support](#contacting-support)
Expand Down Expand Up @@ -334,11 +335,16 @@ docker compose -f docker-compose.yml -f docker-compose.ssl.yml -f docker-compose

### Installer

To update your installation, re-run the maintenance tool and select the same installation folder.
Click Ok when a warning message pops up.
To update your installation, run the maintenance tool and select "Update components". Click Ok when a warning message pops up.
This will automatically pull the latest versions of all containers and restart the stack.

For major releases a new database dump file is shipped. The installer will prompt for the location. It will then overwrite the csd database volume with the update, please export any in-house databases beforehand. Once the update has completed they will need to be reimported within lattice -> database management.
For major releases a new database dump file is shipped. The maintenance tool will prompt for the location. It will then overwrite the csd database volume with the update, please export any in-house databases beforehand. Once the update has completed they will need to be reimported within lattice -> database management.
Copy link
Copy Markdown
Contributor

@github-actions github-actions Bot Mar 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[markdownlint] reported by reviewdog 🐶
MD013/line-length Line length [Expected: 200; Actual: 320]


To update from the command line:

```sh
./maintenancetool update dbDumpFile="<path to database dump file>" overWriteDb="True"
```

Contact CCDC Support for the latest download link.

Expand All @@ -356,6 +362,14 @@ docker compose -f docker-compose.yml -f docker-compose.ssl.yml -f docker-compose

Now from lattice -> database management, reimport your in-house databases.

## Uninstallation

To uninstall On-Site WebCSD run the GUI maintenance tool and select "Remove all components". Or run it from the command line with the `purge` option.

```sh
./maintenancetool purge
```

## Known Issues

### Restart the message queue
Expand Down