Alienos

The Alienos is a Nostr stack (relay/blossom mediaserver/nip-05 server) which is manageable (using nip-86) and plugin-able. We designed it for self-hosting and backups.

This project is based on Khatru, EventStore, BlobStore and go-nostr.

Landing Page

Features

• Support NIPs: 1, 9, 11, 40, 42, 50, 56, 59, 70, 86.
• Support BUDs: 1, 2, 4, 6, 9.
• NIP-05 server.
• Manageable using NIP-86.
• Landing page with NIP-11 document.
• S3 backups (relay dbs/blobs/nip05 data/management info).
• Moderator notifications.
• StartOS support.
• Umbrel support.
• Support plugins.
• Running on Tor.
• S3 as blossom target.
• Colorful Console/File logger.

How to set it up?

VPS

In this guide we explain how you can run a alienos instance on your VPS using docker and nginx or without docker.

1. Prerequisites:

This project min requirements to be run is as below:

• CPU: 0.5 vCore
• Memory: 500MB
• Storage: Depends on your database size.

You need to by a server form your preferred provider and obtain ssh access to it. Its recommended to use debian/ubuntu distribution.

2. Domain name (optional): you can buy a domain name from your preferred provider to use for your relay. its recommended to do that.

3. Install Docker and Docker-compose:

sudo apt update
sudo apt install -y docker.io
sudo apt install -y docker-compose

4. Clone this repository:

git clone https://github.com/dezh-tech/alienos.git
cd alienos

5. Setup your config:

cp .env.example .env
nano .env

It would open a file that allows you to edit config file. Each field contains an example and comment as documentation. Make sure you read them.

Warning

Technical note: If you chained port config, don't forget to update it on docker-compose.yaml as well.

Use Ctrl+O+Enter and then Ctrl+X to save and exit.

6. Build and run:

Use this command to build and run your image:

docker-compose up --build -d

---

Setting up a domain (optional/recommended):

Using this command install nginx:

sudo apt install nginx

Setup your domain:

sudo nano /etc/nginx/sites-available/<your-domain.com>

Replace it with your domain excluding the < and >.

Paste the example config there and replace your domain.

Use Ctrl+O+Enter and then Ctrl+X to save and exit.

Enable the Nginx config:

sudo ln -s /etc/nginx/sites-available/<your-domain.com> /etc/nginx/sites-enabled/

Restart Nginx:

sudo systemctl restart nginx

Setup SSL (optional/recommended):

sudo apt install certbot python3-certbot-nginx
sudo certbot --nginx -d <your-domain.com>

Then follow the prompts and provide required info to set up the SSL.

Now your alienos server must be available using wss://you-domain.com and wss://youe-ip:port.

Relay tools

TODO.

Umbrel

TODO.

StartOS

TODO.

Limitations

This project is highly suitable for personal, community, team and backup usage since its light-weight, feature-full and easy to setup/manage.

If you are aiming to run a relay/nip-05 server/blossom media server for large scale and high load (as a paid relay, default relay fo your client or a public global relay) you can consider using the Immortal relay and its adjacent projects.

Contribution

All kinds of contributions are welcome!

Donation

Donations and financial support for the development process are possible using Bitcoin and Lightning:

on-chain:

bc1qa0z44j7m0v0rx85q0cag5juhxdshnmnrxnlr32

lightning:

[email protected]