Skip to content
This repository was archived by the owner on Mar 8, 2024. It is now read-only.

Commit b38a2a4

Browse files
author
Dino Rodriguez
authored
docs: TLS requirement in docs (#497)
1 parent b2c7ca1 commit b38a2a4

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

readme.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,18 @@
1212
- [8. Use Xpring SDK with PayID](#8-use-xpring-sdk-with-payid)
1313
- [8.1. Demo](#81-demo)
1414

15+
## Required Server Security
16+
17+
There are a few critical security measures that **MUST** be taken when running this PayID server implementation.
18+
19+
### TLS
20+
21+
TLS is a **requirement** for PayID. This PayID server implementation does not include TLS out-of-the-box, so it must be configured.
22+
23+
For instructions on configuring TLS with an NGINX reverse proxy for PayID, go [here](https://dev.docs.payid.org/docs/remote-deployment#nginx-reverse-proxy--ssl-setup).
24+
25+
For PayID security best practices, go [here](https://dev.docs.payid.org/docs/payid-best-practices).
26+
1527
## 4. PayID integration and the PayID APIs
1628

1729
You can deploy your own PayID server and then create PayIDs for your users using the PayID Private API. You can also query and modify this list of users. This API should be exposed internally only, so that only your company's systems can update PayID mappings.

0 commit comments

Comments
 (0)