From e0a61cfeef3dd81a4d2accbc4da18b6fc19eb319 Mon Sep 17 00:00:00 2001
From: Ricardo Arturo Cabral Mejia <me@ricardocabral.io>
Date: Tue, 25 Oct 2022 22:25:07 -0400
Subject: [PATCH] doc: add sample settings file

---
 README.md            |  4 +++-
 settings.sample.json | 35 +++++++++++++++++++++++++++++++++++
 2 files changed, 38 insertions(+), 1 deletion(-)
 create mode 100644 settings.sample.json

diff --git a/README.md b/README.md
index e4f1c6f..908c3d7 100644
--- a/README.md
+++ b/README.md
@@ -116,8 +116,10 @@ You can change the default folder by setting the `NOSTR_CONFIG_DIR` environment
 Run nostr-ts-relay using one of the quick-start guides at least once and `~/.nostr/settings.json` will be created.
 Any changes made to the settings file will be read on the next start.
 
-See [CONFIGURATION.md](CONFIGURATION.md) for a detailed explanation of each environment variable and setting.
+A sample settings file is included at the project root under the name `settings.sample.json`. Feel free to copy it to `~/.nostr/settings.json`
+if you would like to have a settings file before running the relay first.
 
+See [CONFIGURATION.md](CONFIGURATION.md) for a detailed explanation of each environment variable and setting.
 ## Dev Channel
 
 For development discussions, please use the [Nostr Typescript Relay Dev Channel](https://t.me/nostr_ts_relay).
diff --git a/settings.sample.json b/settings.sample.json
new file mode 100644
index 0000000..7e9c3ee
--- /dev/null
+++ b/settings.sample.json
@@ -0,0 +1,35 @@
+{
+  "info": {
+    "relay_url": "wss://nostr-ts-relay.your-domain.com",
+    "name": "nostr-ts-relay.your-domain.com",
+    "description": "A nostr relay written in Typescript.",
+    "pubkey": "replace-with-your-pubkey",
+    "contact": "operator@your-domain.com"
+  },
+  "limits": {
+    "event": {
+      "eventId": {
+        "minLeadingZeroBits": 0
+      },
+      "kind": {
+        "whitelist": [],
+        "blacklist": []
+      },
+      "pubkey": {
+        "minLeadingZeroBits": 0,
+        "whitelist": [],
+        "blacklist": []
+      },
+      "createdAt": {
+        "maxPositiveDelta": 900,
+        "maxNegativeDelta": 0
+      }
+    },
+    "client": {
+      "subscription": {
+        "maxSubscriptions": 10,
+        "maxFilters": 10
+      }
+    }
+  }
+}
\ No newline at end of file