From 45a767d73f96193ef2053510da373ba2f5e1485a Mon Sep 17 00:00:00 2001 From: LINCKODE Date: Mon, 9 Sep 2024 13:50:54 +0300 Subject: [PATCH] Update README.md with warning. --- README.md | 8 ++++++++ main.go | 4 ++-- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 99cddc1..45d5db2 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,12 @@ The archive system consists of two services: ## IMPORTANT +> [!WARNING] +> This version of archiver is **INCOMPATIBLE** by default with versions **v0.x.x**, as it features database compression and a different format for quorum data. +> If you wish to enable backwards compatibility, please set `STORE_COMPRESSION_TYPE` to `Snappy` and `STORE_SAVE_FULL_QUORUM_DATA` to `true`. +> Archiver **DOES NOT** migrate the database to the new format by itself, and **MAY BREAK** your existing information, if not migrated correctly. +> For a migration tool, please see the [Archiver DB Migrator](https://github.com/qubic/archiver-db-migrator), and make sure to back up your data! + Before starting the system, open the `docker-compose.yml` file and make sure that you have a reliable peer list setup for the `qubic-nodes` service. This can be configured using the `QUBIC_NODES_QUBIC_PEER_LIST` environment variable. @@ -35,6 +41,8 @@ This can be configured using the `QUBIC_NODES_QUBIC_PEER_LIST` environment varia $QUBIC_ARCHIVER_QUBIC_NODE_PORT (default: 21841) $QUBIC_ARCHIVER_QUBIC_STORAGE_FOLDER (default: store) $QUBIC_ARCHIVER_QUBIC_PROCESS_TICK_TIMEOUT (default: 5s) + $QUBIC_ARCHIVER_STORE_COMPRESSION_TYPE (default: Zstd) + $QUBIC_ARCHIVER_STORE_SAVE_FULL_VOTE_DATA (default: false) ``` ## Run with docker-compose: diff --git a/main.go b/main.go index 20478a9..6f9ac04 100644 --- a/main.go +++ b/main.go @@ -52,7 +52,7 @@ func run() error { Store struct { ResetEmptyTickKeys bool `conf:"default:false"` CompressionType string `conf:"default:Zstd"` - StoreFullVoteData bool `conf:"default:false"` + SaveFullQuorumData bool `conf:"default:false"` } } @@ -125,7 +125,7 @@ func run() error { shutdown := make(chan os.Signal, 1) signal.Notify(shutdown, os.Interrupt, syscall.SIGTERM) - proc := processor.NewProcessor(p, ps, cfg.Qubic.ProcessTickTimeout, cfg.Store.StoreFullVoteData) + proc := processor.NewProcessor(p, ps, cfg.Qubic.ProcessTickTimeout, cfg.Store.SaveFullQuorumData) procErrors := make(chan error, 1) // Start the service listening for requests.