Installing and Setting Up Engine
Prerequisites (OSX + Linux)
For Engine to work correctly, it is necessary to download and set up docker.
Once Docker is installed, you will need a Docker "network" named portal:
docker network create portal
Create the directory tree to persist to your local database:
mkdir -P ~/data/shipchain/engine/postgresql
NOTE: Depending on OS settings, some users may encounter permission errors when running Engine. This is commonly due to missing Shared Drives on Windows or File Sharing on Mac. Be sure these are setup to allow access to the /data directory you created.
It is strongly encouraged that you utilize Windows Subsystem for Linux (WSL) when using Docker for Windows. Without this you are very likely to encounter issues with volume mapping permissions in later steps.
Configure WSL with Docker for Windows
Nick Janetakis has a fantastic article on the steps required to get Docker for Windows and WSL working flawlessly. Pay special attention to the Ensure Volume Mounts Work step. Without that your images will not properly build.
Appropriate Directories After following the steps above, in the Ubuntu Bash prompt you should be able to see the your Windows drives mounted at the root level.
/c /c/Users /d
Clone the repository:
git clone https://github.com/ShipChain/engine.git shipchain-engine # If multi-factor authentication is set up on github run this instead git clone firstname.lastname@example.org:ShipChain/engine.git shipchain-engine
Navigate to the
shipchain-engine folder and install the Node packages:
Inside the same
shipchain-engine folder, run this command to start the RPC
bin/dc up rpc
When this note comes up then Engine will be available for use via
info: RPC server listening on 2000
When testing with engine, a very useful tool is postman.
This program allows for direct calls to engine for testing or other usage.
You can import a list of commands to postman from this file: