upleb.uk

Public git repos — served from a NIP-34 GRASP relay at git.upleb.uk

summaryrefslogtreecommitdiff
path: root/nix/example-configuration.nix
blob: 34615be2a5bc08903459765d5c911fb65bd68df7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
# Example NixOS configurations using ngit-grasp module
# 
# Usage:
#   1. Add to your server's flake.nix inputs:
#      inputs.ngit-grasp.url = "github:DanConwayDev/ngit-grasp";
#
#   2. Import the module in your configuration:
#      imports = [ inputs.ngit-grasp.nixosModules.default ];
#
#   3. Configure one or more instances (examples below)

{ inputs, ... }:

{
  imports = [ inputs.ngit-grasp.nixosModules.default ];

  # ============================================================================
  # EXAMPLE 1: Single Instance Configuration
  # ============================================================================

  services.ngit-grasp.production = {
    enable = true;
    domain = "ngit.danconwaydev.com";

    # Network
    bindAddress = "127.0.0.1";
    port = 8082;

    # Storage
    dataDir = "/persistent/ngit-danconwaydev-com-ngit-grasp";

    # Identity
    relayName = "DanConwayDev's ngit-grasp";
    relayDescription =
      "personal instance of ngit-grasp, a Rust GRASP implementation with proactive sync";

    # Option 1: Use nsec file (recommended - more secure)
    relayOwnerNsecFile =
      "/persistent/ngit-danconwaydev-com-ngit-grasp/relay-owner.nsec";

    # Option 2: Inline nsec (less secure, ends up in nix store)
    # relayOwnerNsec = "nsec1...";

    # Option 3: Auto-generate (default if neither above is set)
    # ngit-grasp will create .relay-owner.nsec in dataDir automatically

    # Sync
    syncBootstrapRelayUrl = "wss://relay.ngit.dev";

    # Metrics
    metricsEnabled = true;

    # Logging
    logLevel = "info"; # Options: trace, debug, info, warn, error
  };

  # Caddy reverse proxy for production instance
  services.caddy.virtualHosts."ngit.danconwaydev.com" = {
    extraConfig = ''
      reverse_proxy 127.0.0.1:8082 {
        header_down X-Real-IP {http.request.remote}
        header_down X-Forwarded-For {http.request.remote}
      }
    '';
  };

  # ============================================================================
  # EXAMPLE 2: Multiple Instances on Same Server
  # ============================================================================

  # Uncomment to run multiple instances:

  # # Production instance
  # services.ngit-grasp.prod = {
  #   enable = true;
  #   domain = "ngit.example.com";
  #   port = 8082;
  #   dataDir = "/persistent/ngit-production";
  #   relayName = "Production GRASP Relay";
  #   syncBootstrapRelayUrl = "wss://relay.ngit.dev";
  #   logLevel = "info";
  # };
  # 
  # # Testing/staging instance
  # services.ngit-grasp.staging = {
  #   enable = true;
  #   domain = "ngit-staging.example.com";
  #   port = 8083;
  #   dataDir = "/persistent/ngit-staging";
  #   relayName = "Staging GRASP Relay";
  #   syncBootstrapRelayUrl = "wss://relay.ngit.dev";
  #   logLevel = "debug";  # More verbose logging for testing
  # };
  # 
  # # Development instance with in-memory database
  # services.ngit-grasp.dev = {
  #   enable = true;
  #   domain = "localhost";
  #   bindAddress = "127.0.0.1";
  #   port = 8084;
  #   dataDir = "/tmp/ngit-dev";
  #   databaseBackend = "memory";  # No persistence
  #   relayName = "Development GRASP Relay";
  #   metricsEnabled = false;
  #   logLevel = "trace";  # Maximum verbosity for debugging
  # };
  # 
  # # Caddy configuration for multiple instances
  # services.caddy.virtualHosts = {
  #   "ngit.example.com" = {
  #     extraConfig = "reverse_proxy 127.0.0.1:8082";
  #   };
  #   "ngit-staging.example.com" = {
  #     extraConfig = "reverse_proxy 127.0.0.1:8083";
  #   };
  # };

  # ============================================================================
  # NOTES
  # ============================================================================

  # Instance names (e.g., "production", "prod", "staging") can be anything.
  # They are used for:
  #   - systemd service names: ngit-grasp-<name>
  #   - default user names: ngit-grasp-<name>
  #   - default data directories: /var/lib/ngit-grasp-<name>

  # Systemd service management:
  #   systemctl status ngit-grasp-production
  #   systemctl restart ngit-grasp-staging
  #   journalctl -u ngit-grasp-prod -f

  # Each instance runs as a separate user but shares the same group by default.
  # You can customize user/group per instance if needed.
}