commit 595aa1c260abca02812e42e1a519ce8ed9cb4872
parent 58f5d6dc6b595fce7c6b7f8b55be6c33470d6dcb
Author: NicholasFarrow <nicholas.w.farrow@gmail.com>
Date: Sun, 27 Dec 2020 11:00:58 +1100
installation process
Diffstat:
2 files changed, 29 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
@@ -2,10 +2,35 @@
Existing non-custodial Bitcoin payment processors are bloated and difficult for the average person to install. BTCPyment strives to exist as an easily deployable, highly customisable, lightweight Bitcoin payment processor that keeps your coins with your keys. Almost purely written in Python and Javascript, BTCPyment makes donation buttons simple; via a simple embedded iframe that talks to your own Bitcoin node via Flask websockets.
# Installation
-## Deploy Server
-This should be easy to install.
-## Insert HTML Donation Button
+## Install
+Clone and install dependencies
+```
+git clone https://github.com/nickfarrow/BTCPyment
+pip install -r requirements.txt
+```
+## Connect to your Bitcoin Node
+Edit the `config.py` configuration and point to your Bitcoin node:
+```python
+host = "127.0.0.1"
+rpcport = "8332"
+username = "bitcoinrpc"
+password = "RPCPASSWORD"
+```
+(You can find these in `~/.bitcoin/bitcoin.conf`). If your node is remote to your website, you can specify an ssh `tunnel_host = "pi@192.168.0.252"`.
+## Run BTCPyment
+Run server with
+```
+cd BTCPyment/
+gunicorn --worker-class eventlet -w 1 server:app
+```
+That's it! You should now be able to view your BTCPyment server at http://YOUR_SERVER_IP:8000/. If running locally, this will be `127.0.0.1:8000`.
+
+## Embed Donation Button
+Now embed the donation button into your website
+```html
+<iframe src="http://YOUR_SERVER_IP:8000/" style="margin: 0 auto;display:block;height:300px;border:none;overflow:hidden;" scrolling="no"></iframe>
+```
# Features
* Lightweight, Python and Javascript talk to your own bitcoin node via websockets and ssh.
diff --git a/templates/index.html b/templates/index.html
@@ -106,7 +106,7 @@
</div>
<div id="information" style="text-align: right; padding: 0;">
- <p><a id="about" href="https://github.com/nickfarrow/BTCPyment" target="_blank">About</a></p>
+ <p><a id="about" href="https://github.com/nickfarrow/BTCPyment" target="_blank">BTCPyment</a></p>
</div>
<div id="paybutton"></div>
