Skip to content

Commit a8aa1f3

Browse files
authored
Merge pull request #1486 from ndeet/pretix
Adding Pretix to docs
2 parents d281bab + d2500fd commit a8aa1f3

12 files changed

+58
-0
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
/docs/Nostr
2020
/docs/Payroll
2121
/docs/PodServer
22+
/docs/ShopifyV2
2223
/docs/SideShift
2324
/docs/Smartstore
2425
/docs/TicketTailor

docs/.vuepress/config.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,7 @@ const sidebarUserGuide = [
118118
['/OpenCart', 'OpenCart'],
119119
['/PhocaCart', 'PhocaCart'],
120120
['/PrestaShop', 'PrestaShop'],
121+
['/Pretix', 'Pretix'],
121122
['/Shopify', 'Shopify'],
122123
['/ShopifyV2/', 'Shopify V2'],
123124
['/Shopware', 'Shopware'],

docs/Pretix.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Pretix - ticketing software for events
2+
3+
[Pretix](https://pretix.eu/) is a free and [open-source ticketing software](https://github.com/pretix/pretix) for conferences, festivals, exhibitions, workshops, and other events. You can deploy it on your own or start with their [cloud version](https://pretix.eu/about/en/pricing) which is free for up to 2500 ticket sales.
4+
5+
:::tip
6+
This integration is maintained by Pretix and is not part of the BTCPay Server project.
7+
:::
8+
9+
# Requirements
10+
- You have a [Pretix cloud account](https://pretix.eu/signup/) or [self-hosted instance](https://docs.pretix.eu/en/latest/admin/installation/index.html)
11+
- If you are self-hosting Pretix, you need to manually install their [BitPay plugin](https://github.com/pretix/pretix-bitpay)
12+
- You have a BTCPay Server version 1.15.0 or later, either [self-hosted](/Deployment/README.md) or [hosted by a third-party](/Deployment/ThirdPartyHosting.md)
13+
- [You've a registered account on the instance](./RegisterAccount.md)
14+
- [You've a BTCPay store on the instance](./CreateStore.md)
15+
- [You've a wallet connected to your store](./WalletSetup.md)
16+
17+
## Installing and configuring BitPay plugin for Pretix
18+
19+
:::tip
20+
The plugin is called BitPay, but it actually supports BTCPay Server too as you can set a custom domain pointing to your BTCPay Server instance.
21+
:::
22+
23+
1. In Pretix dashboard select the event you want to configure.
24+
2. On left sidebar, expand "Settings" and click on "Plugins".
25+
3. At the top select the "Payment providers" tab.
26+
4. Find "BitPay" plugin and click on "Enable".
27+
![Enable BitPay plugin](./img/pretix/pretix-step-1-4.png)
28+
----
29+
5. On left sidebar, click on "Payment".
30+
![Payment](./img/pretix/pretix-step-5.png)
31+
----
32+
6. On the line of "BitPay" click on "Settings".
33+
![BitPay settings](./img/pretix/pretix-step-6.png)
34+
----
35+
7. Fill in the URL of your BTCPay Server instance, for example `https://mainnet.demo.btcpayserver.org` (this is where you have created your BTCPay Server store, see [Requirements](#requirements) above).
36+
8. Click on "Start pairing".
37+
![Start pairing process](./img/pretix/pretix-step-7-8.png)
38+
----
39+
9. You will get redirected to your BTCPay Server "pairing permission" page. Select the store you want to pair to.
40+
10. Click on "Approve".
41+
![Approve pairing](./img/pretix/pretix-step-9-10.png)
42+
----
43+
11. You should see the message "Pairing successful". You won't get redirected back to Pretix automatically, so you can close the tab now.
44+
![Pairing successful](./img/pretix/pretix-step-11.png)
45+
----
46+
12. Go back to Pretix and click on "Save" on bottom right.
47+
![Save settings](./img/pretix/pretix-step-12.png)
48+
----
49+
13. You now see the "Payment settings" page, you see **Enable payment method** at the top, check this box
50+
14. **Payment method name**: Enter a name for the payment method, for example "Bitcoin / Lightning Network". You can leave the rest as is or adjust it to your needs.
51+
15. Click on "Save" on bottom right.
52+
![Payment settings](./img/pretix/pretix-step-13-15.png)
53+
54+
Congratulations, you have completed the setup.
55+
56+
Now you can try a test purchase and make sure the payment method works as expected.

docs/img/pretix/pretix-step-1-4.png

305 KB
Loading

docs/img/pretix/pretix-step-11.png

83.9 KB
Loading

docs/img/pretix/pretix-step-12.png

205 KB
Loading

docs/img/pretix/pretix-step-13-15.png

420 KB
Loading

docs/img/pretix/pretix-step-16.png

52.1 KB
Loading

docs/img/pretix/pretix-step-5.png

141 KB
Loading

docs/img/pretix/pretix-step-6.png

91.2 KB
Loading

docs/img/pretix/pretix-step-7-8.png

198 KB
Loading

docs/img/pretix/pretix-step-9-10.png

52.7 KB
Loading

0 commit comments

Comments
 (0)