Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
shannona authored Oct 7, 2021
1 parent 16f9974 commit e81a055
Showing 1 changed file with 34 additions and 1 deletion.
35 changes: 34 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,17 @@ For more information on *Bitcoin-Standup*:
2. [Why Run a Full Node?](https://github.com/BlockchainCommons/Gordian/blob/master/Docs/Why-Full.md) details why you would want to run a full node in the first place.
3. [Security for Bitcoin-Standup](https://github.com/BlockchainCommons/Gordian/blob/master/Docs/Security.md) offers notes on ensuring the security of your *Bitcoin-Standup* node.

## Status — Work-in-Progress
## Status — Work-in-Progress (0.8)

The *Bitcoin-Standup-Scripts* are updated every year or two for the newest versions of Bitcoin and Debian, and so remain a work-in-progress. We're also working toward improving the modularity of various plug-ins that could be installed.

## Version History

### 0.8.0, October 6, 2021

* Added Cypherpunkpay Installation, courtesy of [@nochiel](https://github.com/nochiel) and sponsorship from [HRF](https://hrf.org/).
* Updated scripts to Bitcoin Core 22.0

## Installation Instructions

There are two linux based StandUp scripts; `StandUp.sh` and `LinodeStandUp.sh`.
Expand Down Expand Up @@ -104,6 +111,32 @@ By default the scripts set up a pruned testnet node and a Tor V3 hidden service
rm -R -f qrcode.png
```

## Installation Instructions Cypherpunkpay

Version 0.8.0 of the Bitcoin Standup Scripts added support for [Cypherpunkpay installation](https://cypherpunkpay.org/). Cypherpunkpay may be installed by inputting four variables:

* USECYPHERPUNKPAY ; set to YES
* CPPLITE ; for a lighter installation, usually set to YES
* XPUB ; the xpub for the wallet where you will receive your funds
* CPPCAUSE ; the title for your Cyperpunkpay donations

If you use the Linode Stackscript, you will be able to set these variables on the Stackscript deployment page; if you use the `.sh` scripts, you must find these lines in the script, uncomment them, and edit them as appropriate (particularly the `XPUB` and `CPPCAUSE` variables).

After running the script, you can verify that Cypherpunkpay is running with `systemctl status cypherpunkpay`:
```
# systemctl status cypherpunkpay
● cypherpunkpay.service - CypherpunkPay
Loaded: loaded (/lib/systemd/system/cypherpunkpay.service; enabled; vendor preset: enabled)
Active: active (running) since Thu 2021-10-07 00:49:18 UTC; 1min 28s ago
Main PID: 9136 (cypherpunkpay)
Tasks: 37 (limit: 4680)
Memory: 63.6M
CPU: 1.404s
CGroup: /system.slice/cypherpunkpay.service
└─9136 /opt/venvs/cypherpunkpay/bin/python /usr/bin/cypherpunkpay
```
Once Cypherpunkpay is running, you will need to [integrate it into your website](https://cypherpunkpay.org/merchant/quick-start/).

## Financial Support

*Bitcoin-Standup* is a project of [Blockchain Commons](https://www.blockchaincommons.com/). We are proudly a "not-for-profit" social benefit corporation committed to open source & open development. Our work is funded entirely by donations and collaborative partnerships with people like you. Every contribution will be spent on building open tools, technologies, and techniques that sustain and advance blockchain and internet security infrastructure and promote an open web.
Expand Down

0 comments on commit e81a055

Please sign in to comment.