Nucypher
/
nucypher
mirror of https://github.com/nucypher/nucypher.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
nucypher/dev/docker
History
Kieran Prasch 2dd3e92868
Shortens CLI flag names to --provider and --teacher. 		2019-07-26 10:14:41 -07:00
..
scripts update scripts 2019-03-28 16:06:16 -07:00
8-federated-ursulas.yml Shortens CLI flag names to --provider and --teacher. 2019-07-26 10:14:41 -07:00
Dockerfile update docker image version and readme 2019-06-06 12:17:41 -07:00
README.md update docker image version and readme 2019-06-06 12:17:41 -07:00
docker-compose.yml reworked docker layout 2019-03-28 15:41:45 -07:00

README.md

Developing with Docker

The intention of the Docker configurations in this directory is to enable anyone to develop and test NuCypher on all major operating systems with minimal prerequisites and installation hassle.

quickstart

  • install Docker
  • install Docker Compose
  • cd to dev/docker (where this README is located)
  • docker-compose up --build this must be done once to complete install

Then you can do things like:

  • run the tests: docker-compose run nucypher-dev pytest

  • start up an ursula: docker-compose run nucypher-dev nucypher ursula run --dev --federated-only

  • open a shell: docker-compose run nucypher-dev bash

  • try some of the scripts in dev/docker/scripts/

*tested on (Ubuntu 16, MacOS 10.14, Windows 10)

From there you can develop, modify code, test as normal.

other cases

  • run a network of 8 independent Ursulas docker-compose -f 8-federated-ursulas.yml up
  • get the local ports these ursulas will be exposed on docker ps
  • to stop them... docker-compose -f 8-federated-ursulas.yml stop

Pycharm (pro version only)

  • You can configure pycharm to use the python interpreter inside docker.
  • docs for this are here