HAVEN (High Availability Vault for Events on Nostr) is the most sovereign personal relay for the Nostr protocol, for storing and backing up sensitive notes like eCash, private chats and drafts. It is a relay that is not so dumb, with features like web of trust, inbox relay, cloud backups, blastr and the ability to import old notes.

Private Relay: This relay is only accessible by the owner of the relay. It is used for drafts, ecash and other private notes that nobody can read or write to. It is protected by Auth.

Chat Relay: This relay is used to contact the owner by DM. Only people in the web of trust can interact with this relay, protected by Auth. It only accepts encrypted DMs and group chat kinds.

Inbox Relay: This relay is where the owner of the relay reads from. Send your zaps, reactions and replies to this relay when you're tagging the owner. You can also pull notes from this relay if you want notes where the owner is tagged. This relay automatically pulls notes from other relays. Only notes where the owner is tagged will be accepted to this relay.

Outbox Relay: This relay is where the owner's notes all live and are publicly accessible. You can import all your old notes to this relay. All notes sent to this relay are blasted to other relays. Only the owner can send to this relay, but anyone can read.

Web of Trust: Protected from DM and Inbox spam by using a web of trust.

Inbox Relay: Notes are pulled from other relays and stored in the inbox relay.

Cloud Backups: Notes are backed up in the cloud and can be restored if the relay is lost.

Blastr: Notes sent to the outbox are also blasted to other relays.

Import Old Notes: Import your old notes and notes you're tagged in from other relays.

• Go: Ensure you have Go installed on your system. You can download it from here.
• Build Essentials: If you're using Linux, you may need to install build essentials. You can do this by running sudo apt install build-essential.

Follow these steps to get the Haven Relay running on your local machine:

git clone https://github.com/bitvora/haven.git
cd haven

You'll need to create an .env file based on the example provided in the repository.

cp .env.example .env

Open the .env file and set the necessary environment variables.

If you want to use custom relay files for import and blastr, you can specify IMPORT_SEED_RELAYS_FILE and BLASTR_RELAYS_FILE in the .env file. First, copy the example JSON files:

cp relays_import.example.json relays_import.json

cp relays_blastr.example.json relays_blastr.json

Then, set the paths to the files in the .env file:

IMPORT_SEED_RELAYS_FILE=relays_import.json
BLASTR_RELAYS_FILE=blastr_relays.json

The JSON should contain an array of relay URLs (without ws:// or wss://):

["relay.damus.io", "nos.lol"]

Run the following command to build the relay:

go build

To have the relay run as a service, create a systemd unit file. Make sure to limit the memory usage to less than your system's total memory to prevent the relay from crashing the system.

1. Create the file:

sudo nano /etc/systemd/system/haven.service

2. Add the following contents:

[Unit]
Description=Haven Relay
After=network.target

[Service]
ExecStart=/home/ubuntu/haven/haven
WorkingDirectory=/home/ubuntu/haven
Restart=always

[Install]
WantedBy=multi-user.target

Replace /path/to/ with the actual paths where you cloned the repository and stored the .env file.

3. Reload systemd to recognize the new service:

sudo systemctl daemon-reload

4. Start the service:

sudo systemctl start haven

5. (Optional) Enable the service to start on boot:

sudo systemctl enable haven

You can serve the relay over nginx by adding the following configuration to your nginx configuration file:

server {
    listen 80;
    server_name yourdomain.com;

    location / {
        proxy_pass http://localhost:3355;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
    }
}

Replace yourdomain.com with your actual domain name.

After adding the configuration, restart nginx:

sudo systemctl restart nginx

If you want to serve the relay over HTTPS, you can use Certbot to generate an SSL certificate.

sudo apt-get update
sudo apt-get install certbot python3-certbot-nginx

After installing Certbot, run the following command to generate an SSL certificate:

sudo certbot --nginx

Follow the instructions to generate the certificate.

If you want to import your old notes and notes you're tagged in from other relays, run the following command:

./haven --import

Once everything is set up, the relay will be running on localhost:3355 with the following endpoints:

• localhost:3355 (outbox)
• localhost:3355/private
• localhost:3355/chat
• localhost:3355/inbox

To start the project using Docker Compose, follow these steps:

1. Ensure Docker and Docker Compose are installed on your system.

2. Navigate to the project directory.

3. Ensure the .env file is present in the project directory and has the necessary environment variables set.

4. You can also change the paths of the db folder and haven folder in the docker-compose.yml file.

   volumes:
     - "./db:/app/db" # only change the left side before the colon
     - "./haven:/app/haven" # only change the left side before the colon

5. Run the following command:

   # in foreground
   docker compose up --build
   # in background
   docker compose up --build -d

6. For updating the relay, run the following command:

   git pull
   docker compose build --no-cache
   # in foreground
   docker compose up
   # in background
   docker compose up -d

This will build the Docker image and start the haven-relay service as defined in the docker-compose.yml file. The application will be accessible on port 3335.

Same as the step 6, but with the following command:

# in foreground
docker compose -f docker-compose.tor.yml up --build
# in background
docker compose -f docker-compose.tor.yml up --build -d

You can find the onion address here: tor/data/haven/hostname

The relay automatically backs up your database to a cloud provider of your choice.

To back up your database to AWS, you'll need to first install and configure the awscli. You can do this by running the following commands:

sudo python3 -m pip install awscli
aws configure

After configuring the awscli, you can set the following environment variables in your .env file:

AWS_ACCESS_KEY_ID=your_access_key_id
AWS_SECRET_ACCESS_KEY=your_secret_access_key
AWS_REGION=your_region
AWS_BUCKET=your_bucket

Replace your_access_key_id, your_secret_access_key, your_region, and your_bucket with your actual AWS credentials.

This project is licensed under the MIT License.