README, example config and the deploy hook

Co-Authored-By: Claude Opus 5.5 <[email protected]>

1 files changed, 24 insertions, 0 deletions

diff --git a/names/config.example.json b/names/config.example.json
new file mode 100644
index 0000000..163dd0a
--- /dev/null
+++ b/names/config.example.json
@@ -0,0 +1,24 @@
+{
+  "port": 8798,
+  "domain": "coinos.io",
+  "domains": {
+    "coinos.io": { "zoneId": "REPLACE: Cloudflare zone id" }
+  },
+  "publicBase": "https://names.example.com",
+  "cfEmail": "REPLACE: Cloudflare account email",
+  "cfKey": "REPLACE: Cloudflare API key",
+  "stateFile": "/data/names.json",
+  "dbFile": "/data/names.db",
+  "ln": { "kind": "socket", "path": "/cln/lightning-rpc" },
+  "forwarder": {
+    "mnemonic": "REPLACE: the float wallet's BIP-39 mnemonic",
+    "ark": "https://ark.example.com",
+    "esplora": "https://esplora.example.com/api",
+    "network": "mainnet"
+  },
+  "push": { "url": "http://nwcpush:8797", "token": "REPLACE: shared with nwcpush's notifyToken" },
+  "welcome": { "sk": "REPLACE: hex nostr secret key for welcome DMs", "message": "Welcome!" },
+  "adminToken": "REPLACE: random string",
+  "migrateToken": "REPLACE: random string, shared with coinos-server",
+  "rateExempt": []
+}