Skip to content
This repository has been archived by the owner on Mar 11, 2024. It is now read-only.

TBD54566975/sidetree-ion

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sidetree ION

This repository contains both ION and Sidetree, along with a Dockerfile to create a Docker image for the Ion project that depends on the Sidetree project.

.
├── ion/
│   ├── ... (Ion project files and directories)
├── sidetree/
│   ├── ... (Sidetree project files and directories)
└── Dockerfile

Dockerfile Overview

The Dockerfile does the following:

  • Builds the Sidetree project by installing its dependencies, copying the source code, running the build process, and creating a tarball using npm pack.
  • Builds the Ion project by installing its dependencies, copying the Sidetree tarball from the previous stage, installing the Sidetree package from the tarball, copying the Ion source code, and running the build process.
  • Creates the final Ion image by installing the production dependencies and copying the built Ion project from the previous stage.

Building the Docker Image

docker buildx build --platform linux/amd64 -f ./Dockerfile -t ion:1.0.x . --load

After building the image, you can run a container from it and test the application as needed.

To Test Locally

After building the image from the top level dockerfile, recall the tag that you generated for it.

In /ion/docker/docker-compose.yml change the image: to be your tag, eg - image: ion:1.0.6

To start ion with your local image running on the testnet run:

docker-compose -f docker-compose.yml -f docker-compose.testnet-override.yml up --build

To start ion with your local image running on the mainnet run:

docker-compose up --build

To have the local image running on the testnet run in read only mode: change the config value in

  # ion/docker/docker-compose.testnet-override.yml/
    - ION_CORE_CONFIG_FILE_PATH=/config/docker-testnet-core-readonly-config.json

then start as normally


To start ion with your local image running on the mainnet run in read only mode: change the config value in

# ion/docker/docker-compose.yml/
    - ION_CORE_CONFIG_FILE_PATH=/config/docker-mainnet-core-readonly-config.json

then start as normally

Releases

No releases published

Packages

 
 
 

Languages

  • TypeScript 82.5%
  • HTML 11.4%
  • JavaScript 3.9%
  • CSS 1.9%
  • Shell 0.3%