Compare commits

...

4 Commits

Author SHA1 Message Date
Pavlenex
8e833894ce
Update README.md
update image with a link to avoid doc.btcpayserver broken relative path preview
2024-01-23 13:26:51 +01:00
Pavlenex
b8e56e627c
Update README.md (#4)
* Update README.md
* add banner
2024-01-19 14:08:48 +01:00
Andrew Camilleri
9ac08ba705
Merge pull request #1 from ndeet/improvements
Updating READMEs; fixing permission and update docker-compose contain…
2023-11-14 18:11:06 +01:00
ndeet
86daaf419b Updating READMEs; fixing permission and update docker-compose container name. 2023-11-09 12:46:26 +01:00
5 changed files with 28 additions and 15 deletions

View File

@ -1,7 +1,7 @@
NOTE: THis fork of Smartstore hosts the plugin source code for the BTCPay Server integration. You can view its README at [src/Smartstore.Plugins.Payment.BTCPayServer/README.md](src/Smartstore.Plugins.Payment.BTCPayServer/README.md).
**NOTE: This fork of Smartstore hosts the plugin source code for the BTCPay Server integration. You can view its README at [src/Smartstore.Modules/Smartstore.BTCPayServer/README.md](src/Smartstore.Modules/Smartstore.BTCPayServer/README.md).**
## Building the plugin
Running `build-btcpayplugin.ps1` or `build-btcpayplugin.sh` will build the plugin and place the resulting zip file in `build/packaghes`.
Running `build-btcpayplugin.ps1` or `build-btcpayplugin.sh` will build the plugin and place the resulting zip file in `build/packages` which you can then use to install.
## Releasing the plugin
A github actions workflow is configured to automatically build and release the plugin when a new tag is pushed to the repository.
@ -9,7 +9,12 @@ The workflow will build the plugin and upload it to the [releases page](https://
The tag name must be in the format `BTCPayServer/{version}`, where `{version}` is the version of the plugin as defined in `src\Smartstore.Modules\Smartstore.BTCPayServer\module.json`.
## Testing without debugging
Simply run `docker compose up` in this directory and the latest version of SmartStore will be run on `localhost`. Just use the SQLite db option and you're good to go.
Simply run `docker compose up` in this directory and the latest version of SmartStore will be run on `http://localhost`. Just use the SQLite db option and you're good to go.
---
---
<p align="center">
<a href="https://www.smartstore.com" target="_blank" rel="noopener noreferrer">

0
build-btcpayplugin.sh Normal file → Executable file
View File

View File

@ -2,7 +2,7 @@ version: "3.4"
services:
web:
image: ghcr.io/smartstore/smartstore-linux
container_name: web
container_name: smartstore_btcpay
ports:
- "80:80"
restart: unless-stopped

View File

@ -1,34 +1,42 @@
# BTCPay Plugin for SmartStore
# BTCPay plugin for SmartStore - accept Bitcoin payments
![BTCPay Server](https://github.com/btcpayserver/btcpayserver/raw/master/BTCPayServer/wwwroot/img/btc_pay_BG_twitter.png)
![BTCPay Server SmartStore banner](https://raw.githubusercontent.com/btcpayserver/Smartstore.BTCPayServer/main/src/Smartstore.Modules/Smartstore.BTCPayServer/wwwroot/banner.png)
## Plugin Overview
This plugin allows you to easily integrate Bitcoin payments into your SmartStore website using BTCPay Server. You can configure the plugin either automatically or manually, depending on your preferences and requirements.
This plugin allows you to easily integrate Bitcoin payments into your SmartStore website using BTCPay Server — a free, self-hosted and open-source payment gateway solution designed to revolutionize Bitcoin payments. Our seamless integration with SmartStore ensures a hassle-free connection to your self-hosted BTCPay Server.
Experience the simplicity of accepting Bitcoin payments with just a few straightforward steps. You can configure the plugin either automatically or manually, depending on your preferences and requirements.
## Automatic Configuration
1. Enter the "BTCPay Url" parameter and save.2. Click on the "Create API Key Automatically" link to be redirected to the key creation page on your BTCPay server.
3. The "API Key" and "BTCPay Store ID" parameters will be automatically filled and a webhook will be automatically created. Save.
1. Enter Url to your BTCPay Server into "BTCPay Url" field. (e.g. https://mainnet.demo.btcpayserver.org)
2. Click on the "Configure automatically" button to be redirected to the API authorization page on your BTCPay server
3. On BTCPay authorization page: Select the store you want to connect to your Smartstore (you might need to login first)
4. Click on "Authorize App" button and you will be redirected back to your Smartstore
3. The "API Key", "BTCPay Store ID" and "Webhook Secret" fields will be automatically filled and a webhook created
4. Click "Save" button at the top right to persist the configuration
5. Congrats, the configuration is now done.
## Manual Configuration
Ensure that the following fields are filled out: "BTCPay Url," "API Key," "BTCPay Store ID," and "WebHook Secret."
To create the BTCPay API key, [read this](https://docs.btcpayserver.org/VirtueMart/#22-create-an-api-key-and-configure-permissions).
- Note: If you want to use the Refund feature, you must also add the "Modify your stores" permission. After a refund, an order note is created, indicating the BTCPay link where the customer can request a refund.
- Note: If you want to use the Refund feature, you must also add the "Create non-approved pull payments" permission. After a refund, an order note is created where you can copy the pull payments link and send to your customer. The customer can request the refund on that page.
To create the BTCPay WebHook, [read this](https://docs.btcpayserver.org/VirtueMart/#23-create-a-webhook-on-btcpay-server) and use the default secret code generated by BTCPay.
- Note: Other than in the guide you need to copy the Url shown in field "Webhook Url" from your configuration screen on Smartstore.
## Support and Documentation
## Support
For more information and detailed instructions, please visit the [official documentation](https://docs.btcpayserver.org/).
Feel free to join our support channel over at [Mattermost Chat](https://chat.btcpayserver.org/) if you need help or have any further questions.
If experience a bug please open an issue in our repository [here](https://github.com/btcpayserver/Smartstore.BTCPayServer/issues)
## License
This plugin is released under the [MIT License](LICENSE).
---
For more information and updates, visit our [GitHub repository](https://github.com/Nisaba/btcpay-smartstore-plugin).
Find our latest releases on the [Smartstore marketplace](https://community.smartstore.com/index.php?/files/file/246-btcpay-server-for-smartstore/) or on our [release page](https://github.com/btcpayserver/Smartstore.BTCPayServer/releases)

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 MiB