FrostFS local Development and Testing environment
Find a file
Evgeniy Kulikov a3b2dfbff3 Add S3 Gate
Signed-off-by: Evgeniy Kulikov <kim@nspcc.ru>
2020-12-01 14:18:58 +03:00
.github Add README and related docs 2020-09-25 16:20:34 +03:00
bin Add script to make NeoFS deposit 2020-11-22 07:45:16 +03:00
docs Update docs for preview4 environment 2020-11-18 11:18:17 +03:00
services Add S3 Gate 2020-12-01 14:18:58 +03:00
wallets Reformat wallet for humans to read it 2020-09-29 15:20:19 +03:00
.dockerignore Initial commit 2020-07-10 18:33:27 +03:00
.editorconfig Initial commit 2020-07-10 18:33:27 +03:00
.env Add S3 Gate 2020-12-01 14:18:58 +03:00
.gitignore Initial commit 2020-07-10 18:33:27 +03:00
.services Add S3 Gate 2020-12-01 14:18:58 +03:00
CONTRIBUTING.md Add README and related docs 2020-09-25 16:20:34 +03:00
help.mk Initial commit 2020-07-10 18:33:27 +03:00
LICENSE Initial commit 2020-07-10 18:33:27 +03:00
Makefile Add prepare. make targets for services 2020-11-22 07:45:16 +03:00
README.md Update README and docs 2020-09-29 15:20:19 +03:00

NeoFS

NeoFS local Development and Testing environment


Overview

Tools to set up local NeoFS network and Neo 3 privnet. Devenv, for short.

Quick Start

$ make up

You can see the addresses and hostnames of components with make hosts command.

$ make hosts
192.168.130.10 bastion.neofs.devenv
192.168.130.50 main_chain.neofs.devenv
192.168.130.61 ir01.neofs.devenv
...
192.168.130.74 s04.neofs.devenv

It's recommended to add make hosts output to your local /etc/hosts file.

How it's organized

.
├── Makefile         # Commands to manage devenv
├── .services        # List of services to work with
├── services         # Services definitions and files
│   ├── basenet
│   ├── chain
│   ├── ir
│   ├── morph_chain
│   └── storage
├── vendor           # Temporary files and artifacts
└── wallets          # Wallet files to manage GAS assets

Main commands and targets to manage devenv's services are in Makefile.

Each service is defined in it's own directory under services/ with all required files to run and scripts to get external artifacts or dependencies.

The list of services and the starting order is defined in .services file. You can comment out services you don't want to start or add your own new services.

You can find more information on each service in docs directory.

Contributing

Feel free to contribute to this project after reading the contributing guidelines.

Before starting to work on a certain topic, create an new issue first, describing the feature/topic you are going to implement.

License