Skip to main content

Running pryzmd with Docker

To simplify the deployment and orchestration of the 'pryzmd blockchain network, Docker can be used. This guide outlines the steps required to run 'pryzmd using Docker and Docker Compose.

Prerequisites​

Before proceeding with running 'pryzmd` with Docker Compose, ensure that the following prerequisites are met:

Pryzmd Image

Before running the container you need to have the docker image in place. you can build your own docker image by following the guideline at building pryzm docker or download the official docker image from the following repo.

docker pull europe-docker.pkg.dev/pryzm-zone/core/pryzmd:0.18.0

Docker​

To run 'pryzmd` with Docker, you need to provide a valid configuration path. the configuration file path will contain essential config files for running pryzm. the following is a sample docker run command:

this example is persisting the config file but not the data use this example only for tests

docker run --name=pryzmd --network-mode=host --restart=always -v ./pryzmd/config:/home/pryzm/.pryzmd/config europe-docker.pkg.dev/pryzm-zone/core/pryzmd/0.18.0

this example persists all the data and config on the host

docker run --name=pryzmd --network_mode=host --restart=always -v ./pryzmd/:/home/pryzm/.pryzmd/ europe-docker.pkg.dev/pryzm-zone/core/pryzmd/0.18.0

you can start interacting with you pryzmd whether by executing commands inside the container or by connecting to its api port.

Docker Compose​

To run 'pryzmdwith Docker Compose, you need to provide a validdocker-compose.ymlconfiguration file. Thedocker-compose.yml file contains the necessary configurations for running the 'pryzmd container and any associated services.

Running 'pryzmd` with Docker Compose​

Once you have the appropriate docker-compose.yml configuration file ready, follow these steps to run 'pryzmd` with Docker Compose:

  1. Open a terminal and navigate to the directory containing the docker-compose.yml file.

  2. Run the following command to start the 'pryzmd` container:

    $ docker-compose up -d

    The -d flag runs the containers in detached mode, allowing them to continue running in the background.

  3. Docker Compose will start the 'pryzmdcontainer and any associated services specified in thedocker-compose.yml` file.

  4. Verify that the 'pryzmd` container is running successfully by checking its status:

    $ docker-compose ps

    This command will display the status of the 'pryzmd` container and any associated services.

Accessing 'pryzmd`​

Once the 'pryzmdcontainer is running with Docker Compose, you can access it according to the network configuration specified in thedocker-compose.yml file. Please refer to the project's documentation or consult the developers for information on how to access and interact with 'pryzmd in your specific environment.

Stopping 'pryzmd`​

To stop the 'pryzmd` container and associated services, use the following command:

$ docker-compose down

This command will gracefully stop the containers and remove the associated resources.

Conclusion​

By following this guide, you should be able to run 'pryzmd` using Docker Compose, simplifying the deployment and orchestration of the blockchain network.