Minimum Machine Specs
- 4GB RAM, 32GB HD (tested on AWS t2.medium, so any similar configuration will work).
- Open ports 4222 and 4221 (HTTP port 80 is useful for inital testing and setup but can be turned off later on).
Remote Server Setup
We provide an automated solution for installing dependencies and general setup for a remote Ubuntu-based server. On your local machine, do:
- git clone email@example.com:connext/vector.git
- cd vector
- SSH_KEY=$HOME/.ssh/id_rsa bash ops/server-setup.sh $SERVER_IP
Manual Server Setup
If you want to set up your server manually (or run the router on your local machine), install the following dependencies:
- make: Probably already installed, otherwise install with brew install make or apt install make or similar.
- jq: Probably not installed yet, install with brew install jq or apt install jq or similar.
- docker: See the for installation instructions.
- Clone the repo: git clone firstname.lastname@example.org:connext/vector.git
- Install root-level dependencies: cd vector && npm i
After this, you should configure your router. Refer to the Configuring a Router section for more info.
The minimum things you need to do for configuration:
- Configure chainProviders for your supported chains
- Configure rebalanceProfiles and allowedSwaps based on your suported assets
- Set messagingUrl to https://messaging.connext.network
- Set production to true
Once you have an appropriate router.config.json in the root directory, run the start script:
If everything starts up and you see Good morning! printed, you are good to go!
Call curl http://localhost:8002/config to see the router's environment.
If the router start script times out, use bash ops/logs.sh node and bash ops/logs.sh node to see possible causes of errors.