Skip to content

Commit 9496685

Browse files
fix: restore and update CONFIGURATION.md, remove duplicate changesets (#538)
chore: add changeset Co-authored-by: Ricardo Cabral <me@ricardocabral.io>
1 parent 214bef5 commit 9496685

4 files changed

Lines changed: 35 additions & 13 deletions

File tree

.changeset/README.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

.changeset/khaki-papayas-return.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"nostream": patch
3+
---
4+
5+
Fix: Restore CONFIGURATION.md with proper settings and remove duplicate changesets created during recovery

.changeset/slimy-bars-burn.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

CONFIGURATION.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,10 +145,40 @@ The settings below are listed in alphabetical order by name. Please keep this ta
145145
| limits.event.retention.maxDays | Maximum number of days to retain events. Purge deletes events that are expired (`expires_at`), soft-deleted (`deleted_at`), or older than this window (`created_at`). Any non-positive value disables retention purge. |
146146
| limits.event.retention.pubkey.whitelist | Public keys excluded from retention purge. |
147147
| limits.event.whitelists.ipAddresses | List of IPs (IPv4 or IPv6) to ignore rate limits. |
148+
| limits.event.whitelists.pubkeys | List of public keys to ignore rate limits. |
149+
| limits.message.ipWhitelist | List of IPs (IPv4 or IPv6) to ignore rate limits. |
150+
| limits.message.rateLimits[].period | Rate limit period in milliseconds. |
148151
| limits.client.subscription.maxSubscriptions | Maximum number of subscriptions per connected client. Defaults to 10. Disabled when set to zero. |
149152
| limits.client.subscription.maxFilters | Maximum number of filters per subscription. Defaults to 10. Disabled when set to zero. |
150153
| limits.message.rateLimits[].period | Rate limiting period in milliseconds. For `sliding_window`: the time window. For `ewma`: the half-life of the decay function. |
151154
| limits.message.rateLimits[].rate | Maximum number of messages during period. |
155+
| mirroring.static[].address | Address of mirrored relay. (e.g. ws://100.100.100.100:8008) |
156+
| mirroring.static[].filters | Subscription filters used to mirror. |
157+
| mirroring.static[].limits.event | Event limit overrides for this mirror. See configurations under limits.event. |
158+
| mirroring.static[].secret | Secret to pass to relays. Nostream relays only. Optional. |
159+
| mirroring.static[].skipAdmissionCheck | Disable the admission fee check for events coming from this mirror. |
160+
| network.maxPayloadSize | Maximum number of bytes accepted per WebSocket frame |
161+
| network.remoteIpHeader | HTTP header from proxy containing IP address from client. |
162+
| nip05.domainBlacklist | List of domains blocked from NIP-05 verification. Authors with NIP-05 at these domains will be rejected. |
163+
| nip05.domainWhitelist | List of domains allowed for NIP-05 verification. If set, only authors verified at these domains can publish. |
164+
| nip05.maxConsecutiveFailures | Number of consecutive verification failures before giving up on an author. Defaults to 20. |
165+
| nip05.mode | NIP-05 verification mode: `enabled` requires verification, `passive` verifies without blocking, `disabled` does nothing. Defaults to `disabled`. |
166+
| nip05.verifyExpiration | Time in milliseconds before a successful NIP-05 verification expires and needs re-checking. Defaults to 604800000 (1 week). |
167+
| nip05.verifyUpdateFrequency | Minimum interval in milliseconds between re-verification attempts for a given author. Defaults to 86400000 (24 hours). |
168+
| paymentProcessors.lnbits.baseURL | Base URL of your Lnbits instance. |
169+
| paymentProcessors.lnbits.callbackBaseURL | Public-facing Nostream's Lnbits Callback URL. (e.g. https://relay.your-domain.com/callbacks/lnbits) |
170+
| paymentProcessors.lnurl.invoiceURL | [LUD-06 Pay Request](https://github.com/lnurl/luds/blob/luds/06.md) provider URL. (e.g. https://getalby.com/lnurlp/your-username) |
171+
| paymentProcessors.zebedee.baseURL | Zebedee's API base URL. |
172+
| paymentProcessors.zebedee.callbackBaseURL | Public-facing Nostream's Zebedee Callback URL (e.g. https://relay.your-domain.com/callbacks/zebedee) |
173+
| paymentProcessors.zebedee.ipWhitelist | List with Zebedee's API Production IPs. See [ZBD API Documentation](https://api-reference.zebedee.io/#c7e18276-6935-4cca-89ae-ad949efe9a6a) for more info. |
174+
| payments.enabled | Enabled payments. Defaults to false. |
175+
| payments.feeSchedules.admission[].amount | Admission fee amount in msats. |
176+
| payments.feeSchedules.admission[].enabled | Enables admission fee. Defaults to false. |
177+
| payments.feeSchedules.admission[].whitelists.event_kinds | List of event kinds to waive admission fee. Use `[min, max]` for ranges. |
178+
| payments.feeSchedules.admission[].whitelists.pubkeys | List of pubkeys to waive admission fee. |
179+
| payments.processor | Either `zebedee`, `lnbits`, `lnurl`. |
180+
| workers.count | Number of workers to spin up to handle incoming connections. |
181+
| | Spin workers as many CPUs are available when set to zero. Defaults to zero. |
152182
| limits.message.ipWhitelist | List of IPs (IPv4 or IPv6) to ignore rate limits. |
153183
| limits.admissionCheck.rateLimits[].period | Rate limiting period in milliseconds. For `sliding_window`: the time window. For `ewma`: the half-life of the decay function. |
154184
| limits.admissionCheck.rateLimits[].rate | Maximum number of admission checks during period. |

0 commit comments

Comments
 (0)