Git Product home page Git Product logo

satoshi-workbench's Introduction

Satoshi Workbench

A docker workbench environment, pre-configured for running bitcoind.

How to Setup

Before launcing your project in workbench, you will need to setup the environment.

Here is an overview of the project filesystem:

/build       # Contains dockerfiles for building binaries from 
             # source. See `build/BUILD.md` for more details.

/config      # Mounted read-only inside the container at /config.
             # Useful for collecting all of our config files in 
             # one place, so we can tweak them between builds.

/image       # Copied to the container's root filesystem at '/'.
             # Create your desired filesystem in here, using the 
             # proper paths. (for ex. binaries in /image/usr/bin/')

/shared      # Mounted inside the container at /root/share.
             # Scripts placed in 'bin' are added to your PATH 
             # environment. The .init script is loaded at login.

.env.sample  # Example of .env file. Used for setting variables that
             # are passed into the container during build and runtime.

compose.yml  # Configuration file for the container. You can launch in 
             # detached mode by using: 'docker compose up --build -d'

Dockerfile   # Image build script for the container. Feel free to tweak
             # and configure this file to your liking!

README.md    # You are here!

The /image/entrypoint script is called when the container starts. Make sure to configure this for your application!

Tips

  • Use config as a central place to store your needed configuration files.
  • The share folder is reloaded upon login. Feel free to customize your environment frequenlty!
  • Use the share/bin folder to store your own custom scripts (and call them directly).
  • Use the .init and .profile scripts to customize your own shell environment.
  • Feel free to --build frequently as you make changes to the filesystem.
  • Install new apps by modifying the apt install line in your Dockerfile.

How to Use

## Build the image and start in a container.
docker compose build
docker compose up

## Start the container in detached mode.
docker compose up -d

## You can also do all of this in one line.
docker compose up --build -d

## Log into a currently running container.
docker exec -it <container name> bash

## If you have any issues with your startup script,
## run it from within the container for easy debugging.
docker compose run -it --entrypoint bash <container name>
<~/root#> /entrypoint.sh

Resources

Docker Compose Reference
https://docs.docker.com/compose/compose-file

Docker Builder Reference
https://docs.docker.com/engine/reference/builder

Docker Exec Reference
https://docs.docker.com/engine/reference/commandline/exec

satoshi-workbench's People

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.