31 restructue documentation (#138)

* removed korean documentation Signed-off-by: Jürgen Eckel <juergen@riddleandcode.com> * removed CN and KOR readme Signed-off-by: Jürgen Eckel <juergen@riddleandcode.com> * changed to the press theme Signed-off-by: Jürgen Eckel <juergen@riddleandcode.com> * first changes Signed-off-by: Jürgen Eckel <juergen@riddleandcode.com> * fixe H3 vs H1 issues Signed-off-by: Jürgen Eckel <juergen@riddleandcode.com> * added missing png Signed-off-by: Jürgen Eckel <juergen@riddleandcode.com> * added missing file Signed-off-by: Jürgen Eckel <juergen@riddleandcode.com> * fixed warnings Signed-off-by: Jürgen Eckel <juergen@riddleandcode.com> * moved documents Signed-off-by: Jürgen Eckel <juergen@riddleandcode.com> * removed obsolete files Signed-off-by: Jürgen Eckel <juergen@riddleandcode.com> * removed obsolete folder Signed-off-by: Jürgen Eckel <juergen@riddleandcode.com> * removed obs. file Signed-off-by: Jürgen Eckel <juergen@riddleandcode.com> * added some final changes Signed-off-by: Jürgen Eckel <juergen@riddleandcode.com> * removed obs. reference Signed-off-by: Jürgen Eckel <juergen@riddleandcode.com>
2026-03-05 00:28:37 +00:00 · 2022-06-09 15:00:11 +02:00
parent fa2c8a5cc5
commit 4ffd8ca9df
117 changed files with 314 additions and 1139 deletions
--- a/docs/root/source/node-setup/all-in-one-planetmint.md
+++ b/docs/root/source/node-setup/all-in-one-planetmint.md
@@ -0,0 +1,92 @@
+<!---
+Copyright © 2020 Interplanetary Database Association e.V.,
+Planetmint and IPDB software contributors.
+SPDX-License-Identifier: (Apache-2.0 AND CC-BY-4.0)
+Code is Apache-2.0 and docs are CC-BY-4.0
+--->
+
+# Run Planetmint with all-in-one Docker
+
+For those who like using Docker and wish to experiment with Planetmint in
+non-production environments, we currently maintain a Planetmint all-in-one 
+Docker image and a
+`Dockerfile-all-in-one` that can be used to build an image for `planetmint`.
+
+This image contains all the services required for a Planetmint node i.e.
+
+- Planetmint Server
+- MongoDB
+- Tendermint
+
+**Note:** **NOT for Production Use:** *This is an single node opinionated image not well suited for a network deployment.*
+*This image is to help quick deployment for early adopters, for a more standard approach please refer to one of our deployment guides:*
+
+- [Planetmint developer setup guides](https://docs.planetmint.io/projects/contributing/en/latest/dev-setup-coding-and-contribution-process/index.html).
+- [Planetmint with Kubernetes](http://docs.planetmint.io/projects/server/en/latest/k8s-deployment-template/index.html).
+
+## Prerequisite(s)
+- [Docker](https://docs.docker.com/engine/installation/)
+
+## Pull and Run the Image from Docker Hub
+
+With Docker installed, you can proceed as follows.
+
+In a terminal shell, pull the latest version of the Planetmint all-in-one Docker image using:
+```text
+$ docker pull planetmint/planetmint:all-in-one
+
+$ docker run \
+  --detach \
+  --name planetmint \
+  --publish 9984:9984 \
+  --publish 9985:9985 \
+  --publish 27017:27017 \
+  --publish 26657:26657 \
+  --volume $HOME/planetmint_docker/mongodb/data/db:/data/db \
+  --volume $HOME/planetmint_docker/mongodb/data/configdb:/data/configdb \
+  --volume $HOME/planetmint_docker/tendermint:/tendermint \
+  planetmint/planetmint:all-in-one
+```
+
+Let's analyze that command:
+
+* `docker run` tells Docker to run some image
+* `--detach` run the container in the background
+* `publish 9984:9984` map the host port `9984` to the container port `9984`
+ (the Planetmint API server) 
+  * `9985` Planetmint Websocket server
+  * `27017` Default port for MongoDB
+  * `26657` Tendermint RPC server
+* `--volume "$HOME/planetmint_docker/mongodb:/data"` map the host directory
+ `$HOME/planetmint_docker/mongodb` to the container directory `/data`;
+ this allows us to have the data persisted on the host machine,
+ you can read more in the [official Docker
+ documentation](https://docs.docker.com/engine/tutorials/dockervolumes)
+  * `$HOME/planetmint_docker/tendermint:/tendermint` to persist Tendermint data.
+* `planetmint/planetmint:all-in-one` the image to use. All the options after the container name are passed on to the entrypoint inside the container.
+
+## Verify
+
+```text
+$ docker ps | grep planetmint
+```
+
+Send your first transaction using [Planetmint drivers](../connecting/drivers).
+
+
+## Building Your Own Image
+
+Assuming you have Docker installed, you would proceed as follows.
+
+In a terminal shell:
+```text
+git clone git@github.com:planetmint/planetmint.git
+cd planetmint/
+```
+
+Build the Docker image:
+```text
+docker build --file Dockerfile-all-in-one --tag <tag/name:latest> .
+```
+
+Now you can use your own image to run Planetmint all-in-one container.