1  # Lightning Node Setup Guides
  2  
  3  Comprehensive documentation website for setting up Bitcoin and Lightning Network nodes on Debian and Ubuntu LTS. Optimized for minimal VPS overhead with pruned Bitcoin backends.
  4  
  5  ## 🌐 Live Site
  6  
  7  Visit [ln.fizx.uk](https://ln.fizx.uk) (when deployed)
  8  
  9  ## 📚 Available Guides
 10  
 11  ### LND (Lightning Network Daemon)
 12  - **[LND + Debian LTS](/lnd/debian)** - Complete LND setup with ThunderHub, LNDG, and Balance of Satoshis
 13  - **[LND + Ubuntu LTS](/lnd/ubuntu)** - Same stack for Ubuntu environments
 14  
 15  ### phoenixd (ACINQ Lightning)
 16  - **[phoenixd + Debian LTS](/phoenixd/debian)** - Minimal phoenixd setup with phoenixd-dashboard
 17  - **[phoenixd + Ubuntu LTS](/phoenixd/ubuntu)** - phoenixd for Ubuntu systems
 18  
 19  ## 🔧 Tech Stack
 20  
 21  - **React 18** with TypeScript
 22  - **TailwindCSS** for styling
 23  - **shadcn/ui** components
 24  - **Vite** build tool
 25  - **React Router** for navigation
 26  - **Nostr** integration (via MKStack template)
 27  
 28  ## 🚀 Development
 29  
 30  ```bash
 31  # Install dependencies
 32  npm install
 33  
 34  # Start development server
 35  npm run dev
 36  
 37  # Build for production
 38  npm run build
 39  
 40  # Run tests
 41  npm run test
 42  ```
 43  
 44  ## 📦 What's Included
 45  
 46  Each guide covers:
 47  
 48  ### Core Services
 49  - ✓ Bitcoin Core (bitcoind) with pruned backend (LND guides)
 50  - ✓ Lightning daemon (LND or phoenixd)
 51  - ✓ Web dashboards (ThunderHub, LNDG, phoenixd-dashboard)
 52  - ✓ CLI tools (Balance of Satoshis for LND)
 53  
 54  ### Infrastructure
 55  - ✓ Tor for hidden service access
 56  - ✓ Nginx with SSL/TLS for remote access
 57  - ✓ Docker & Docker Compose
 58  - ✓ ZSH shell configuration
 59  - ✓ Hardware key SSH authentication
 60  - ✓ Firewall configuration (ufw)
 61  
 62  ### VPS Optimizations
 63  - ✓ Pruned Bitcoin backend (5GB) for minimal storage
 64  - ✓ Memory optimization with swap configuration
 65  - ✓ Bandwidth limits and connection management
 66  - ✓ System requirement recommendations
 67  
 68  ## 🎯 Target Audience
 69  
 70  These guides are designed for:
 71  - Users deploying Lightning nodes on VPS instances
 72  - Those seeking minimal-overhead setups
 73  - Operators wanting production-ready configurations
 74  - Anyone following best practices for node security
 75  
 76  ## 📖 Guide Structure
 77  
 78  Each guide includes:
 79  1. **Prerequisites** - System requirements and preparation
 80  2. **Initial Setup** - OS configuration and security hardening
 81  3. **Service Installation** - Step-by-step installation of all components
 82  4. **Configuration** - Production-ready config files
 83  5. **Maintenance** - Backup strategies and update procedures
 84  6. **Troubleshooting** - Common issues and solutions
 85  
 86  ## 🔐 Security Features
 87  
 88  - Hardware key-based SSH authentication (YubiKey support)
 89  - Tor hidden services for privacy
 90  - SSL/TLS encryption via Nginx and Certbot
 91  - Firewall configuration with fail2ban
 92  - Regular backup procedures
 93  
 94  ## 💾 Configuration Files
 95  
 96  Reference configurations included for:
 97  - `bitcoin.conf` - Optimized for pruned VPS deployment
 98  - `lnd.conf` - Production LND configuration with Tor
 99  - `phoenix.conf` - phoenixd configuration
100  - Systemd service files
101  - Nginx reverse proxy configs
102  - Docker Compose setups
103  
104  ## 🌐 Deployment
105  
106  This site is deployed to **GitHub Pages** at [ln.fizx.uk](https://ln.fizx.uk)
107  
108  ### Automatic Deployment
109  
110  The site automatically deploys when you push to the `main` branch:
111  
112  1. **Push to main branch** - GitHub Actions will automatically build and deploy
113  2. **Wait ~1-2 minutes** - The workflow builds the site and deploys to GitHub Pages
114  3. **Visit ln.fizx.uk** - Your changes are live!
115  
116  ### GitHub Pages Setup
117  
118  Required configuration (already done):
119  
120  1. ✅ Repository name: `xjmzx.github.io`
121  2. ✅ Custom domain: `ln.fizx.uk` (set in repository settings)
122  3. ✅ CNAME record in DNS pointing to `xjmzx.github.io`
123  4. ✅ CNAME file in `/public/CNAME`
124  5. ✅ GitHub Actions workflow in `.github/workflows/deploy.yml`
125  
126  ### Manual Deployment
127  
128  If you need to deploy manually:
129  
130  ```bash
131  # Build the project
132  npm run build
133  
134  # The dist folder is ready to deploy
135  # GitHub Actions will handle deployment automatically
136  ```
137  
138  ### Alternative Hosting
139  
140  The site can also be deployed to:
141  - Netlify
142  - Vercel
143  - Any static hosting service
144  
145  ## 📄 License
146  
147  This documentation is open source and available for use under the MIT License.
148  
149  ## 🤝 Contributing
150  
151  Contributions welcome! This guide is built with [Shakespeare](https://shakespeare.diy).
152  
153  ## ⚠️ Disclaimer
154  
155  These guides are provided as-is for educational purposes. Always:
156  - Test with small amounts first
157  - Backup your seed phrases securely
158  - Understand the risks of running Lightning nodes
159  - Keep software updated
160  - Follow security best practices
161  
162  **Mainnet = Real Bitcoin!** ⚡
163  
164  ## 📞 Support
165  
166  For issues or questions:
167  - Open an issue on GitHub
168  - Join Lightning Network community forums
169  - Consult the official documentation:
170    - [Bitcoin Core](https://bitcoincore.org)
171    - [LND](https://github.com/lightningnetwork/lnd)
172    - [phoenixd](https://github.com/ACINQ/phoenixd)
173  
174  ## 🎨 Built With
175  
176  This site was created with [Shakespeare](https://shakespeare.diy) - an AI-powered web development platform.