BTC-HyperChat.com is an open source, Bitcoin based, Web application which allows users to get payed (in Bitcoin) to receive and (possibly automatically) handle messages. It was developed to integrate with the streamlabs api but any one using software that allows for 'webhooks' or 'callbacks' can integrate it.
The basic workflow of our app is
- A donor registrates a message with a donation amout with our system.
- We generate an invoice for the user to pay.
- The donor pays the invoice.
- We inform the user that a new donation has been made. This information is given in app, with a push message. Optionally this information is pushed to a webhook setup by the user.
Our application consists of the following components:
- A PostgreSQL database to store data.
- A BtcPay server to track payments. This can be a self hosted or a public instance.
- Our backend. A Rust based API.
- Our frontend. An Angular app as a the user interface
- A Keycloak instance to do user authentication & authorization.
- All components are deployed together by using Docker.
- The application is made accessible through a NGINX server, which has a Let's Encrypt certificate for secure communication.
If you wish to run your own instance we provide a number of scripts to help you setup your instance. For the below instructions we are assuming your are working on some sort of Ubuntu Linux distribution.
For convenience, we support a number of different environments. These are: 'test-testnet', 'accept-testnet', 'accept-live', 'prod-testnet', 'prod-live'
All scripts mentioned below should be run only in the directory they are located in. All scripts expect their target environment to be given as argument. I.e. ./run_application.sh prod-live
Before running these scripts you will need to configure the environment it is going to run on. This is done by editing the .env files so that their values match your environment. (Basically setting your own passwords & server locations.).
You will also need to add some configuration to the files at frontend/angular/src/indexes and frontend/angular/src/environments.
For all 'testnet' environments we use the publicly available Testnet BtcPay server https://testnet.demo.btcpayserver.org. For live environments you will need to setup your own publicly available BtcPay server or use a publicly available one.
Use stack/scripts/install_ubuntu_dependencies.sh to install all packages needed to run & build BTC-HyperChat.com.
Use stack/scripts/setup_fresh_application_data.sh to configure a PostgreSQL docker volume that contains all data needed to start both the backend application & the Keycloak instance
Use stack/scripts/setup_fresh_front_facing_nginx.sh to setup nginx with let's encrypt.
Use stack/scripts/run_application.sh to build all Docker images and start the application.