mauncoin/recordskeeper repository overview

⁠Tags - Dokerfile

For now, there is only one image with one tag:

• latest (Dockerfile)⁠

⁠What is RecordsKeeper?

RecordsKeeper is used to create records on blockchain for documents. It preserves authenticity and integrity, without the need of a central authority. More on RecordsKeeper⁠ website.

⁠How to use this image.

This image is made for a GNU/Linux system (on a VPS for instance) and is built with the version 1.0.0 of RecordsKeeper.

⁠Quick start

By default, you can use the built image of this repository like this: mkdir rk docker run -d --name {The name you want for your node} -v $PWD/rk:/home/xrkuser/.rk mauncoin/recordskeeper

You can "speak" with the rkd daemon by this way: docker exec {The name of the node} rk-cli recordskeeper getinfo to see what your node is doing. Replace getinfo in the preceding command by help to have a summary of the commands available with rkd daemon.

If you are not comfortable with this way of doing things, you can issue this command: docker exec -it {The name of the node} /bin/bash It will bring you to a command prompt inside the container.

⁠Building - Arguments

There are 4 arguments used to consider when building the image:

• xrkversion: 1.0.0
• xrkdir:recordskeeper-$xrkversion, where the package is decompressed in the image
• tarxrk: recordskeeper-$xrkversion.tar.gz, the name of the tarball
• xrkurl: https://github.com/RecordsKeeper/recordskeeper-core/releases/download/v$xrkversion/$tarxrk, the url of the package to download.

One can simply change $xrkversion to rebuild an updated image of RecordsKeeper. If the URL in github change, this can be addressed by changing $xrkdir, $tarxrk, $xrkurl. The command to build is similar to :

docker build -t {tag-name} --build-arg xrkversion=X.X.X . 

The --build-arg arguments are optionals. Don't forget the folder where is your Dockerfile file (here it's ".")

⁠Running - Environment variable

First, you need to create a folder where to hold the RecordsKeeper data. Otherwise, all will be lost when shutting down the node (especially wallet!). If you don't create this folder, it will be created when starting the node, but the owner will be root, and it will raise a "Permission denied", stopping immediatly the node.

There is only one environment variable, SEEDNODE, which is configured with the seed node of RecordsKeeper, on the mainnet: ``` [email protected]:7895

To use the Testnet, you can pass the -e flag to the docker run command line:
`-e [email protected]:8379`
In this case, to communicate with the daemon, use `rk-cli recordskeeper-test cmd`.

Launch the node with this command: `docker run -d --name {The name you want for your node}  -v $PWD/{The folder to save node's data}:/home/xrkuser/.rk {Name of the image}`