Skip to content

readme: update github package help #156

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
merged 1 commit into from
Dec 14, 2023
Merged

readme: update github package help #156

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down