ogen

README

Ogen integration/staging tree

Ogen was a divine figure in classical antiquity to be the divine personification of the ocean.

Ogen is the main implementation of the Olympus protocol.

Building

./scripts/build.sh

Documentation

The complete documentation can be found here: https://doc.oly.tech

Run with Docker

Full node with shared storage

This configuration is the best to use as a validator

Pull the image

docker pull ghcr.io/olympus-protocol/ogen-full-node:latest

Run the container

Make sure you replace the LOCAL_HOST_FOLDER on the string to the host folder you want to store your files

docker run -p 80:8080 -p 81:8081 -d -v LOCAL_HOST_FOLDER:/root/.config/ogen ghcr.io/olympus-protocol/ogen-full-node:latest

Now you will have a full-node instance running on the background with a dashboard exposed on port 80, and the REST API exposed on 81, and the full-node files are stored on your host on LOCAL_HOST_FOLDER

Full node without shared storage

This configuration is the best to run a simple full node without having a backup of the keystore.

Pull the image

docker pull ghcr.io/olympus-protocol/ogen-full-node:latest

Run the container

docker run -p 80:8080 -p 81:8081 -d ghcr.io/olympus-protocol/ogen-full-node:latest

Now you will have a full-node instance running on the background with a dashboard exposed on port 80, and the REST API exposed on 81

Run a full node with indexer

This configuration is the best to deploy a full-node with an indexer and a GraphQL API

Pull the image

docker pull ghcr.io/olympus-protocol/ogen-indexer:latest

Run the container

docker run -p 80:8082 -p 81:8080 -d ghcr.io/olympus-protocol/ogen-indexer:latest

Now you will have a full-node instance with an indexer process, and a GraphQL API exposed on port 80 with a dashboard on port 81