feat: readme

README.md

@@ -0,0 +1,94 @@
+## LNVPS
+
+A bitcoin powered VPS system.
+
+## Requirements
+
+- MySql database
+- LND node
+- Proxmox server
+
+## Required Config
+
+```yaml
+# MySql database connection string
+db: "mysql://root:root@localhost:3376/lnvps"
+
+# LND node connection details
+lnd:
+  url: "https://127.0.0.1:10003"
+  cert: "$HOME/.lnd/tls.cert"
+  macaroon: "$HOME/.lnd/data/chain/bitcoin/mainnet/admin.macaroon"
+  
+# Number of days after a VM expires to delete
+delete_after: 3
+
+# Provisioner is the main process which handles creating/deleting VM's
+# Currently supports: Proxmox
+provisioner:
+  proxmox:
+    # Read-only mode prevents spawning VM's
+    read_only: false
+    # Proxmox (QEMU) settings used for spawning VM's
+    qemu:
+      bios: "ovmf"
+      machine: "q35"
+      os_type: "l26"
+      bridge: "vmbr0"
+      cpu: "kvm64"
+      vlan: 100
+      kvm: false
+```
+
+### Email notifications
+Email notifications can be enabled, this is primarily intended for admin notifications.
+
+```yaml
+# (Optional) 
+# Email notifications settings
+smtp:
+  # Admin user id, used to send notifications of failed jobs etc. (optional)
+  admin: 1
+  # SMTP server url
+  server: "smtp.gmail.com"
+  # From header used in the email (optional)
+  from: "LNVPS <no-reply@example.com>"
+  username: "no-reply@example.com"
+  password: "mypassword123"
+```
+
+### Nostr notifications (NIP-17)
+
+```yaml
+# (Optional) 
+# Nostr connection settings for notifications
+nostr:
+  # Nostr relays to publish notifications to
+  relays:
+    - "wss://relay.snort.social"
+    - "wss://relay.damus.io"
+    - "wss://nos.lol"
+  # Private key used to sign notifications
+  nsec: "nsec1234xxx"
+```
+
+### Network Setup (Advanced)
+
+When ARP is disabled (reply-only) on your router you may need to create static ARP entries when allocating 
+IPs, we support managing ARP entries on routers directly as part of the provisioning process.
+
+```yaml
+# (Optional) 
+# When allocating IPs for VM's it may be necessary to create static ARP entries on 
+# your router, at least one router can be configured
+#
+# Currently supports: Mikrotik
+router:
+  mikrotik:
+    # !! MAKE SURE TO USE HTTPS !!
+    url: "https://my-router.net"
+    username: "admin"
+    password: "admin"
+    # Interface where the static ARP entry is added
+    arp_interface: "bridge1"
+```