Skip to content

Latest commit

 

History

History
114 lines (77 loc) · 6.8 KB

File metadata and controls

114 lines (77 loc) · 6.8 KB

BTCPay Server - Prestashop Plugin

BTCPay Server

Accept Bitcoin payments within PrestaShop

Maintained GitHub Workflow Status GitHub License PRs are welcome GitHub contributors

GitHub release (latest SemVer) GitHub all releases

"This is lies, my trust in you is broken, I will make you obsolete" 💚

Report a bug · Request a feature · FAQ


🔧 Requirements

Please ensure that you meet the following requirements before installing this plugin.

Tested successfully

  • Prestashop v8.0, v8.0.1, v8.0.4, v8.1.0, v8.1.3, v8.1.4, v8.2.1, v9.0.0
  • BTCPay server v1.7.0, v1.7.3.0, v1.12.5, v1.13.0, v1.13.5, v2.1.5, v2.2.1
    • BTCPay server v2 is supported as of module version v6.3.0.

Multistore

As of right now the module is not compatible with Prestashop's multistore feature. Any help to resolve this is very much welcomed. Please see the relevant discussion.

📗 Documentation

Please check out our official website, complete documentation and FAQ for more details.

If you have trouble using BTCPay Server, consider joining communities listed on the official website to get help from other contributors. Only create a GitHub issue for technical issues you can't resolve through other channels or feature requests you've validated with other members of the community.

🚀 Quick Start Guide

To get up and running with our plugin quickly, see the PrestaShop Guide on our documentation website.

📧 Merchant alerts (logs by email)

Severe module issues (configuration auto-reset, webhook/invoice processing failures, etc.) are written to the PrestaShop logs at Error severity. PrestaShop can email you those entries; the module does not send its own alert mail.

In the back office, open Advanced Parameters -> Logs and ensure:

  1. Minimum severity level for logs by email is set to Error (or Major).
  2. Send emails to includes an address you monitor (often the shop contact email).
  3. Shop mail itself works (Advanced Parameters -> E-mail; send a test message).

With that enabled, open the log entry from the alert mail under Advanced Parameters -> Logs for the full message. Invalid webhook signature probes are logged as Warning so they do not flood your inbox.

🧑‍💻 Versioning

We use SemVer for versioning. For the versions available, see the releases within this repository.

🤝 Contributing

BTCPay Server is built and maintained entirely by volunteer contributors around the internet. We welcome and appreciate new contributions.

Contributors looking to help out, before opening a pull request, please join our community chat or start a GitHub discussion to get early feedback, discuss the best ways to tackle the problem, and ensure there is no work duplication.

🔧 Development

This repository includes a Docker-based local environment (PrestaShop, BTCPay Server regtest, MariaDB). See development/README.md for setup and usage.

Quick start:

make dev-up

For webhook testing, follow the ngrok tunnel steps in the development guide. Alternatively, PrestaShop Flashlight with a dockerized BTCPay Server instance (or testnet demo) can be used.

🏪 PrestaShop Support

PrestaShop support can be found through its official channels.

  • Documentation - contains answers to commonly asked questions and provides instructions for almost everything. Including setup, management, etc.
  • Support Forums - the official Prestashop forum is a good place to find further answers and ask Prestashop related questions.

📝 License

BTCPay Server software, logo and designs are provided under MIT License.