From fc4a2b11e010ebdc06145bef6d6f816b7cbc6f1a Mon Sep 17 00:00:00 2001 From: ghubstan <36207203+ghubstan@users.noreply.github.com> Date: Wed, 6 Jul 2022 12:37:54 -0300 Subject: [PATCH] Warn about running api and gui at same time --- .../bisq/apidoc/markdown/ProtobufDefinitionParser.java | 6 ++++++ .../src/main/resources/templates/warnings.md | 7 +++++++ 2 files changed, 13 insertions(+) create mode 100644 reference-doc-builder/src/main/resources/templates/warnings.md diff --git a/reference-doc-builder/src/main/java/bisq/apidoc/markdown/ProtobufDefinitionParser.java b/reference-doc-builder/src/main/java/bisq/apidoc/markdown/ProtobufDefinitionParser.java index b16c931..a9f37e9 100644 --- a/reference-doc-builder/src/main/java/bisq/apidoc/markdown/ProtobufDefinitionParser.java +++ b/reference-doc-builder/src/main/java/bisq/apidoc/markdown/ProtobufDefinitionParser.java @@ -410,6 +410,12 @@ public class ProtobufDefinitionParser { .build(); mdBlocks.add(introBlock); + Template warningsTemplate = new Template("warnings.md"); + Block warningsBlock = StringBlock.builder() + .content(warningsTemplate.getContent()) + .build(); + mdBlocks.add(warningsBlock); + Template examplesSetupTemplate = new Template("examples-setup.md"); Block examplesSetupBlock = StringBlock.builder() .content(examplesSetupTemplate.getContent()) diff --git a/reference-doc-builder/src/main/resources/templates/warnings.md b/reference-doc-builder/src/main/resources/templates/warnings.md new file mode 100644 index 0000000..f253741 --- /dev/null +++ b/reference-doc-builder/src/main/resources/templates/warnings.md @@ -0,0 +1,7 @@ +# Warning + +Never run an API Daemon and the Bisq desktop application on the same host at the same time. + +The API daemon and the GUI share the same default wallet and connection ports. Beyond inevitable failures due to +fighting over the wallet and ports, doing so will probably corrupt your wallet. Before starting the API daemon, make +sure your GUI is shut down, and vice-versa. Please back up your mainnet wallet early and often with the GUI.