From 2740100f99d0a99e541ab0d79b09a18fb814cfcd Mon Sep 17 00:00:00 2001 From: Maxime Daniel Date: Thu, 14 Dec 2023 20:46:31 +0100 Subject: [PATCH] readme: update github package help --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 48109b9..480d71e 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,15 @@ except in sequential-mode (see below for more information). We use it as backend for many of our blockchain work, 0-db is not a redis replacement and never will. +# GitHub Package helper + +In order to use GitHub Package Docker image, here are some environment variable you can set: +- `DATADIR`: directory of data files +- `INDEXDIR`: directory of index files +- `DATASIZE`: maximum datafiles size +- `ADMIN`: admin password +- `PROTECT`: set to 1 to enable `--protect` which requires admin password to write on default namespace + # Quick links 1. [Build targets](#build-targets) 2. [Build instructions](#build-instructions)