Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update Drupal Readme #30

Merged
merged 4 commits into from
Sep 9, 2024
Merged

Update Drupal Readme #30

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
77a3773
update readMe
TChukwuleta Jul 31, 2024
21d634b
reviewed Readme
TChukwuleta Aug 3, 2024
eecd48c
Update README.md
TChukwuleta Sep 5, 2024
497006b
Update README.md
TChukwuleta Sep 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 36 additions & 35 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,15 @@
# Commerce BTCPay
# Accept Bitcoin on your Drupal Commerce Store using BTCPay Server

This module provides a [Drupal Commerce 2.x](https://www.drupal.org/project/commerce) payment plugin for [BTCPay Server](https://docs.btcpayserver.org). This allows you to accept cryptocurrencies without a 3rd party intermediary by becoming your own payment processor.
Introducing BTCPay Server payment module for [Drupal Commerce 2.x](https://www.drupal.org/project/commerce). Drupal Commerce Store owners can now accept payments using Bitcoin and other cryptocurrencies directly through BTCPay Server without any third-party intermediary.

Visit the [project page on Drupal.org](https://drupal.org/project/commerce_btcpay)
BTCPay Server supports a wide range of cryptocurrencies, with the potential for future extensions. Here are the currencies you can use now on BTCPay Server:

- BTC (Bitcoin)
- Bitcoin layer-two network (the lightning network) for fast and zero/low-fee transactions
TChukwuleta marked this conversation as resolved.
Show resolved Hide resolved
- Altcoins with full node integration including coins like Monero (XMR) and Litecoin (LTC).
- Other Major Altcoins: Supported through plugins via platforms such as [Trocador](https://docs.btcpayserver.org/Trocador/), [SideShift](https://docs.btcpayserver.org/SideShift/), and FixedFloat.

Want to accept Bitcoin on your drupal commerce store? Visit the [project page on Drupal.org](https://drupal.org/project/commerce_btcpay)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nitpick: for consistency please "Drupal Commerce"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

all good


## Demo store
A Drupal Commerce demo store connected with a (testnet) BTCPay Server where you can try the checkout (Bitcoin + Lightning Network) can be found here:
Expand All @@ -14,60 +21,54 @@ A Drupal Commerce demo store connected with a (testnet) BTCPay Server where you
* Drupal Commerce 2.x installed ([installation guide](https://docs.drupalcommerce.org/commerce2/developer-guide/install-update/installation))
* Drupal: [configured and writable private file system](https://www.drupal.org/docs/8/core/modules/file/overview#content-accessing-private-files)

## Installation and configuration
## Installation and configuration Guide for the BTCPay Server - Drupal Commerce Integration

Ready to accept Bitcoin on your Drupal Commerce Store? Follow this quick and easy guide to install and configure the BTCPay Drupal Commerce module. For a quick run through, check out our installation and configuration screencast:

Short walkthrough screencast on installing and configuring the module:
https://youtu.be/XBZwyC2v48s
[![BTCPay Server - Drupal Commerce 2.x quick walkthrough](https://img.youtube.com/vi/XBZwyC2v48s/mqdefault.jpg)](https://youtube.com/watch?v=XBZwyC2v48s)

### Quick walkthrough steps

### Easy setup steps

#### Generate pairing code on BTCPay server
1. BTCPay server: [create and configure a store](https://docs.btcpayserver.org/btcpay-basics/gettingstarted#creating-btcpay-store)
2. in store settings go to "**Access Tokens**"
3. click on **[Create a new token]**
1. **Setup your store:** You'd need a BTCPay server instance to get started. Don't have one? click [here](https://docs.btcpayserver.org/RegisterAccount/) for a step by step guide.
2. **Access Tokens:** Once you have your BTCPay Server instance setup and store created, navigate to the store settings and select "**Access Tokens**"
3. Create a new token by clicking on **[Create a new token]**
4. **Label:** enter some label (eg. my store)
5. **Public key:** this needs to be left **empty**
6. **Facade:** "merchant"
7. click on **[Request pairing]**
8. on next screen choose your configured store in** Pair to** select dropdown and click on **[approve]**
9. note down the displayed 7-digit code at the top status message, e.g. "d7afaXr"
6. **Facade:** Type in "merchant"
7. Click on **[Request pairing]**
8. On the next screen choose your configured store in ** Pair to** select dropdown and click on **[approve]**
9. Note down the displayed 7-digit code at the top status message, e.g. "d7afaXr"
(you will need that code below on gateway configuration, see below)

#### Commerce BTCPay: Installation + configuration
1. install module: `composer require drupal/commerce_btcpay`
2. enable the module: `drush en commerce_btcpay -y`
3. make sure you have configured [private file system](https://www.drupal.org/docs/8/core/modules/file/overview#content-accessing-private-files) (needed to store encrypted public+private key)
1. Install module: `composer require drupal/commerce_btcpay`
2. Enable the module: `drush en commerce_btcpay -y`
3. Make sure you have configured [private file system](https://www.drupal.org/docs/8/core/modules/file/overview#content-accessing-private-files) (needed to store encrypted public+private key)
4. Commerce BTCPay configuration (**Commerce -> Configuration -> Payment -> Payment gateways**):
5. add payment method "BTCPay"
5. Add payment method "BTCPay"
* **Mode**: Test or Live (you can configure both individually)
* **Test/Live server host**: enter your URL without https:// prefix e.g. btcpay.yourserver.com (note valid SSL certificate needed)
* **Test/Live server host**: enter your URL without https:// prefix e.g. btcpay.yourserver.com (Note - valid SSL certificate needed)
* **Test/Live Paring code**: enter the 7-digit pairing code from BTCPay "Access tokens" page
* **Save**
* Click **Save** to finalize the setup.
You should see a message that the tokens were successfully created.

## Status
**This module is currently in alpha stage but has been working for a while without issues.**
Releases will be made available through the project page on drupal.org https://drupal.org/project/commerce_btcpay
**This module is currently in alpha stage but has proven stable without issues.**
Future updates and releases will be available on the [project page on drupal.org](https://drupal.org/project/commerce_btcpay)

## About BTCPay Server
Short excerpt from [their project page](https://github.com/btcpayserver/btcpayserver):
>BTCPay Server is a self-hosted, open-source cryptocurrency payment processor. It's secure, private, censorship-resistant and free.
>[BTCPay Server](https://btcpayserver.org/) is a self-hosted, open-source cryptocurrency payment processor know for its security, privacy, and censorship resistance.

It's free to use and allows you to become your own payment processor.
**To get a full overview check out our [documentation](https://docs.btcpayserver.org).**


## Supported cryptocurrencies
BTCPay supports a vast variety of cryptocurrencies:
- BTC (Bitcoin)
- BTC 2nd layer [Lightning Network](https://bitcoiner.guide/lightning/) for instant settled low fee transactions
- some altcoins using full node integration (XMR, LTC, ...)
- and most other major altcoins through plugins via Trocador, SideShift and FixedFloat

## Compatible with BitPay API
BTCPay was created to be a alternative to 3rd party payment provider [BitPay](https://bitpay.com). Therefore BTCPay is invoice API compatible and you can use this payment plugin also with the official BitPay API and sites if you want. But the power of BTCPay is that you can become your own payment provider.
BTCPay was created to be an alternative to 3rd party payment provider [BitPay](https://bitpay.com). Therefore, BTCPay is invoice API compatible and you can use this payment plugin also with the official BitPay API and sites. The power of BTCPay is that you can become your own payment provider.

Teaser, future versions of this plugin will be based on the BTCPay Server Greenfield API which is much more powerful and allows more features.
Teaser: future versions of this plugin will be based on the BTCPay Server Greenfield API which is much more powerful and allows more features.


## Get Support
You can open an issue on our [Github repository](https://github.com/btcpayserver/commerce_btcpay/issues) or join us on [Telegram](https://t.me/btcpayserver) or [Mattermost chat](http://chat.btcpayserver.org/)
You can open an issue on our [Github repository](https://github.com/btcpayserver/commerce_btcpay/issues) or reach us on [Telegram](https://t.me/btcpayserver) or [Mattermost chat](http://chat.btcpayserver.org/)