Set Up NGINX Reverse Proxy and SSL

After you set up a PayID server using your preferred deployment option, you can set up NGINX Reverse Proxy + SSL for load balancing and security.

NGINX Reverse Proxy + SSL setup

  1. Change the PayID server to run on port 8080 (default).
  2. Set up a Server Block on NGINX for your domain, following these instructions.
  3. Install Certbot, as follows.
    apt-get update
    apt-get install software-properties-common
    add-apt-repository ppa:certbot/certbot
    apt-get update
    apt-get install python-certbot-nginx
  4. Generate a certificate (choose to redirect) certbot --nginx
  5. Change the location parameter in the NGINX conf file to reverse proxy to the PayID server (running on port 8080): try_files $uri $uri/ =404; to:
    proxy_set_header Host $http_host;
    Note: The second line is required to preserve the original URL, which is used to find the user. Note: You can expand your certificate to cover any subdomain used in a PayID using: sudo certbot -d,, --expand
  6. Restart NGINX. sudo systemctl restart nginx
  7. [Optional] Update the NGINX configuration that catches PayID headers and forwards them to the PayID server; otherwise, send these headers to the web server.

Note: You will need to add additional proxy passing statements for each additional network supported, or otherwise use a generic regex to identify all PayID headers.

sudo nano /etc/nginx/sites-available/<your-site>
location / {
proxy_set_header Host $http_host;
# needed for CORS
add_header Access-Control-Allow-Origin *;
add_header Access-Control-Allow-Headers *;
# proxy passing needed for all supported networks
# modify port to the one used by your PayID server
if ($http_accept ~ "application/payid*") {
proxy_pass http://localhost:8080;
if ($http_accept ~ "application/xrpl-*") {
proxy_pass http://localhost:8080;
try_files $uri $uri/ =404;