aegis

Aegis Relay

Aegis Relay is a premium relay and blossom service that allows relay operators to earn income by providing relay services to the network.

It's built on the Khatru framework.

Prerequisites

• 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.

Setup Instructions

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

1. Clone the repository

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

2. Copy .env.example to .env

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

cp .env.example .env

3. Set your environment variables

Open the .env file and set the necessary environment variables. Example variables include:

# System Configuration
BLOSSOM_PATH="/home/utxo/aegis_blossom"
DB_PATH="db/"

# Relay Metadata
RELAY_NAME="utxo's aegis relay"
RELAY_PUBKEY="e2ccf7cf20403f3f2a4a55b328f0de3be38558a7d5f33632fdaaefc726c1c8eb"
RELAY_DESCRIPTION="premium relay and blossom server"
RELAY_URL="aegis.utxo.one"
RELAY_ICON="https://pfp.nostr.build/d8fb3b6100a0eb9e652bbc34a0c043b7f225dc74e4ed6d733d0e059f9bd444d4.jpg"
RELAY_CONTACT="https://utxo.one"
RELAY_PORT="8080"

# Bitvora & Payment Configuration
BITVORA_API_KEY=""
BITVORA_WEBHOOK_SECRET=""
PRICE_PER_YEAR="100"

4. Setup Bitvora Payments

1. Create an account on Bitvora.
2. Create an API Key with permissions Create lightning invoice
3. Setup a webhook with the following URL: https://yourdomain.com/bitvora_webhook with lightning.deposit.completed event

5. Build the project

Run the following command to build the relay:

go build

6. Create a Systemd Service (optional)

To have the relay run as a service, create a systemd unit file.

1. Create the file:

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

1. Add the following contents:

[Unit]
Description=aegis Relay Service
After=network.target

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

[Install]
WantedBy=multi-user.target

1. Reload systemd to recognize the new service:

sudo systemctl daemon-reload

1. Start the service:

sudo systemctl start aegis

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

sudo systemctl enable aegis

Permission Issues on Some Systems

the relay may not have permissions to read and write to the database. To fix this, you can change the permissions of the database folder:

sudo chmod -R 777 /path/to/db

7. Serving over nginx (optional)

install nginx:

sudo apt-get update
sudo apt-get install nginx

You can serve the relay over nginx by adding the following configuration to your nginx configuration file located at /etc/nginx/sites-available/default:

server {
    listen 80;
    server_name yourdomain.com;

    location / {
        proxy_pass http://localhost:8080;
        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

8. Install Certbot (optional)

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.

8. Access the relay

Once everything is set up, the relay will be running on localhost:8080 or your domain name if you set up nginx.