From cc1a6d49e82e445e40a58a7e66c4df8f76cab4a6 Mon Sep 17 00:00:00 2001 From: Your Name Date: Sun, 15 Aug 2021 10:39:15 +0200 Subject: [PATCH] updated instructions --- README.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index dd8d760..a0b4919 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,19 @@ +## Disclaimer +This stripe module for [InvoicePlane](https://www.invoiceplane.com/) is still in an early version (_alpha_) and it's not ready for production. The module is distributed for free. Use it at your own risk, any liability of the developer is excluded. Do not use this module if it is in contrast with your country's regulation. This module is in no way supported by Stripe. + ## Installation (alpha version) 1. Download the last version from 2. Upload the `hmapi` folder to `application/module` folder 3. Update the `application/config/config.php`and include in the `$config['csrf_exclude_uris']` variable also the following endpoint `hmapi/pay/stripe_validate_payment` -4. Update the `hmapi/controllers/Pay.php`file and add your `WEBHOOK SECRET`, `STRIPE API KEY` and `STRIPE PUBLISHABLE KEY` -5. On line 38 of `hmapi/controllers/Pay.php` be sure to set the right currency for the payments -6. Copy the `InvoicePlane_Stripe.php` file in `application/views/invoices_templates/public` -7. Go to your InvoicePlane system settings (http://yourdomain.tld/index.php/settings) and in the `Invoices` tab go to the `Invoice Templates` section and set the `Default Public Template` to `InvoicePlane_Stripe` +4. Create an endpoint in stripe `https://dashboard.stripe.com/webhooks` that points to `https://yourdomain.tld/ip-stripe/pay/stripe_validate_payment` with `Events to send` set to `checkout.session.completed` +5. Update the `hmapi/controllers/Pay.php`file and add your `WEBHOOK SECRET`, `STRIPE API KEY` and `STRIPE PUBLISHABLE KEY` +6. On line 38 of `hmapi/controllers/Pay.php` be sure to set the right currency for the payments +7. Copy the `InvoicePlane_Stripe.php` file in `application/views/invoices_templates/public` +8. Go to your InvoicePlane system settings (http://yourdomain.tld/index.php/settings) and in the `Invoices` tab go to the `Invoice Templates` section and set the `Default Public Template` to `InvoicePlane_Stripe` + + +## Bugs +If you encouter bugs, please open an issue in the Github section. + +## Security issues +Security concerns can be sent to support(at)0ll.ch