Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dtonon/chronicle

A Nostr personal relay that support the Outbox model, with spam protection by WoT
https://github.com/dtonon/chronicle

nostr nostr-protocol nostr-relay

Last synced: 29 days ago
JSON representation

A Nostr personal relay that support the Outbox model, with spam protection by WoT

Awesome Lists containing this project

README 

        
![image](logo.png)



Chronicle is a personal relay [Nostr](https://njump.me), built on the [Khatru](https://khatru.nostr.technology) framework, that stores complete conversations in which the owner has taken part and nothing else: pure signal.  

This is possible since writing is limited to the threads in which the owner has partecipated (either as an original poster or with a reply/zap/reaction), and only to his trusted network (WoT), to protect against spam.



Chronicle fits well in the Outbox model, so you can use it as your read/write relay, and it also automatically becomes a space-efficient backup relay.



It also include a Blossom media server, so you can use it to store all your images and attachments.



## How it works



Every incoming event is verified against some simple rules.  

If it's signed by the relay owner, it is automatically accepted.  

If it is posted by someone else it is checked if it is part of in a conversation in which the owner participated *and* if the author is in the owner's social graph (to the 2nd degree), then it is accepted, otherwise it is rejected.  

A couple of options (_POW\_*_, see below) permit to whitelist an event and bypass the WoT, if an event has a sufficient PoW.



If an event published by the owner refers to a conversation that is not yet known by the relay, it tries to fetch it.



Blossom upload is restricted to the relay owner.



## Features highlight



It works nicely as inbox/outbox/dm relay.  

It is a space-efficient backup relay.  

It offers spam protection by WoT.  

It permits to load old notes with a "fetch sync" option.

It includes a Blossom media server.



## Configure



After cloning the repo create an `.env` file based on the example provided in the repository and personalize it:



```bash

# Your pubkey, in hex format

OWNER_PUBKEY="xxxxxxxxxxxxxxxxxxxxxxxxxxx...xxx"



# Relay info, for NIP-11

RELAY_NAME="YourRelayName"

RELAY_DESCRIPTION="Your relay description"

RELAY_URL="wss://chronicle.xxxxxxxx.com"

RELAY_ICON="https://chronicle.xxxxxxxx.com/assets/icon.png"

RELAY_CONTACT="your_email_or_website"



# The path you would like the database to be saved

# The path can be relative to the binary, or absolute

DB_PATH="db/"



# Interval in hours to refresh the web of trust

REFRESH_INTERVAL=24



# How many followers before they're allowed in the WoT

MIN_FOLLOWERS=3



# Periodically try fetch notes from other relays

FETCH_SYNC="FALSE"



# Whitelist events and/or DMs by PoW

# A positivie value enable the whitelist

# Empty disables the whitelist

# Zero (0) disables WoT - not recommended!

POW_WHITELIST=

POW_DM_WHITELIST=



# Define the external public url of the media server

# and the local path where assets are stored

BLOSSOM_PUBLIC_URL="http://localhost:3335"

BLOSSOM_ASSETS_PATH="assets/"



```



## Build



Build it with `go install` or `go build`, then run it.



By default Chronicle use [Badger](https://github.com/dgraph-io/badger) as event storage since it makes easier to cross-compile.  

You can also use [lmdb](https://www.symas.com/lmdb), compiling with:

```

go build -tags=lmdb .

```



## Credits



Chronicle uses some code from the great [wot-relay](https://github.com/bitvora/wot-relay).



## License



This project is licensed under the MIT License.