Peatio is a free and open-source crypto currency exchange implementation with the Rails framework. This is a fork of Peatio designed for micro-services architecture. We have simplified the code in order to use only Peatio API with external frontend and server components.
To build your own exchange you should now run Peatio as a backend instead of forking the repository, and extend it using other microservices such as Barong.
Our mission is to build an open-source crypto currency exchange with a high performance trading engine and incomparable security. We are moving toward dev/ops best practices of running an enterprise grade exchange.
We provide webinar or on site training for installing, configuring and administration best practices of Peatio. Feel free to contact us for joining the next training session: Openware.com
Help is greatly appreciated, feel free to submit pull-requests or open issues.
RUNNING AN EXCHANGE IS HARD.
This repository is not a turn key solution and will require engineering and design of security process by your company, with or without our assistance. This repository is one component among many we recommend using for composing an enterprise grade exchange. It is highly recommended to deploy a UAT environment and build automated tests for your needs, including Functional tests, Smoke tests and Security vulnerability scans. You may not need to have an active developer on Peatio source code, however, we recommend the following team setup: 1 dev/ops, 3 frontend developers (react / angular), 2 QA engineers, 1 Security Officer.
SECURITY KNOWLEDGE IS A REQUIREMENT.
Peatio cannot protect your customers if you leave your admin password 1234567, or open sensitive ports to public internet. No one can. Running an exchange is a very risky task because you're dealing with money directly. If you don't know how to make your exchange secure, hire an expert.
You must know what you're doing, there's no shortcut. Please get prepared before you continue:
Please see CONTRIBUTING.md for details on how to contribute issues, fixes, and patches to this project.
We advice to use minimalistic environment if you want to develop only Peatio and don't touch processes which interact with other components.
Otherwise we advice to use microkube based environment
god -c lib/daemons/daemons.god
127.0.0.1 www.app.local 127.0.0.1 peatio.app.local 127.0.0.1 barong.app.local
JWT_PUBLIC_KEY=$(cat config/secrets/rsa-key.pub| base64 -w0) rails s -b 0.0.0.0(
base64 -b0for macOS)
We suggest you to start using Peatio by installing Microkube. Microkube which is based on Docker containers is a convenient and straightforward way to start Peatio development environment.
Follow microkube README for the best Peatio installation experience.
Workbench is legacy way for running Peatio locally. Probably Workbench support will be removed soon. We advice to use Microkube which is more lightweight environment.
Barong is an essential part of Rubykube Peatio. It is a KYC OAuth 2.0 provider. Barong replace the KYC, 2FA, Phone verification from legacy Peatio. Barong manage roles and kyc level across all applications from the RKCP. It's easy to extend by using the EventAPI or Rest API.
> docker-compose run --rm barong bash -c "./bin/link_config && ./bin/setup" > docker-compose up -d barong
This will output password for [email protected]. Default password is
Start peatio server
> docker-compose run --rm peatio bash -c "bundle exec rake db:create db:migrate db:seed" > docker-compose up -d peatio
After all of that you can start using Peatio in your browser just by following one of the hosts which you added earlier.
You can interact with Peatio through API:
We want to make it super-easy for Peatio users and contributors to talk to us and connect with each other, to share ideas, solve problems and help make Peatio awesome. Here are the main channels we're running currently, we'd love to hear from you on one of them:
This is for all Peatio users. You can find guides, recipes, questions, and answers from Snowplow users including the Peatio.tech team. We welcome questions and contributions!
Chat with us and other community members on Telegram.
If you spot a bug, then please raise an issue in our main GitHub project (rubykube/peatio); likewise, if you have developed a cool new feature or improvement in your Rubykube Peatio fork, then send us a pull request! If you want to brainstorm a potential new feature, then the Rubykube Discourse Forum (see above) is probably a better place to start.
If you want to talk directly to us (e.g. about a commercially sensitive issue), email is the easiest way.
If you need help with running/deploying/customizing Peatio, you can contact us on Openware.com.
Contact us by email: [email protected]
Peatio is released under the terms of the MIT license.
Peatio (Chinese: 貔貅) is a Chinese mythical hybrid creature considered to be a very powerful protector to practitioners of Feng Shui.
[This illustration copyright for Peatio Team]