Guide | API Docs | Consulting | Community
OpenDAX is an open-source cloud-native multi-service platform for building a Blockchain/FinTech exchange of digital assets, cryptocurrency and security tokens.
Minimum VM requirements for OpenDAX:
- 8GB of RAM (12GB recommended)
- 4 cores vCPU (6 cores recommended)
- 300GB disk space (SSD recommended)
A VM from any cloud provider like DigitalOcean, Vultr, GCP, AWS as well as any dedicated server with Ubuntu, Debian or Centos would work
SSH using root user, then create new user for the application
useradd -g users -s `which bash` -m appWe highly recommend using docker and compose from docker.com install guide instead of the system provided package, which would most likely be deprecated.
Docker follow instruction here: docker Docker compose follow steps: docker compose
su - appgit clone https://github.com/openware/opendax.gitgpg --keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB
curl -sSL https://get.rvm.io | bash -s stable
cd opendax
rvm install .bundle install
rake -T # To see if ruby and lib worksUsing rake -T you can see all available commands, and can create new ones in lib/tasks
If using a VM you can point your domain name to the VM ip address before this stage.
Recommended if you enabled SSL, for local development edit the /etc/hosts
Insert in file /etc/hosts
0.0.0.0 www.app.local
rake service:allYou can login on www.app.local with the following default users from seeds.yaml
Seeded users:
Email: [email protected], password: 0lDHd9ufs9t@
Email: [email protected], password: Am8icnzEI3d!
In order to accelerate customer interaction, reduce risks and simplify business processes you can use KYC Verification Service from KYCaid. KYC goal is to prevent fraud and to decline users that don’t fulfill certain standards of credibility. To learn more about KYCaid and pricing you can visit their website - kycaid.com
KYCAID is already integrated into our stack, to use it you'd need to create an account on kycaid.com, and set up authentification creds there and the callback url: https://example.com/api/v2/barong/public/kyc
After that all you have to do is to change several lines in config/app.yml:
kyc:
provider: kycaid
authorization_token: changeme # your production API token from the 'Settings' section of kycaid.com
sandbox_mode: true # 'true' for test environments - documents will be verified/rejected automatically, without payment for verification
api_endpoint: https://api.kycaid.com/- Be sure to check
BARONG_REQUIRED_DOCS_EXPIREENV value insideconfig/barong.envto befalseif you want to includeaddressverification in your KYC process. You can set it totrueif you need the document check only. - Check if you have the correct list of
document_typesin theconfig/barong/barong.ymlfile:- Passport
- Identity card
- Driver license
- Address
- Frontend KYC steps can be configured in
templates/config/frontend/env.js.erbvia thekycStepsfield - Tower KYC labels can be configured in
templates/config/frontend/tower.js.erbvia thelabelSwitcherfield
All the OpenDAX deployment files have their confguration stored in config/app.yml.
The following table lists the configurable parameters of the config/app.yml configuration file and its default values.
| Parameter | Description | Default |
|---|---|---|
app.name |
global application name | "OpenDax" |
app.domain |
base domain name | app.local |
app.subdomain |
subdomain | www |
app.show_landing |
enable/disable landing page display for the frontend application | true |
render_protect |
enable read-only mode for rendered files | false |
csrfEnabled |
enable CSRF protection on Barong | false |
ssl.enabled |
enable SSL certificate generation | false |
ssl.email |
email address used for SSL certificate issuing | "[email protected]" |
updateVersions |
update all image tags by fetching global ones for OpenDAX | false |
images |
Docker image tags per component | |
vendor.frontend |
optional Git URL for a development frontend repo | [email protected]:openware/baseapp.git |
kyc.provider |
KYC provider, can be kycaid or local |
kycaid |
kyc.authorization_token |
optional API token for KYCAID use | changeme |
kyc.sandbox |
enable KYCAID test mode | true |
kyc.api_endpoint |
API endpoint for KYCAID | https://api.kycaid.com/ |
vault.root_token |
Root Vault authentication token | changeme |
vault.peatio_rails_token |
Peatio Server Vault authentication token | changeme |
vault.peatio_crypto_token |
Peatio Daemons (cron_job, deposit, deposit_coin_address, withdraw_coin) Vault authentication token | changeme |
vault.peatio_upstream_token |
Peatio Upstream Daemon Vault authentication token | changeme |
vault.peatio_matching_token |
Peatio Daemons (matching, order_processor, trade_executor) Vault authentication token | changeme |
vault.barong_token |
Barong Vault authentication token | changeme |
vault.finex_engine_token |
Finex Engine Vault authentication token | changeme |
database.adapter |
database adapter kind either mysql or postgresql |
mysql |
database.host |
database host name | db |
database.port |
database port | 3306 |
database.user |
database username | root |
database.password |
database root password | changeme |
storage.provider |
object storage provider | "Google" |
storage.bucketname |
storage bucket name | "opendax-barong-docs-bucket" |
storage.endpoint |
S3-compatible storage API endpoint | "https://fra1.digitaloceanspaces.com" |
storage.region |
storage region | "fra1" |
storage.signatureVersion |
S3-compatible storage API signature version(2 or 4) | "fra1" |
storage.secretkey, storage.accesskey |
storage access keys | "changeme" |
twilio |
Twilio SMS provider configs | |
gaTrackerKey |
Google Analytics tracker key inserted into the frontend app | |
smtp |
SMTP configs used for sending platform emails | |
captcha |
captcha configuration(Recaptcha or Geetest) | |
wallets |
configs for wallets seeded during the initial deployment of Peatio | |
parity |
Parity cryptonode configuration | |
bitcoind |
Bitcoind cryptonode configuration | |
litecoind |
Litecoind cryptonode configuration | |
terraform.credentials |
local path to a GCP service account JSON key | "~/safe/opendax.json" |
terraform.project |
GCP project name | "example-opendax" |
The following table lists configurable parameters of the config/utils.yml file:
| Parameter | Description | Default |
|---|---|---|
| images | Docker image tags per component | |
| superset | Superset BI tool configs | |
| arke | Arke liquidity bot configs |
Once you're done with the configuration, render the files using rake render:config. You can easily apply your changes at any time by running this command.
Note: be sure to append all the subdomains based on app.domain to your
/etc/hosts file if you're running OpenDax locally
The OpenDAX stack can be brought up using two ways:
- Bootstrap all the components at once using
rake service:all[start] - Start every component one-by-one using
rake service:*component*[start]
The components included in the stack are:
proxy- Traefik, a robust cloud-native edge router/reverse proxy written in Gobackend- Vault, MySQL, Redis and RabbitMQ grouped togethercryptonodes- cryptocurrency nodes such as parity [Optional]daemons- Peatio and Ranger daemons [Optional]setup- setup hooks for Peatio and Barong to run before the application starts (DB migration etc.)app- Peatio is the crypto exchange software, Barong and the Ambassador API gatewayfrontend- the frontend application located atvendor/frontendtower- the Tower admin panel application located atvendor/towermonitoring- cAdvisor and Node Exporter monitoring tools [Optional]
For example, to start the backend services, you'll simply need to run rake service:backend[start]
Note: all the components marked as [Optional] need to be installed using
rake service:*component*[start] explicitly
Go ahead and try your own OpenDAX exchange deployment!
Any component from the stack can be easily stopped or restarted using rake service:*component*[stop] and rake service:*component*[restart].
For example, rake service:frontend[stop] would stop the frontend application container and rake service:proxy[restart] would completely restart the reverse proxy container.
Each component has a config file (ex. config/frontend/tower.js) and a compose file (ex. compose/frontend.yaml).
All config files are mounted into respective component container, except from config/app.yml - this file contains all the neccessary configuration of opendax deployment
Compose files contain component images, environment configuration etc.
These files get rendered from their respective templates that are located under templates directory.
Modify config/app.yml with correct image and run rake service:all
This will rerender all the files from templates directory and restart all the running services.
Alternitavely you can update the following files:
config/app.ymltemplates/compose/*component*.ymlcompose/*component*.ymlAnd runrake service:component[start]
Modify config/*component*/*config* and run rake service:component[start],
if you want the changes to be persistent, you also need to update templates/config/*components*/*config*
# Delete all generated files
git clean -fdx
# Re-generate config from config/app.yml values
rake render:config
# Restart the container you need to reload config
docker-compose up frontend -Vd
source ./bin/set-env.sh
rake vendor:clone
docker-compose -f compose/vendor.yaml up -d
Opendax uses Vault Policies to restrict components' access to sensitive data. Each component has its own Vault token which allows granular access only to the data required.
OpenDAX has 2 rake tasks for Vault management:
rake vault:setup # Initial Vault configuration (root token generation, unseal, endpoints configuration)
rake vault:load_policies # Components' Vault token generationIn case of such error:
- Run
rake vault:setup - Restart the component
Make sure you're not using an existing Docker volume for Vault(i.e. one left after a different Vault container deployment):
docker volume ls | grep vaultIn case there are existing volumes, remove the running Vault container via docker rm -f *id* and run docker volume rm -f *volume name*
Afterward, run docker-compose up -Vd vault and re-run rake vault:setup.
Usually, this means that one of your Vault tokens has expired.
To fix the issue:
-
Run
rake vault:load_policies -
Run
rake render:config -
Restart Vault dependant components:
docker-compose up -Vd barong peatio cron_job deposit deposit_coin_address withdraw_coin upstream # If you are using Finex docker-compose up -Vd finex-engine # If you are using Peatio Matching Engine docker-compose up -Vd matching order_processor trade_executor
You can easily deploy OpenDAX from scratch on Google Cloud Platform using Terraform!
To do this, just follow these simple steps:
- Fill
app.ymlwith correct values - Run
rake terraform:apply - Access your VM from the GCP Cloud Console
To destroy the provisioned infrastructure, just run rake terraform:destroy
ruby -e "$(curl -fsSL https://raw.githubusercontent.com/openware/opendax/master/bin/install)"
If you'd like to use a real API from an existing OpenDAX deployment when developing frontend components(e.g. baseapp), modify templates/config/gateway/envoy.yaml.erb file the following way:
-
Set
allow_originas"*" -
Configure all the needed HTTP methods in
allow_methods. For example:allow_methods: "PUT, GET, POST, DELETE, PATCH" -
Add
'total, page, x-csrf-token'toallow_headersvalue -
Configure
expose_headersin a similar wayexpose_headers: "total, page, x-csrf-token" -
Add
allow_credentials: trueto your CORS configuration
After completing these steps, you should have the following config:
cors:
allow_origin:
- "*"
allow_methods: "PUT, GET, POST, DELETE, PATCH"
allow_headers: "content-type, x-grpc-web, total, page, x-csrf-token"
expose_headers: "total, page, x-csrf-token"
allow_credentials: true
Afterwards, apply the config onto your deployment:
rake render:config
docker-compose up -Vd gateway
If you have any comments, feedback and suggestions, we are happy to hear from you here at GitHub or here: crypto exchange software
To migrate from 2.5 to 2.6, do the following:
- Pull 2-6-stable branch
While rebasing, rename your
vault.tokentovault.root_tokeninconfig/app.yml - Run
rake render:config - Run
dc up -Vd vault - Run
rake service:all
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent
