obol-stack

README

 

The Obol Stack: Decentralised Applications For Ethereum

Overview

The Obol Stack is a framework to make it easier to distribute decentralised applications (dApps), and easier to install and run them locally. The stack is built on Kubernetes, with Helm as a package management system.

Getting Started

[!IMPORTANT] The Obol Stack is alpha software. It is not complete, and it may not be working smoothly. If you encounter an issue that does not appear to be documented, please open a github issue if an appropriate one is not already present.

See here for the latest on OS and architectures supported.

Pre-requisites

Running the Obol Stack locally requires a Docker engine. Install Docker for Linux using one of the options here. Install Docker Desktop for Other Operating Systems here.

[!TIP] If you use Docker Desktop, be sure to go to the settings section, resources tab, and allocate most or all of your CPUs and most of your disk space. The stack won't succeed in syncing a local L1 node if there is not enough available disk space.

Once you have Docker installed, the easiest way to bootstrap the stack is to use the obolup installer. obolup keeps your stack running the latest versions of its software.

[!IMPORTANT] This first method of installation is not yet live, for now you must clone the repo and run obolup locally, as described in the second installation option.

# This mode of installation is not yet live, please use the repo clone approach until this message is removed

# Add the `obolup` program to your path
curl -L https://stack.obol.org | sudo bash

# Reload your terminal, and run `obolup`
obolup

You can also clone this repo locally and run:

# Clone this repo
git clone git@github.com:ObolNetwork/obol-stack.git

# Change to ./obolup subdirectory
./obolup.sh

This will install the obol binary in the users ~/.local/bin. It should be available in the users path pending a new terminal session, otherwise run source ~/.profile to manually export it in the current session.

To initialise a stack

obol stack init

This will install the default configuration to ~/.config/obol which contains a series of helmfiles/charts which users can edit to suit their needs.

To spin up the stack:

obol stack up

Project Status

This project is currently in alpha, and should not be used in production.

The stack aims to support all popular Kubernetes backends and all Ethereum client types, with a developer experience designed to be useful for local app development, through to production deployment and management.

Contributing

Please see CONTRIBUTING.md for details.

License

This project is licensed under the Apache License 2.0.