commit f44666b2a060f31539efbe2404d3b400b7556fa8
parent bb5af9968931fec1d2f905d1918ba11cf78cde08
Author: NicholasFarrow <nicholas.w.farrow@gmail.com>
Date: Sun, 27 Dec 2020 15:22:08 +1100
separate https instructions
Diffstat:
2 files changed, 18 insertions(+), 14 deletions(-)
diff --git a/README.md b/README.md
@@ -52,25 +52,14 @@ Now embed the donation button into your website:
```
## Using a Subdomain with nginx & certbot (HTTPS)
-Embedded iframes are easy if your site only uses HTTP. But if your site uses https, then you can likely see your donation button at `http://YOUR_SERVER_IP:8000/` but not in the embeded iframe. It is best that we create a new subdomain like `btcpyment.yoursite.com` from which we can serve payments. If you use nginx, you can create a new file `/etc/nginx/sites-enabled/BTCpyment`:
-```
-server {
- listen 80;
- server_name btcpyment.YOURWEBSITE.com;
-
- location / {
- proxy_pass http://localhost:8000;
- }
-}
-```
-we can now point our domain `btcpyment.YOURWEBSITE.com` DNS to our server IP and create HTTPS certificates by runnining `certbot`.
-
-You can try provide gunicorn your website's https certificate with the flags `--certfile=cert.pem --keyfile=key.key`. If you use certbot for SSL, your keys are probably in `/etc/letsencrypt/live/`.
+Embedded iframes are easy if your site only uses HTTP. But if your site uses HTTPS, then you can likely see your donation button at `http://YOUR_SERVER_IP:8000/` but not in the embeded iframe. See [HTTPS instructions](docs/HTTPS.md).
# Developers
## You only need a little python!
The main code can be found in `server.py`. invoice and bitcoind handling in `invoice/`, donation button javascript logic in `static/`, button appearance in `template/`. Please have ago at implementing some of the things below!
+More documentation will be added in the near future.
+
# Coming soon:
* Payment API to process payments from any desired point of sale or web shop (woocommerce, shopify)
* Lightning support
diff --git a/docs/HTTPS.md b/docs/HTTPS.md
@@ -0,0 +1,15 @@
+## Using a Subdomain with nginx & certbot (HTTPS)
+Embedded iframes are easy if your site only uses HTTP. But if your site uses HTTPS, then you can likely see your donation button at `http://YOUR_SERVER_IP:8000/` but not in the embeded iframe. It is best that we create a new subdomain like `btcpyment.yoursite.com` from which we can serve payments. If you use nginx, you can create a new file `/etc/nginx/sites-enabled/BTCpyment`:
+```
+server {
+ listen 80;
+ server_name btcpyment.YOURWEBSITE.com;
+
+ location / {
+ proxy_pass http://localhost:8000;
+ }
+}
+```
+we can now point our domain `btcpyment.YOURWEBSITE.com` DNS to our server IP and create HTTPS certificates by runnining the `certbot` command (or whatever else you use).
+
+You could also try provide Gunicorn with your website's HTTPS certificate with the flags `--certfile=cert.pem --keyfile=key.key`. If you use certbot for SSL, your keys are probably in `/etc/letsencrypt/live/`.
