add readme

Author: nGoline

Diff for: LnAddress.Net.sln

@@ -17,11 +17,6 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "custom_lnd", "custom_lnd",
 		tests\Docker\custom_lnd\bashrc = tests\Docker\custom_lnd\bashrc
 	EndProjectSection
 EndProject
-Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "docker", "docker", "{8252A03E-5DBF-4930-8A02-15E10D3CBBC3}"
-	ProjectSection(SolutionItems) = preProject
-		docker\docker-compose.yml = docker\docker-compose.yml
-	EndProjectSection
-EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU

Diff for: README.md

@@ -0,0 +1,109 @@
+# LnAddress.Net
+
+**LnAddress.Net** is a service that allows you to receive Lightning payments using any username at your domain. For
+example: `[email protected]`.
+
+## Overview
+
+- **Docker Image**: A pre-built Docker image is available
+  at [ipmsio/lnaddress.net](https://hub.docker.com/r/ipmsio/lnaddress.net).
+- **Configuration Reference**: Review the [docker-compose.yml](docker-compose.yml) file for a complete list of
+  environment variables and configuration options.
+- **Reverse Proxy Setup**: An example Nginx configuration is provided in [example.nginx](example.nginx).
+
+## Getting Started
+
+1. **Pull the Docker Image**:
+
+   ```bash
+   docker pull ipmsio/lnaddress.net:latest
+   ```
+
+2. **Review Configuration Variables**:
+
+   Check the [docker-compose.yml](docker-compose.yml) file for environment variables. These variables allow you to:
+
+    - Configure connection details to your LND instance.
+    - Adjust limits for payment amounts or comment fields.
+
+3. **Set Up Nginx (Optional)**:
+
+   For a production setup, use [example.nginx](example.nginx) as a guide to set up a reverse proxy with TLS termination.
+
+## Connecting to LND
+
+To enable Lightning payments, you need to connect LnAddress.Net to your LND instance. You will need:
+
+- The **TLS certificate** (`tls.cert`)
+- The **admin.macaroon** in base64 format
+- The **LND RPC server endpoint**
+
+**Steps to Obtain LND Credentials**:
+
+1. **TLS Certificate**:
+
+   Extract the certificate content between the `-----BEGIN CERTIFICATE-----` and `-----END CERTIFICATE-----` lines.
+
+   ```bash
+   cat /.lnd/tls.cert
+   ```
+
+   Copy only the certificate portion without the header and footer lines.
+
+2. **Admin Macaroon**:
+
+   Convert the `admin.macaroon` to a single-line base64 string:
+
+   ```bash
+   base64 /.lnd/data/chain/bitcoin/mainnet/admin.macaroon | tr -d '\n'
+   ```
+
+3. **RPC Server URL**:
+
+   Set your LND RPC endpoint, for example:
+
+   ```bash
+   https://<lnd-ip>:10009 
+   ```
+
+   Ensure your `lnd.conf` includes:
+
+   ```ini
+   rpclisten=0.0.0.0:10009
+   ```
+
+   This makes LND’s RPC interface accessible to LnAddress.Net.
+
+## Default Settings
+
+- **MinSendable**: 1,000 millisatoshis (1 satoshi)
+- **MaxSendable**: 100,000,000 millisatoshis (100,000 satoshis)
+- **MaxCommentAllowed**: 0 (no comments accepted)
+
+If these defaults don’t meet your needs, adjust them via environment variables as shown
+in [docker-compose.yml](docker-compose.yml).
+
+## Running the Service
+
+Once you have your environment variables set and Docker is ready, you can run:
+
+```bash
+docker-compose up -d
+```
+
+or, if running standalone:
+
+```bash
+docker run -d \
+  -p 80:80 \
+  -e LND_TLS_CERT="<base64_tls_cert>" \
+  -e LND_MACAROON="<base64_admin_macaroon>" \
+  -e LND_SERVER_URL="https://<lnd-ip>:10009" \
+  ipmsio/lnaddress.net:latest
+```
+
+Replace the environment variables with your actual values.
+
+---
+
+**You’re now set up to receive Lightning payments via username addresses on your domain!**

Diff for: docker/docker-compose.yml renamed to docker-compose.yml

@@ -2,7 +2,7 @@ services:
   lnaddress.net:
     image: ipmsio/lnaddress.net:latest
     ports:
-      - "64260:80"
+      - "65535:80"
     networks:
       - app-network
     environment:
@@ -13,14 +13,14 @@ services:
       - LND__RPCADDRESS=https://your.lnd.address:10009
       - INVOICE__MINSENDABLE=10000
       - INVOICE__MAXSENDABLE=100000000
-      - INVOICE_MAXCOMMENTALLOWED=255
+      - INVOICE__MAXCOMMENTALLOWED=255
     restart: unless-stopped
     healthcheck:
-      test: ["CMD", "curl", "-f", "http://localhost:80/health"]
+      test: [ "CMD", "curl", "-f", "http://localhost:80/health" ]
       interval: 30s
       timeout: 10s
       retries: 3
 
 networks:
   app-network:
-    driver: bridge
+    driver: bridge

Diff for: example.nginx

@@ -0,0 +1,27 @@
+server {
+    server_name your.domain;
+    root /var/www/your.domain;
+    index index.html;
+
+    # make sure this two blocks comes first
+    location /.well-known/lnurlp/ {
+        proxy_pass http://localhost:65535;
+        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;
+    }
+
+    location /lnurl/ {
+        proxy_pass http://localhost:65535;
+        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;
+    }
+
+    # the rest of you server code
+    location / {
+        try_files $uri $uri/ =404;
+    }
+}