docker/vapord/README.md

   1 # quick start
   2
   3 execute ./docker/vapord/deploy.sh from the root of vapor repo.
   4
   5 every vapord image has a unique public key, always create only one instance per image, otherwise you would end up with multiple nodes with same public key.
   6
   7 ## print usage
   8
   9 ```bash
  10 bash ./docker/vapord/deploy.sh --help
  11 ```
  12
  13 ## build and run 2 vapor nodes
  14
  15 ```bash
  16 bash ./docker/vapord/deploy.sh --scale=2
  17 ```
  18
  19 ## list available node images and public keys
  20
  21 ```bash
  22 bash ./docker/vapord/deploy.sh --list
  23 ```
  24
  25 ## remove all node images
  26
  27 ```bash
  28 bash ./docker/vapord/deploy.sh --rm-all
  29 ```
  30
  31 ## remove 2 node images
  32
  33 ```bash
  34 bash ./docker/vapord/deploy.sh --rm=vapord_test-ade32,vapord_test-342de
  35 ```
  36
  37 ## build 2 node images (build only)
  38
  39 ```bash
  40 bash ./docker/vapord/deploy.sh --build=2
  41 ```
  42
  43 ## run 2 vapor nodes instances from existing images
  44
  45 ```bash
  46 bash ./docker/vapord/deploy.sh --run=vapord_test-ade32,vapord_test-342de
  47 ```
  48
  49 ## run vapor node instances from all existing images
  50
  51 ```bash
  52 bash ./docker/vapord/deploy.sh --run-all
  53 ```
  54
  55 ## bring down running node instances
  56
  57 ```bash
  58 bash ./docker/vapord/deploy.sh --down
  59 ```
  60
  61 ## node naming
  62
  63 * id: first 5 chars of public key
  64 * node_name : vapord-${id}
  65 * image name: vapord_test-${id}:latest
  66 * wallet port : start from 9889, and increases by 1 every time a new node image is created.
  67 * log location: ~/vapord/log/${node_name}
  68 * docker-compose.yml location: ~/vapord/docker-compose.yml
  69
  70 ## customize
  71
  72 * config.toml and federation.json are provided for reference only. They should be modified for your own test env.