Giter VIP home page Giter VIP logo

core-docker's Introduction

ARK Core - Docker

Development setup

Please run generate-dev.sh in order to generate ARK Core Docker files

bash generate-dev.sh

NOTE

This by default generates all Docker dev files with token ark. If you prefer a different token name, just pass it as an extra argument to the script:

bash generate-dev.sh MyToken

Serve ARK Core as a Collection of Containers

Run a PostgreSQL container, build and run ARK Core using a mounted volume.

During container start your locally cloned ARK Core folder is being mounted inside the container. This configuration works well when developing ARK Core itself, as you do not need to rebuild the container to test your changes.

WARNING The build process expectes your locally cloned ARK Core git folder location to be ~/core or it will fail.

Along with PostgreSQL container, you also have a NodeJS container which mounts your local ARK Core git folder inside the container and installs all NPM prerequisites.

Clone ARK Core repository. Recommended branch to use for development is develop.

git clone https://github.com/ArkEcosystem/core.git -b develop ~/core

Let's build and run the containers:

cd ~/core-docker/development/$NETWORK      # (NETWORK = testnet || devnet)
docker-compose up -d

NOTE Your local core-docker git folder is expected to be at ~/core-docker. This is also important for the build process.

You can now enter your ark-core container and use NodeJS in a Docker container (Linux environment).

docker exec -it $TOKEN-$NETWORK-core bash   # (NETWORK = testnet || devnet, default TOKEN is `ark`)

In case you need to start with a clean Database:

docker-compose down -v postgres
docker-compose up -d postgres

Need to start everything from scratch and make sure there are no remaining cached containers, images or volumes left? Just use the purge_all.sh script.

WARNING Development files/presets are not Production ready. Official Production ARK-Core Docker images are now available at Docker Hub.

Security

If you discover a security vulnerability within this package, please send an e-mail to [email protected]. All security vulnerabilities will be promptly addressed.

Credits

This project exists thanks to all the people who contribute.

License

MIT © ARK Ecosystem

core-docker's People

Contributors

adrian69 avatar renovate[bot] avatar

Watchers

 avatar  avatar  avatar  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.