-
@ Egge
2024-06-12 14:51:37Disclaimer: Beware, there be dragons... Deploying your own version of npubcash-server is highly experimental. Do not use this in production yet. If you do deploy it, please make sure to leave your feedback with me.
Prerequisites
Before we dive in, you'll need a few things:
- Blink API Key: npubcash-server uses Blink API for payment callbacks. If you don’t have a Blink account yet, sign up here.
- Postgres: npubcash-server utilizes a Postgres database for storage.
- fly.io Account and flyctl: While you can deploy npubcash-server anywhere, this guide focuses on fly.io and its CLI tool, flyctl.
Setup
Step 1: Clone the Repository
First, clone the npubcash-server repository, specifically the
migrationsbranch, as it contains the necessary deployment scripts. Don’t forget to clone all submodules recursively.zsh git clone -b migrations --recurse-submodules https://github.com/cashubtc/npubcash-server.git cd npubcash-serverStep 2: Create fly.toml Configuration
Next, create your
fly.tomlfile to configure your deployment.zsh nvim fly.tomlHere's a sample configuration. Adjust the environment variables to match your setup:
```toml app = "npubcash-server" primary_region = "ams"
[build]
[http_service] internal_port = 8000 force_https = true auto_stop_machines = true auto_start_machines = true min_machines_running = 0 processes = ["app"]
[[vm]] memory = "512mb" cpu_kind = "shared" cpus = 1
[env] NODE_ENV = "production" PGUSER = "
" PGPASSWORD = " " PGHOST = " " PGDATABASE = " " PGPORT = " " MINTURL = " " BLINK_API_KEY = " Note: fly.io offers additional security for sensitive environment variables through
secrets, which are encrypted and never exposed directly. Consider usingsecretsfor sensitive data like your Blink or Nostr key. Learn more here.Deploying
With your configuration ready, it’s time to deploy!
zsh fly launchWhen prompted, choose to use the existing
fly.tomlfile by inputtingy. Fly.io might suggest deploying a Postgres instance, but since we're using an external Postgres instance, adjust the settings as needed through their web interface. Watch the build logs in your terminal, and once completed, your instance of npubcash-server is live. Congrats!Setting Up a Custom Domain
To fully utilize npubcash-server as an LNURL server, you’ll need a custom domain. Here’s how to set it up:
- Get the IP Address: Use flyctl to list your IP addresses.
zsh fly ips listCopy the IPv4 and IPv6 addresses.
-
Create DNS Records: Set up an A record with your domain provider using the IPv4 address and a AAAA record using the IPv6 address.
-
Request an SSL Certificate: For encrypted traffic, request a Let’s Encrypt certificate.
zsh fly certs add <your domain name>Note: DNS propagation can take some time. Ensure your machine is running and try connecting to the domain once the DNS records are updated. Fly.io will verify the DNS setup when traffic starts coming in.
Wrapping up
That is it... Hopefully by now your very own instance of npubcash-server is running and reachable on your own domain. If you got this far, please reach out to me and let me know. Now please go ahead and try to break it. If you do, please open an issue so that I can fix it :)