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.
Follow Docker installation instructions here: docker Follow Docker Compose installation steps here: docker compose
Add the newly created user to the Docker group so that the user can access Docker API:
usermod -aG docker appsu - 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
echo 'source ~/.rvm/scripts/rvm' >> ~/.bashrc
source ~/.bashrc
cd opendax
rvm install .gem install bundler
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!
All the OpenDAX deployment files have their confguration stored in config/app.yml.
Feel free to fill it out with correct values:
| Parameter | Description |
|---|---|
app.name |
Global application name |
app.domain |
Base domain name to be used |
ssl.enabled |
Enable SSL certificate generation |
ssl.email |
Email address to use for SSL generation requests |
images |
Application images tags |
vendor |
Frontend application Git repo URL |
render_protect |
Enable read-only mode for rendered files |
Twilio SMS service is disabled by default, feel free to enable it in the `twilio` section of the config
Note: You can protect all the rendered files from being edited so that you wouldn't lose your changes upon re-rendering templates in the future by setting `render_protect` to `true`
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, 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!
You can run Vault in two modes: development and production. You can set it in the vault.mode field of app.yml.
The main differences are:
- Development mode Everything is stored in memory, thus all API keys and 2FA tokens are lost on every container restart.
- Production mode Everything is persisted on the local filesystem, thus API keys and 2FA tokens are preserved between restarts. However, Vault needs to be unsealed after every stop/restart.
To setup Vault in production mode, go through the following steps:
docker-compose exec vault shvault operator init- Save the output to a file in a secure place
- Unlock Vault with three different unlock keys -
vault operator unseal *unseal_key* vault login *root_token*vault secrets enable totpvault secrets disable secretvault secrets enable -path=secret -version=1 kv
Add the Vault root token to config/app.yml, render the configs and start the app services.
Afterwards, Vault should be fully configured and ready to work with Peatio and Barong.
For development mode Vault setup you don't have to perform any actions.
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
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 have any comments, feedback and suggestions, we are happy to hear from you here at GitHub or at openware.com