From 59d9674cc5711ceba769915bd304c699a2d05587 Mon Sep 17 00:00:00 2001 From: AbcSxyZ Date: Wed, 17 Nov 2021 21:27:54 +0100 Subject: [PATCH 1/9] add documentation for image --- README.md | 123 +++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 117 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index b05f12e..19b1a7c 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,122 @@ -Dogecoin on Docker +Docker images for Dogecoin ------------------- -### ⚠️ WARNING: THIS REPOSITORY IS UNDER HEAVY DEVELOPMENT ⚠️ +### Supported tags and respective `Dockerfile` links -Dogecoin docker images, from the community, for the community, with ❤️ +- [`1.14.5`,`latest`](#) -Docker images aren't available for now, work is in progress ! -Check out [issues](https://github.com/dogecoin/docker/issues) and [pull requests](https://github.com/dogecoin/docker/pulls) to follow the evolution. +## Quick reference -Help and reviews are welcome :) +- **Maintained by the [Dogecoin community](https://github.com/dogecoin/docker/issues)** +- **Docker Hub images:** https://hub.docker.com/r/dogecoin/dogecoin +- **Dogecoin Core repository:** https://github.com/dogecoin/dogecoin +- **Where to file issues:** https://github.com/dogecoin/docker/issues +- **Supported architectures:** [...] + +## What is this coin with a Doge on it ? +

+ Dogecoin +

+Dogecoin is a community-driven cryptocurrency that was inspired by a Shiba Inu meme. The Dogecoin Core software allows anyone to operate a node in the Dogecoin blockchain networks and uses the Scrypt hashing method for Proof of Work. It is adapted from Bitcoin Core and other cryptocurrencies. + +To get more information about Dogecoin Core, visit the [source code repository](https://github.com/dogecoin/dogecoin). + +## How to use this image + +Start your node in a single command, exposing P2P & RPC ports, mapping the data directory: +```bash +docker run -d --name dogecoin-node \ + -v $(pwd)/datadir:/dogecoin/.dogecoin \ + -p 22555:22555 \ + -p 22556:22556 \ + dogecoin/dogecoin:latest +``` +It will launch the synchronization of the blockchain, which take hours. That's it, your node is up ! + +To verify if the container is running and to get logs: +```bash +docker ps +docker logs dogecoin-node +``` + +Call the JSON-RPC API using the `dogecoin-cli` present inside the container. The help menu will display all existing commands of the API: +```bash +docker exec (--user dogecoin ??) dogecoin-node dogecoin-cli help +``` + +## Syntax & Configuration + +```bash +# Syntax +docker run [docker-options] dogecoin/dogecoin [executable] [executable-options] +``` + ++ `docker-options` : Set environment variables, ports, volumes and other docker settings. ++ `executable` : Choose between `dogecoind`, `dogecoin-cli`, `dogecoin-tx` or `dogecoin-qt`. Default to `dogecoind`. ++ `executable-options` : Pass options directly to the executable. + +There is three ways to configure the Dogecoin node. By using environment variables, by passing arguments to the executable or by providing `dogecoin.conf` in a volume. + +**To see all available configurations, see the `-help` menu from each executable:** +```bash +docker run dogecoin/dogecoin -help +``` + +### Configure with executable arguments + +`docker run` arguments are passed directly to the executable. +```bash +docker run dogecoin/dogecoin -paytxfee=0.01 -testnet +``` + +### Configure with environment variables + +All options for each executable can be defined with environment variables. Variables will be converted to executable arguments. + +```bash +docker run -e PAYTXFEE=0.01 -e TESTNET=1 dogecoin/dogecoin +``` +Environment variables represent executable arguments converted in upper case, and `-` to `_`. +For example, `-help-debug` will be `HELP_DEBUG`. + +### Configure with a configuration file + +`dogecoin.conf` file can be used to configure your node. This file need to be located in the `datadir` of the node. + +Create `dogecoin.conf` with the following content: +``` +testnet=1 +paytxfee=0.01 +``` + +Put this file in the directory mounted to `/dogecoin/.dogecoin`, in `datadir` for this example : +```bash +docker run -v $(pwd)/datadir:/dogecoin/.dogecoin dogecoin/dogecoin +``` + +### Docker Compose + +Example for `docker-compose.yml` : +``` +version: '3.1' + +services: + dogecoin: + image: dogecoin/dogecoin + command: --default-authentication-plugin=mysql_native_password + restart: always + environment: + PAYTXFEE: 0.01 + MAXCONNECTIONS: 150 + ports: + - 22555:22555 + - 22556:22556 +``` +Then, run `docker compose up`. + +## License + +Docker repository for Dogecoin Core is released under [MIT license](https://github.com/dogecoin/docker/blob/main/LICENSE). +Feel free to use, modify & distribute for commercial and non-commercial purpose. + +Please share your improvements & fixes to improve the tool for everyone :) From edcb2096ae43febd078cc48b2fd75144c463940a Mon Sep 17 00:00:00 2001 From: AbcSxyZ Date: Wed, 17 Nov 2021 21:40:58 +0100 Subject: [PATCH 2/9] readme: move image to the top --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 19b1a7c..3ff443b 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,10 @@ -Docker images for Dogecoin -------------------- +

+ Dogecoin +

+ +# Docker images for Dogecoin -### Supported tags and respective `Dockerfile` links +## Supported tags and respective `Dockerfile` links - [`1.14.5`,`latest`](#) @@ -14,9 +17,7 @@ Docker images for Dogecoin - **Supported architectures:** [...] ## What is this coin with a Doge on it ? -

- Dogecoin -

+ Dogecoin is a community-driven cryptocurrency that was inspired by a Shiba Inu meme. The Dogecoin Core software allows anyone to operate a node in the Dogecoin blockchain networks and uses the Scrypt hashing method for Proof of Work. It is adapted from Bitcoin Core and other cryptocurrencies. To get more information about Dogecoin Core, visit the [source code repository](https://github.com/dogecoin/dogecoin). From dd88f118b5179c69c3e4533a0674c4368c7345cb Mon Sep 17 00:00:00 2001 From: AbcSxyZ Date: Wed, 17 Nov 2021 21:44:40 +0100 Subject: [PATCH 3/9] readme: update docker repository link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3ff443b..11470fb 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ ## Quick reference -- **Maintained by the [Dogecoin community](https://github.com/dogecoin/docker/issues)** +- **Maintained by the [Dogecoin community](https://github.com/dogecoin/docker/)** - **Docker Hub images:** https://hub.docker.com/r/dogecoin/dogecoin - **Dogecoin Core repository:** https://github.com/dogecoin/dogecoin - **Where to file issues:** https://github.com/dogecoin/docker/issues From bb4dc19e6973eb4d444a0879588f5e50b324ee12 Mon Sep 17 00:00:00 2001 From: AbcSxyZ Date: Sat, 11 Dec 2021 12:32:19 +0100 Subject: [PATCH 4/9] doc: remove --user for docker exec --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 11470fb..4594d10 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ docker logs dogecoin-node Call the JSON-RPC API using the `dogecoin-cli` present inside the container. The help menu will display all existing commands of the API: ```bash -docker exec (--user dogecoin ??) dogecoin-node dogecoin-cli help +docker exec dogecoin-node dogecoin-cli help ``` ## Syntax & Configuration From be8a5ad8228683648204f1aa0d569eed652c1399 Mon Sep 17 00:00:00 2001 From: AbcSxyZ Date: Sat, 11 Dec 2021 12:38:49 +0100 Subject: [PATCH 5/9] doc: create separate IMAGE_README.md --- IMAGE_README.md | 123 ++++++++++++++++++++++++++++++++++++++++++++++ README.md | 126 +++--------------------------------------------- 2 files changed, 130 insertions(+), 119 deletions(-) create mode 100644 IMAGE_README.md diff --git a/IMAGE_README.md b/IMAGE_README.md new file mode 100644 index 0000000..4594d10 --- /dev/null +++ b/IMAGE_README.md @@ -0,0 +1,123 @@ +

+ Dogecoin +

+ +# Docker images for Dogecoin + +## Supported tags and respective `Dockerfile` links + +- [`1.14.5`,`latest`](#) + +## Quick reference + +- **Maintained by the [Dogecoin community](https://github.com/dogecoin/docker/)** +- **Docker Hub images:** https://hub.docker.com/r/dogecoin/dogecoin +- **Dogecoin Core repository:** https://github.com/dogecoin/dogecoin +- **Where to file issues:** https://github.com/dogecoin/docker/issues +- **Supported architectures:** [...] + +## What is this coin with a Doge on it ? + +Dogecoin is a community-driven cryptocurrency that was inspired by a Shiba Inu meme. The Dogecoin Core software allows anyone to operate a node in the Dogecoin blockchain networks and uses the Scrypt hashing method for Proof of Work. It is adapted from Bitcoin Core and other cryptocurrencies. + +To get more information about Dogecoin Core, visit the [source code repository](https://github.com/dogecoin/dogecoin). + +## How to use this image + +Start your node in a single command, exposing P2P & RPC ports, mapping the data directory: +```bash +docker run -d --name dogecoin-node \ + -v $(pwd)/datadir:/dogecoin/.dogecoin \ + -p 22555:22555 \ + -p 22556:22556 \ + dogecoin/dogecoin:latest +``` +It will launch the synchronization of the blockchain, which take hours. That's it, your node is up ! + +To verify if the container is running and to get logs: +```bash +docker ps +docker logs dogecoin-node +``` + +Call the JSON-RPC API using the `dogecoin-cli` present inside the container. The help menu will display all existing commands of the API: +```bash +docker exec dogecoin-node dogecoin-cli help +``` + +## Syntax & Configuration + +```bash +# Syntax +docker run [docker-options] dogecoin/dogecoin [executable] [executable-options] +``` + ++ `docker-options` : Set environment variables, ports, volumes and other docker settings. ++ `executable` : Choose between `dogecoind`, `dogecoin-cli`, `dogecoin-tx` or `dogecoin-qt`. Default to `dogecoind`. ++ `executable-options` : Pass options directly to the executable. + +There is three ways to configure the Dogecoin node. By using environment variables, by passing arguments to the executable or by providing `dogecoin.conf` in a volume. + +**To see all available configurations, see the `-help` menu from each executable:** +```bash +docker run dogecoin/dogecoin -help +``` + +### Configure with executable arguments + +`docker run` arguments are passed directly to the executable. +```bash +docker run dogecoin/dogecoin -paytxfee=0.01 -testnet +``` + +### Configure with environment variables + +All options for each executable can be defined with environment variables. Variables will be converted to executable arguments. + +```bash +docker run -e PAYTXFEE=0.01 -e TESTNET=1 dogecoin/dogecoin +``` +Environment variables represent executable arguments converted in upper case, and `-` to `_`. +For example, `-help-debug` will be `HELP_DEBUG`. + +### Configure with a configuration file + +`dogecoin.conf` file can be used to configure your node. This file need to be located in the `datadir` of the node. + +Create `dogecoin.conf` with the following content: +``` +testnet=1 +paytxfee=0.01 +``` + +Put this file in the directory mounted to `/dogecoin/.dogecoin`, in `datadir` for this example : +```bash +docker run -v $(pwd)/datadir:/dogecoin/.dogecoin dogecoin/dogecoin +``` + +### Docker Compose + +Example for `docker-compose.yml` : +``` +version: '3.1' + +services: + dogecoin: + image: dogecoin/dogecoin + command: --default-authentication-plugin=mysql_native_password + restart: always + environment: + PAYTXFEE: 0.01 + MAXCONNECTIONS: 150 + ports: + - 22555:22555 + - 22556:22556 +``` +Then, run `docker compose up`. + +## License + +Docker repository for Dogecoin Core is released under [MIT license](https://github.com/dogecoin/docker/blob/main/LICENSE). +Feel free to use, modify & distribute for commercial and non-commercial purpose. + +Please share your improvements & fixes to improve the tool for everyone :) diff --git a/README.md b/README.md index 4594d10..b05f12e 100644 --- a/README.md +++ b/README.md @@ -1,123 +1,11 @@ -

- Dogecoin -

+Dogecoin on Docker +------------------- -# Docker images for Dogecoin +### ⚠️ WARNING: THIS REPOSITORY IS UNDER HEAVY DEVELOPMENT ⚠️ -## Supported tags and respective `Dockerfile` links +Dogecoin docker images, from the community, for the community, with ❤️ -- [`1.14.5`,`latest`](#) +Docker images aren't available for now, work is in progress ! +Check out [issues](https://github.com/dogecoin/docker/issues) and [pull requests](https://github.com/dogecoin/docker/pulls) to follow the evolution. -## Quick reference - -- **Maintained by the [Dogecoin community](https://github.com/dogecoin/docker/)** -- **Docker Hub images:** https://hub.docker.com/r/dogecoin/dogecoin -- **Dogecoin Core repository:** https://github.com/dogecoin/dogecoin -- **Where to file issues:** https://github.com/dogecoin/docker/issues -- **Supported architectures:** [...] - -## What is this coin with a Doge on it ? - -Dogecoin is a community-driven cryptocurrency that was inspired by a Shiba Inu meme. The Dogecoin Core software allows anyone to operate a node in the Dogecoin blockchain networks and uses the Scrypt hashing method for Proof of Work. It is adapted from Bitcoin Core and other cryptocurrencies. - -To get more information about Dogecoin Core, visit the [source code repository](https://github.com/dogecoin/dogecoin). - -## How to use this image - -Start your node in a single command, exposing P2P & RPC ports, mapping the data directory: -```bash -docker run -d --name dogecoin-node \ - -v $(pwd)/datadir:/dogecoin/.dogecoin \ - -p 22555:22555 \ - -p 22556:22556 \ - dogecoin/dogecoin:latest -``` -It will launch the synchronization of the blockchain, which take hours. That's it, your node is up ! - -To verify if the container is running and to get logs: -```bash -docker ps -docker logs dogecoin-node -``` - -Call the JSON-RPC API using the `dogecoin-cli` present inside the container. The help menu will display all existing commands of the API: -```bash -docker exec dogecoin-node dogecoin-cli help -``` - -## Syntax & Configuration - -```bash -# Syntax -docker run [docker-options] dogecoin/dogecoin [executable] [executable-options] -``` - -+ `docker-options` : Set environment variables, ports, volumes and other docker settings. -+ `executable` : Choose between `dogecoind`, `dogecoin-cli`, `dogecoin-tx` or `dogecoin-qt`. Default to `dogecoind`. -+ `executable-options` : Pass options directly to the executable. - -There is three ways to configure the Dogecoin node. By using environment variables, by passing arguments to the executable or by providing `dogecoin.conf` in a volume. - -**To see all available configurations, see the `-help` menu from each executable:** -```bash -docker run dogecoin/dogecoin -help -``` - -### Configure with executable arguments - -`docker run` arguments are passed directly to the executable. -```bash -docker run dogecoin/dogecoin -paytxfee=0.01 -testnet -``` - -### Configure with environment variables - -All options for each executable can be defined with environment variables. Variables will be converted to executable arguments. - -```bash -docker run -e PAYTXFEE=0.01 -e TESTNET=1 dogecoin/dogecoin -``` -Environment variables represent executable arguments converted in upper case, and `-` to `_`. -For example, `-help-debug` will be `HELP_DEBUG`. - -### Configure with a configuration file - -`dogecoin.conf` file can be used to configure your node. This file need to be located in the `datadir` of the node. - -Create `dogecoin.conf` with the following content: -``` -testnet=1 -paytxfee=0.01 -``` - -Put this file in the directory mounted to `/dogecoin/.dogecoin`, in `datadir` for this example : -```bash -docker run -v $(pwd)/datadir:/dogecoin/.dogecoin dogecoin/dogecoin -``` - -### Docker Compose - -Example for `docker-compose.yml` : -``` -version: '3.1' - -services: - dogecoin: - image: dogecoin/dogecoin - command: --default-authentication-plugin=mysql_native_password - restart: always - environment: - PAYTXFEE: 0.01 - MAXCONNECTIONS: 150 - ports: - - 22555:22555 - - 22556:22556 -``` -Then, run `docker compose up`. - -## License - -Docker repository for Dogecoin Core is released under [MIT license](https://github.com/dogecoin/docker/blob/main/LICENSE). -Feel free to use, modify & distribute for commercial and non-commercial purpose. - -Please share your improvements & fixes to improve the tool for everyone :) +Help and reviews are welcome :) From 954cac537d1d7a62ecd5ba9b98fd1a1b94a78548 Mon Sep 17 00:00:00 2001 From: AbcSxyZ <34010605+AbcSxyZ@users.noreply.github.com> Date: Tue, 14 Dec 2021 01:07:17 +0100 Subject: [PATCH 6/9] Improve documentation, suggestions from code review Co-authored-by: Patrick Lodder --- IMAGE_README.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/IMAGE_README.md b/IMAGE_README.md index 4594d10..6b11e6e 100644 --- a/IMAGE_README.md +++ b/IMAGE_README.md @@ -13,7 +13,7 @@ - **Maintained by the [Dogecoin community](https://github.com/dogecoin/docker/)** - **Docker Hub images:** https://hub.docker.com/r/dogecoin/dogecoin - **Dogecoin Core repository:** https://github.com/dogecoin/dogecoin -- **Where to file issues:** https://github.com/dogecoin/docker/issues +**Issue tracker:** https://github.com/dogecoin/docker/issues - **Supported architectures:** [...] ## What is this coin with a Doge on it ? @@ -56,7 +56,11 @@ docker run [docker-options] dogecoin/dogecoin [executable] [executable-options] + `executable` : Choose between `dogecoind`, `dogecoin-cli`, `dogecoin-tx` or `dogecoin-qt`. Default to `dogecoind`. + `executable-options` : Pass options directly to the executable. -There is three ways to configure the Dogecoin node. By using environment variables, by passing arguments to the executable or by providing `dogecoin.conf` in a volume. +There are three ways to configure the Dogecoin node: + +1. by using environment variables, +2. by passing arguments to the executable, +3. by providing a `dogecoin.conf` in a volume. **To see all available configurations, see the `-help` menu from each executable:** ```bash @@ -72,13 +76,16 @@ docker run dogecoin/dogecoin -paytxfee=0.01 -testnet ### Configure with environment variables -All options for each executable can be defined with environment variables. Variables will be converted to executable arguments. +All options, for each executable, can be defined with environment variables. ```bash docker run -e PAYTXFEE=0.01 -e TESTNET=1 dogecoin/dogecoin ``` -Environment variables represent executable arguments converted in upper case, and `-` to `_`. -For example, `-help-debug` will be `HELP_DEBUG`. +Environment variables represent executable arguments converted into upper case, without leading hyphen (`-`). +Any hyphens inside an argument name must be converted to underscores (from `-`, to `_`.) +Note that boolean arguments require the value `1` assigned to the variable. + +For example, the `-help-debug` argument becomes `HELP_DEBUG=1` as environment variable. ### Configure with a configuration file From d1656043da4e4e6af181bbe2547b902762c066c5 Mon Sep 17 00:00:00 2001 From: AbcSxyZ Date: Tue, 14 Dec 2021 01:12:22 +0100 Subject: [PATCH 7/9] image doc: add architectures --- IMAGE_README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/IMAGE_README.md b/IMAGE_README.md index 6b11e6e..993f57d 100644 --- a/IMAGE_README.md +++ b/IMAGE_README.md @@ -14,7 +14,7 @@ - **Docker Hub images:** https://hub.docker.com/r/dogecoin/dogecoin - **Dogecoin Core repository:** https://github.com/dogecoin/dogecoin **Issue tracker:** https://github.com/dogecoin/docker/issues -- **Supported architectures:** [...] +- **Supported architectures:** `amd64`, `arm32v7`, `arm64v8`, `i386` ## What is this coin with a Doge on it ? From 03c4c8f4195ba10935988a4fc5f2a022d53c0362 Mon Sep 17 00:00:00 2001 From: AbcSxyZ Date: Tue, 14 Dec 2021 01:13:09 +0100 Subject: [PATCH 8/9] remove mysql copy/paste error --- IMAGE_README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/IMAGE_README.md b/IMAGE_README.md index 993f57d..9089c78 100644 --- a/IMAGE_README.md +++ b/IMAGE_README.md @@ -111,7 +111,6 @@ version: '3.1' services: dogecoin: image: dogecoin/dogecoin - command: --default-authentication-plugin=mysql_native_password restart: always environment: PAYTXFEE: 0.01 From 902ce6aa71daf5cb1208c227b60b75a8c2434911 Mon Sep 17 00:00:00 2001 From: AbcSxyZ Date: Tue, 14 Dec 2021 01:23:17 +0100 Subject: [PATCH 9/9] image doc: add volume in docker-compose.yml --- IMAGE_README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/IMAGE_README.md b/IMAGE_README.md index 9089c78..f0e922a 100644 --- a/IMAGE_README.md +++ b/IMAGE_README.md @@ -118,6 +118,8 @@ services: ports: - 22555:22555 - 22556:22556 + volumes: + - ./datadir:/dogecoin/.dogecoin ``` Then, run `docker compose up`.