chekaz/docker-feathercoin repository overview

⁠Docker-feathercoin

feathercoin uses peer-to-peer technology to operate with no central authority or banks; managing transactions and the issuing of feathercoin is carried out collectively by the network. feathercoin is open-source; its design is public, nobody owns or controls feathercoin and everyone can take part. Through many of its unique properties, feathercoin allows exciting uses that could not be covered by any previous payment system.

This Docker image provides feathercoin, feathercoin-cli and feathercoin-tx applications which can be used to run and interact with a feathercoin server.

Images are provided for a range of current and historic feathercoin forks. To see the available versions/tags, please visit the appropriate pages on Docker Hub:

⁠Usage

To start a feathercoind instance running the latest version:

$ docker run chekaz/feathercoin

This docker image provides different tags so that you can specify the exact version of feathercoin you wish to run. For example, to run the latest minor version in the 0.11.x series (currently 0.11.2):

$ docker run chekaz/feathercoin:0.19.1

Or, to run the 0.19.1 release specifically:

$ docker run chekaz/feathercoin:0.19.1

To run a feathercoin container in the background, pass the -d option to docker run, and give your container a name for easy reference later:

$ docker run -d --rm --name feathercoind chekaz/feathercoin

Once you have a feathercoin service running in the background, you can show running containers:

$ docker ps

Or view the logs of a service:

$ docker logs -f feathercoind

To stop and restart a running container:

$ docker stop feathercoind
$ docker start feathercoind

Specific versions of these alternate clients may be run using the command line options above.

⁠Configuring feathercoin

The best method to configure the feathercoin server is to pass arguments to the feathercoind command. For example, to run feathercoin on the testnet:

$ docker run --name feathercoind-testnet chekaz/feathercoin feathercoind -testnet

Alternatively, you can edit the feathercoin.conf file which is generated in your data directory (see below).

⁠Data Volumes

By default, Docker will create ephemeral containers. That is, the blockchain data will not be persisted, and you will need to sync the blockchain from scratch each time you launch a container.

To keep your blockchain data between container restarts or upgrades, simply add the -v option to create a data volume⁠:

$ docker run -d --rm --name feathercoind -v feathercoin-data:/data chekaz/feathercoin
$ docker ps
$ docker inspect feathercoin-data

Alternatively, you can map the data volume to a location on your host:

$ docker run -d --rm --name feathercoind -v "$PWD/data:/data" chekaz/feathercoin
$ ls -alh ./data

⁠Using feathercoin-cli

By default, Docker runs all containers on a private bridge network. This means that you are unable to access the RPC port (8332) necessary to run feathercoin-cli commands.

There are several methods to run bitclin-cli against a running feathercoind container. The easiest is to simply let your feathercoin-cli container share networking with your feathercoind container:

$ docker run -d --rm --name feathercoind -v feathercoin-data:/data chekaz/feathercoin
$ docker run --rm --network container:feathercoind chekaz/feathercoin feathercoin-cli getinfo

If you plan on exposing the RPC port to multiple containers (for example, if you are developing an application which communicates with the RPC port directly), you probably want to consider creating a user-defined network⁠. You can then use this network for both your feathercoind and bitclin-cli containers, passing -rpcconnect to specify the hostname of your feathercoind container:

$ docker network create feathercoin
$ docker run -d --rm --name feathercoind -v feathercoin-data:/data --network feathercoin chekaz/feathercoin
$ docker run --rm --network feathercoin chekaz/feathercoin feathercoin-cli -rpcconnect=feathercoind getinfo

⁠Complete Example

For a complete example of running a feathercoin node using Docker Compose, see the Docker Compose example⁠.

⁠License

Configuration files and code in this repository are distributed under the MIT license⁠.

⁠Contributing

All files are generated from templates in the root of this repository. Please do not edit any of the generated Dockerfiles directly.

• To add a new feathercoin version, update versions.yml⁠, then run make update.
• To make a change to the Dockerfile which affects all current and historical feathercoin versions, edit Dockerfile.erb⁠ then run make update.

If you would like to build and test containers for all versions (similar to what happens in CI), run make. If you would like to build and test all containers for a specific feathercoin fork, run BRANCH=core make.