Added README and shell

This commit is contained in:
jeirmeister 2025-07-18 11:03:43 -07:00
parent 4327e30ed4
commit 11c5cd382e
2 changed files with 40 additions and 0 deletions

33
README.md Normal file
View file

@ -0,0 +1,33 @@
# BTCPay Server Deployment
This project deploys a BTCPay Server with a Bitcoin node using Nix.
## Prerequisites
- **Nix package manager** - If you're not using NixOS, install from https://nixos.org/download/
- **SSH keys configured** for root access to your target server
## Setup
1. **Configure your server**: Edit `REMOTE_HOST` in `justfile` to point to your server
2. **SSH access**: Ensure you have SSH keys configured for root access to your target server
## Quick Start
```bash
# Enter development environment (provides just automatically)
nix-shell
# Build configuration
just build
# Deploy to server
just deploy
# Check status
just status
```
## What You Need
The `shell.nix` provides `just` and everything else needed. If you already have `just` installed, you can skip `nix-shell` and run the commands directly.