settings.sample.json

{
  "info": {
    "relay_url": "wss://nostream.your-domain.com",
    "name": "nostream.your-domain.com",
    "description": "A nostr relay written in TypeScript.",
    "pubkey": "replace-with-your-pubkey",
    "contact": "operator@your-domain.com"
  },
  "network": {
    "max_payload_size": 131072,
    "remote_ip_header": "x-forwarded-for"
  },
  "workers": {
    "count": 0
  },
  "limits": {
    "event": {
      "eventId": {
        "minLeadingZeroBits": 0
      },
      "kind": {
        "whitelist": [],
        "blacklist": []
      },
      "pubkey": {
        "minLeadingZeroBits": 0,
        "whitelist": [],
        "blacklist": []
      },
      "createdAt": {
        "maxPositiveDelta": 900,
        "maxNegativeDelta": 0
      },
      "content": {
        "maxLength": 1048576
      },
      "rateLimits": [
        {
          "kinds": [0, 3, 40, 41],
          "period": 60000,
          "rate": 6
        },
        {
          "kinds": [1, 2, 4, 42],
          "period": 60000,
          "rate": 12
        },
        {
          "kinds": [1, 2, 4, 42],
          "period": 3600000,
          "rate": 360
        },
        {
          "kinds": [[5, 7], [43, 49]],
          "period": 60000,
          "rate": 30
        },
        {
          "kinds": [[10000, 19999], [30000, 39999]],
          "period": 60000,
          "rate": 24
        },
        {
          "kinds": [[20000, 29999]],
          "period": 60000,
          "rate": 60
        },
        {
          "period": 3600000,
          "rate": 720
        },
        {
          "period": 86400000,
          "rate": 2880
        }
      ],
      "whitelists": {
        "pubkeys": [],
        "ipAddresses": [
          "::1",
          "::ffff:10.10.10.1"
        ]
      }
    },
    "client": {
      "subscription": {
        "maxSubscriptions": 10,
        "maxFilters": 10
      }
    },
    "message": {
      "rateLimits": [
        {
          "period": 60000,
          "rate": 120
        },
        {
          "period": 3600000,
          "rate": 3600
        },
        {
          "period": 86400000,
          "rate": 86400
        }
      ],
      "ipWhitelist": [
        "::1",
        "::ffff:10.10.10.1"
      ]
    }
  }
}