Skip to content

Commit d243869

Browse files
authored
Merge pull request #96 from ccdc-opensource/maintenance-tool
NO_JIRA maintenance tool for updates and uninstalls
2 parents d44d25a + d65ee9f commit d243869

1 file changed

Lines changed: 17 additions & 3 deletions

File tree

README.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
- [Updates](#updates)
2424
- [Installer](#installer)
2525
- [Manual Updates](#manual-updates)
26+
- [Uninstallation](#uninstallation)
2627
- [Known Issues](#known-issues)
2728
- [Restart the message queue](#restart-the-message-queue)
2829
- [Contacting Support](#contacting-support)
@@ -334,11 +335,16 @@ docker compose -f docker-compose.yml -f docker-compose.ssl.yml -f docker-compose
334335

335336
### Installer
336337

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

341-
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.
341+
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.
342+
343+
To update from the command line:
344+
345+
```sh
346+
./maintenancetool update dbDumpFile="<path to database dump file>" overWriteDb="True"
347+
```
342348

343349
Contact CCDC Support for the latest download link.
344350

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

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

365+
## Uninstallation
366+
367+
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.
368+
369+
```sh
370+
./maintenancetool purge
371+
```
372+
359373
## Known Issues
360374

361375
### Restart the message queue

0 commit comments

Comments
 (0)