Skip to content

Latest commit

 

History

History
187 lines (129 loc) · 5.5 KB

README.md

File metadata and controls

187 lines (129 loc) · 5.5 KB
Raw

nsecbunkerd

Daemon to remotely sign nostr events using keys.

Easy setup via docker compose

To quickly install nsecbunkerd via Docker just run:

Configurations

  • Prepare your config directory

    mkdir $HOME/.nsecbunker-config

  • Clone .env.example and add your nostr public key to ADMIN_NPUBS to the .env file.

  • Change DATABASE_URL if necessary.

cp .env.example .env

Start nsecbunkerd

Create and start the project containers. This runs the migrations and then runs nsecbunkderd container.

# Optionally, build the image locally
docker compose build nsecbunkerd

# Start the project
docker compose up

# Or in the background
docker compose up -d

Get the connection string

docker compose exec nsecbunkerd cat /app/config/connection.txt

nsecBunker will give you a connection string like:

bunker://npub1tj2dmc4udvgafxxxxxxxrtgne8j8l6rgrnaykzc8sys9mzfcz@relay.nsecbunker.com

You can visit https://app.nsecbunker.com/ to administrate your nsecBunker remotely, or explore nsecbunkerd's CLI to find the options to add and approve keys from the CLI.

Hard setup:

(If you installed via docker you don't need to do any of this, skip to the Configure section)

Node.js v18 or newer is required.

git clone <nsecbunkerd-repo>
npm i
npm run build
npx prisma migrate deploy

Configure

Easy: Remote configuration

Using the connection string you saw before, you can go to https://app.nsecbunker.com and paste your connection string.

Note that ONLY the npub that you designated as an administrator when launching nsecBunker is able to control your nsecBunker. Even if someone sees your connection string, without access to your administrator keys, there's nothing they can do.

Hard: manual configuration

(If you are using remote configuration you don't need to do any of this)

Add your nsec to nsecBunker

Here you'll give nsecBunker your nsec. It will ask you for a passphrase to encrypt it on-disk. The name is an internal name you'll use to refer to this keypair. Choose anything that is useful to you.

npm run nsecbunkerd -- add --name <your-key-name>

Example

$ npm run nsecbunkerd -- add --name "Uncomfortable family"

nsecBunker uses a passphrase to encrypt your nsec when stored on-disk.
Every time you restart it, you will need to type in this password.

Enter a passphrase: <enter-your-passphrase-here>
Enter the nsec for Uncomfortable family: <copy-your-nsec-here>
nsecBunker generated an admin password for you:

***************************

You will need this to manage users of your keys.

Start

$ npm run lfg --admin <your-admin-npub>

Testing with nsecbunker-client

nsecbunker ships with a simple client that can request signatures from an nsecbunkerd:

nsecbunker-client sign <target-npub> "hi, I'm signing from the command line with my nsecbunkerd!"

OAuth-like provider

nsecBunker can run as an OAuth-like provider, which means it will allow new users to create accounts remotely from any compatible client.

To enable this you'll need to configure a few things on your nsecbunker.json config file. In addition to the normal configuration:

{
    "baseUrl": "https://....", // a public URL where this nsecBunker can be reached via HTTPS
    "authPort": 3000, // Port number where the OAuth-like provider will listen
    "domains": {
        "your-domain-here": {
            "nip05": "/your-nip05-nostr.json-file", // The location where NIP-05 entries to your domain are stored

            "nip89": {
                "profile": { // a kind:0-like profile
                    "name": "my cool nsecbunker instance", // The name of your nsecBunker instance
                    "about": "...",
                },
                "operator": "npub1l2vyh47mk2p0qlsku7hg0vn29faehy9hy34ygaclpn66ukqp3afqutajft", // (optional) npub of the operator of this nsecbunker
                "relays": [ // list of relays where to publush the nip89 announcement
                    "https://relay.damus.io",
                    "https://pyramid.fiatjaf.com"
                ]
            }

            // Wallet configuration (optional)
            "wallet": {
                "lnbits": {
                    "url": "https://legend.lnbits.com", // The URL where your LNbits instance is running
                    "key": "your-lnbits-admin-key", // The admin key for your LNbits instance
                    "nostdressUrl": "http://localhost:5556" // The URL where your nostdress instance is running
                }
            }
        }
    }
}

With this configuration users will be able to:

  • create a new key managed by your nsecbunker
  • get an lnbits-based LN wallet
  • get zapping capabilitiyes through nostdress

For this to work you'll need to run, in addition to nsecbunkerd, an lnbits instance and a nostdress instance. Your LNBits needs to have the user manager extension enabled.

  • TODO: Add NWC support

When booting up, the nsecbunkerd will publish a NIP-89 announcement (kind:31990), which is the way clients find out about your nsecbunker.

When a bunker provides a wallet and zapping service (wallet and nostdressUrl are configured), it will add tags:

{
    "tags": [
        [ "f", "wallet" ],
        [ "f", "zaps" ]
    ]
}

Authors

  • pablof7z
    • npub1l2vyh47mk2p0qlsku7hg0vn29faehy9hy34ygaclpn66ukqp3afqutajft

License

MIT