Skip to content

Latest commit

 

History

History
93 lines (60 loc) · 3.63 KB

README.md

File metadata and controls

93 lines (60 loc) · 3.63 KB
Raw

0rora - Stellar Payment Manager

by Jem Mawson

Travis Coverage Chat Issues

0rora is a web application for easily making and scheduling Stellar payments in bulk.

With 0rora you can:

  • schedule future payments;
  • distribute your custom tokens en masse; and
  • view reports of past and future payments.

0rora makes use of payment channels and batching to achieve maximum throughput, so you get the fastest performance possible.

You are free to copy, modify, and distribute 0rora with attribution under the terms of the MIT license.

Installation

  1. Create an empty Postgres Database.

For example, you may create a Postgres docker container and create your empty database therein.

docker run --name 0rora_pg -e POSTGRES_PASSWORD=admin_password -d -p "5432:5432" postgres
cat << EOF | docker exec -i 0rora_pg /usr/bin/psql -U postgres
  create database orora;
  create user ford with encrypted password 'pr3fekt';
  grant all privileges on database orora to ford;
EOF
  1. Run the 0rora docker image, passing environment values for your database.
docker run -p 9000:9000 \
    -e HORIZON="test" \
    -e PG_URL="jdbc:postgresql://host:port/db" \
    -e PG_USERNAME="ford" \
    -e PG_PASSWORD="pr3fekt" \
    -e APPLICATION_SECRET=... \
    synesso/0rora:latest
  • HORIZON determines the Horizon instance to connect with. It may be "test", "public" or the base URL of any custom Horizon instance.
  • PG_URL is the JDBC URL of your database.
  • PG_USERNAME is username for your database.
  • PG_PASSWORD is password for your database.
  • APPLICATION_SECRET is a random, 32-byte minimum value for managing session cookies and CSRF tokens. See PlayFramework documentation on the application secret for more detail.

Documentation

See the changelog for details of features in the next and current releases.

Further detail on how to install and use 0rora is available under the docs folder.

Future Work

0rora has many planned features on its road to being a fully-fledged Stellar payment manager and gateway. These include:

  • Receiving payments through event integration points, such as AMQP
  • Netting payments
  • Holding payments for manual validation
  • Account and channel management
  • User management and permissions

Users of 0rora are encouraged to help prioritise future work. Contact the project via chat or github.

Contributing

Suggest new features, or raise bug reports in the issuer tracker.

Chat about 0rora in Gitter.

Help is warmly welcomed and pull requests in any area, big or small, are greatly appreciated.

If 0rora has been helpful and you'd like to donate, the address is Donate