···

       
1
       
 
       
# `_utils.mkSimpleProxy`

     

       
2
       
-
       
`{port, protocol, location, websockets, extraConfig} -> freeformAttrset`

     

       
3
       
 
       


     

       
4
       
 
       
make a simple reverse proxy

     

       
5
       
 
       


     

       
6
       
 
       
takes a set:

     

       
7
       
 
       
```nix

     

       
8
       
 
       
{

     

       
0
       
 
       

     

       
9
       
 
       
  port ? null,

     

       
10
       
 
       
  socketPath ? null,

     

       
11
       
 
       
  protocol ? "http",

     

···

       
1
       
 
       
# `_utils.mkSimpleProxy`

     

       
2
       
+
       
`attrSet -> freeformAttrset`

     

       
3
       
 
       


     

       
4
       
 
       
make a simple reverse proxy

     

       
5
       
 
       


     

       
6
       
 
       
takes a set:

     

       
7
       
 
       
```nix

     

       
8
       
 
       
{

     

       
9
       
+
       
  host ? "localhost", # proxying servers on the network

     

       
10
       
 
       
  port ? null,

     

       
11
       
 
       
  socketPath ? null,

     

       
12
       
 
       
  protocol ? "http",

     

···

       
25
       
 
       


     

       
26
       
 
       
        # To override, mkForce {}

     

       
27
       
 
       
        locations."= /robots.txt" = mkNginxFile {

     

       
28
       
-
       
          status = 502;

     

       
29
       
 
       
          filename = "robots.txt";

     

       
30
       
 
       
          content = ''

     

       
31
       
 
       
            # Please stop hammering and/or scraping our services.

     
···

       
50
       
 
       


     

       
51
       
 
       
  mkSimpleProxy = {

     

       
52
       
 
       
    protocol ? "http",

     

       
0
       
 
       

     

       
53
       
 
       
    port ? null,

     

       
54
       
 
       
    socketPath ? null,

     

       
55
       
 
       
    location ? "/",

     
···

       
59
       
 
       
    assert lib.assertMsg (port != null || socketPath != null) "one of port or socketPath must be specified";

     

       
60
       
 
       
    # i dislike logic gates

     

       
61
       
 
       
    assert lib.assertMsg (!(port != null && socketPath != null)) "only one of port or socketPath may be specified at the same time";

     

       
0
       
 
       

     

       
62
       
 
       
    assert lib.assertMsg (port != null -> builtins.isInt port) "port must be an integer if specified";

     

       
63
       
 
       
      mkVhost (lib.mkMerge [

     

       
64
       
 
       
        extraConfig

     
···

       
68
       
 
       
              "${protocol}://"

     

       
69
       
 
       
              + (

     

       
70
       
 
       
                if (socketPath == null)

     

       
71
       
-
       
                then "localhost:${builtins.toString port}"

     

       
72
       
 
       
                else "unix:${socketPath}"

     

       
73
       
 
       
              );

     

       
74
       
 
       
            proxyWebsockets = websockets;

     
···

       
110
       
 
       
  mkNginxFile = {

     

       
111
       
 
       
    filename ? "index.html",

     

       
112
       
 
       
    content,

     

       
113
       
-
       
    status ? 200,

     

       
114
       
 
       
  }:

     

       
115
       
 
       
    builtins.addErrorContext "while creating a static nginx file ${filename}" (

     

       
116
       
 
       
      let

     
···

       
119
       
 
       
          builtins.toString (pkgs.writeTextDir filename content) + "/";

     

       
120
       
 
       
      in {

     

       
121
       
 
       
        alias = contentDir;

     

       
122
       
-
       
        tryFiles = "${filename} =${builtins.toString status}";

     

       
123
       
 
       
      }

     

       
124
       
 
       
    );

     

       
125
       
 
       


     

···

       
25
       
 
       


     

       
26
       
 
       
        # To override, mkForce {}

     

       
27
       
 
       
        locations."= /robots.txt" = mkNginxFile {

     

       
0
       
 
       

     

       
28
       
 
       
          filename = "robots.txt";

     

       
29
       
 
       
          content = ''

     

       
30
       
 
       
            # Please stop hammering and/or scraping our services.

     
···

       
49
       
 
       


     

       
50
       
 
       
  mkSimpleProxy = {

     

       
51
       
 
       
    protocol ? "http",

     

       
52
       
+
       
    host ? "localhost",

     

       
53
       
 
       
    port ? null,

     

       
54
       
 
       
    socketPath ? null,

     

       
55
       
 
       
    location ? "/",

     
···

       
59
       
 
       
    assert lib.assertMsg (port != null || socketPath != null) "one of port or socketPath must be specified";

     

       
60
       
 
       
    # i dislike logic gates

     

       
61
       
 
       
    assert lib.assertMsg (!(port != null && socketPath != null)) "only one of port or socketPath may be specified at the same time";

     

       
62
       
+
       
    assert lib.assertMsg (socketPath != null -> host == "localhost") "setting host has no effect when socketPath is set";

     

       
63
       
 
       
    assert lib.assertMsg (port != null -> builtins.isInt port) "port must be an integer if specified";

     

       
64
       
 
       
      mkVhost (lib.mkMerge [

     

       
65
       
 
       
        extraConfig

     
···

       
69
       
 
       
              "${protocol}://"

     

       
70
       
 
       
              + (

     

       
71
       
 
       
                if (socketPath == null)

     

       
72
       
+
       
                then "${host}:${builtins.toString port}"

     

       
73
       
 
       
                else "unix:${socketPath}"

     

       
74
       
 
       
              );

     

       
75
       
 
       
            proxyWebsockets = websockets;

     
···

       
111
       
 
       
  mkNginxFile = {

     

       
112
       
 
       
    filename ? "index.html",

     

       
113
       
 
       
    content,

     

       
0
       
 
       

     

       
114
       
 
       
  }:

     

       
115
       
 
       
    builtins.addErrorContext "while creating a static nginx file ${filename}" (

     

       
116
       
 
       
      let

     
···

       
119
       
 
       
          builtins.toString (pkgs.writeTextDir filename content) + "/";

     

       
120
       
 
       
      in {

     

       
121
       
 
       
        alias = contentDir;

     

       
122
       
+
       
        tryFiles = "${filename} =500"; # if it can't find the file something has gone wrong.

     

       
123
       
 
       
      }

     

       
124
       
 
       
    );

     

       
125