add setup docs.

Author: kehiy

.env.example

@@ -8,20 +8,20 @@ ALIENOS_WORK_DIR="alienos_wd/"
 
 # Relay information document (NIP-11)
 ALIENOS_RELAY_NAME="Alienos"
-ALIENOS_RELAY_ICON=""
-ALIENOS_RELAY_BANNER=""
+ALIENOS_RELAY_ICON="https://nostr.download/6695de4b095cd99ee7b4f6e2ef9ff89a9029efc1a017e60b8b5b5cb446b2c1e0.webp"
+ALIENOS_RELAY_BANNER="https://nostr.download/5b3fa3e40365061d58946fdb1bc6549a4675186591f9f589f9983895bfac8940.webp"
 ALIENOS_RELAY_DESCRIPTION="A self-hosting Nostr stack!"
 ALIENOS_RELAY_PUBKEY="badbdda507572b397852048ea74f2ef3ad92b1aac07c3d4e1dec174e8cdc962a"
 ALIENOS_RELAY_CONTACT="hi@dezh.tech"
 
-# Set a private key here. this would be used to send system notifications to admin (alienos_RELAY_PUBKEY) as DM.
+# Set a private key here. this would be used to send system notifications to admin (ALIENOS_RELAY_PUBKEY) as DM.
 # Warning: don't use your main key. generate a key only for this purpose.
 ALIENOS_RELAY_SELF="b80a9c92d74c5d8067cc7b39e93999ce1c69cd44fa66f46387b863f3a6dc25e0" # not safe! just for example.
 
 # Network
 ALIENOS_RELAY_PORT=":7771"
 ALIENOS_RELAY_BIND="0.0.0.0"
-ALIENOS_RELAY_URL="alienos.jellyfish.land"
+ALIENOS_RELAY_URL="nostr.kehiy.net"
 
 # Backup Info
 ALIENOS_BACKUP_ENABLE="false"

README.md

@@ -26,7 +26,6 @@ This project is based on [Khatru](https://github.com/fiatjaf/khatru), [EventStor
 - [X] Manageable using NIP-86.
 - [X] Landing page with NIP-11 document.
 - [X] S3 backups (relay dbs/blobs/nip05 data/management info).
-- [ ] Full setup document.
 - [ ] Moderator notifications.
 - [ ] StartOS support.
 - [ ] Umbrel support.
@@ -36,13 +35,106 @@ This project is based on [Khatru](https://github.com/fiatjaf/khatru), [EventStor
 
 ### VPS
 
-> TODO.
+In this guide we explain how you can run a alienos instance on your VPS using docker and nginx or without docker.
 
-#### Docker
+1. Prerequisites:
 
-> TODO.
+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:
+
+```bash
+sudo apt update
+sudo apt install -y docker.io
+sudo apt install -y docker-compose
+```
+
+4. Clone this repository:
+
+```bash
+git clone https://github.com/dezh-tech/alienos.git
+cd alienos
+```
+
+5. Setup your config:
+
+```bash
+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:
+
+```bash
+docker-compose up --build -d
+```
+
+---
+
+#### Setting up a domain (optional/recommended):
+
+Using this command install nginx:
+
+```bash
+sudo apt install nginx
+```
+
+Setup your domain:
+
+```bash
+sudo nano /etc/nginx/sites-available/<your-domain.com>
+```
+
+> Replace it with your domain excluding the < and >.
+
+Paste the [example config](nginx.conf) there and replace your domain.
+
+Use Ctrl+O+Enter and then Ctrl+X to save and exit.
+
+Enable the Nginx config:
+
+```bash
+sudo ln -s /etc/nginx/sites-available/<your-domain.com> /etc/nginx/sites-enabled/
+```
+
+Restart Nginx:
+
+```bash
+sudo systemctl restart nginx
+```
+
+Setup SSL (optional/recommended):
+
+```bash
+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`.
 
-#### OS
+### Relay tools
 
 > TODO.
 

docker-compose.yml

@@ -0,0 +1,8 @@
+version: '3.8'
+
+services:
+  alienos:
+    build: .
+    env_file: .env
+    ports:
+      - "7771:7771"

dockerfile

@@ -0,0 +1,19 @@
+FROM golang:1.23.3-alpine AS builder
+
+WORKDIR /app
+
+COPY go.mod go.sum ./
+
+RUN go mod download
+
+COPY . .
+
+RUN go build -o alienos --tags libsecp256k1
+
+FROM alpine:latest
+
+COPY --from=builder /app/alienos /usr/local/bin/alienos
+
+EXPOSE 7771
+
+CMD ["alienos"]

nginx.conf

@@ -0,0 +1,32 @@
+server {
+    listen 80;
+    server_name <your-domain.com>;
+
+    location / {
+        proxy_pass http://localhost:7771;
+        proxy_http_version 1.1;
+        proxy_set_header Upgrade $http_upgrade;
+        proxy_set_header Connection 'upgrade';
+        proxy_set_header Host $host;
+        proxy_cache_bypass $http_upgrade;
+    }
+
+    return 301 https://$host$request_uri;
+}
+
+server {
+    listen 443 ssl;
+    server_name <your-domain.com>;
+
+    ssl_certificate /etc/letsencrypt/live/your-domain.com/fullchain.pem; # Managed by certbot
+    ssl_certificate_key /etc/letsencrypt/live/your-domain.com/privkey.pem; # Managed by certbot
+
+    location / {
+        proxy_pass http://localhost:7771;
+        proxy_http_version 1.1;
+        proxy_set_header Upgrade $http_upgrade;
+        proxy_set_header Connection 'upgrade';
+        proxy_set_header Host $host;
+        proxy_cache_bypass $http_upgrade;
+    }
+}

utils.go

@@ -7,7 +7,6 @@ import (
 )
 
 func Mkdir(path string) error {
-	// create the directory
 	if err := os.MkdirAll(path, 0o750); err != nil {
 		return fmt.Errorf("could not create directory %s", path)
 	}
@@ -20,7 +19,6 @@ func ReadFile(filename string) ([]byte, error) {
 }
 
 func WriteFile(filename string, data []byte) error {
-	// create directory
 	if err := Mkdir(filepath.Dir(filename)); err != nil {
 		return err
 	}

version.go

@@ -5,10 +5,10 @@ import "fmt"
 // These constants follow the semantic versioning 2.0.0 spec.
 // see: http://semver.org
 var (
-	major = 0
+	major = 1
 	minor = 0
-	patch = 1
-	meta  = "beta"
+	patch = 0
+	meta  = ""
 )
 
 func StringVersion() string {