motorx 0.0.18

A reverse-proxy in pure rust.
Documentation 
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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153

{
	"$schema": "http://json-schema.org/draft-07/schema#",
	"$id": "MotorxConfig",
	"title": "Motorx Config",
	"description": "Configuration for Motorx reverse-proxy server.",
	"type": "object",
	"required": ["addr", "rules"],
	"properties": {
		"addr": {
			"description": "Tcp socket the proxy should listen on ex. 127.0.0.1:4000",
			"type": "string"
		},
		"max_connections": {
			"description": "Max number of connections allowed to the proxy. (default 100)",
			"type": "integer"
		},
		"rules": {
			"description": "Rules for routing requests to upstream servers.",
			"type": "array",
			"items": {
				"$ref": "#/definitions/rule"
			},
			"minItems": 1
		},
		"upstreams": {
			"type": "object",
			"additionalProperties": { "$ref": "#/definitions/upstream" },
			"minProperties": 1
		}
	},
	"definitions": {
		"rule": {
			"title": "Rule",
			"description": "Rule for matching and proxying requests.",
			"type": "object",
			"properties": {
				"path": { "$ref": "#/definitions/match_type" },
				"upstream": {
					"description": "Address of upstream server matched requests should be proxied to.",
					"type": "string"
				},
				"match_headers": {
					"description": "Object of header names and matchers to only allow requests with specific headers through.",
					"type": "object",
					"additionalProperties": { "$ref": "#/definitions/match_type" }
				},
				"cache": { "$ref": "#/definitions/cache" }
			},
			"required": ["path", "upstream"]
		},
		"cache": {
			"title": "Cache Settings",
			"description": "Control caching for a rule.",
			"type": "object",
			"properties": {
				"methods": {
					"description": "What methods should have their requests cached",
					"type": "array",
					"minItems": 1,
					"items": {
						"type": "string"
					}
				},
				"max_age": {
					"description": "How long, using `std::time::Duration`'s deserialization until responses are stale.",
					"type": "string"
				}
			}
		},
		"match_type": {
			"title": "Matcher",
			"description": "Match against a subject (ex. path, header, query)",
			"anyOf": [
				{
					"type": "object",
					"requiredProperties": ["start"],
					"properties": {
						"start": {
							"description": "Matches from the start of subject string.",
							"type": "string"
						}
					}
				}
			]
		},
		"authentication_source": {
			"title": "Authentication Source",
			"description": "Where to send request for authentication.",
			"anyOf": [
				{
					"type": "object",
					"requiredProperties": ["path"],
					"properties": {
						"path": {
							"description": "Path to send the request to, on this upstream.",
							"type": "string"
						}
					}
				},
				{
					"type": "object",
					"requiredProperties": ["upstream"],
					"properties": {
						"upstream": {
							"type": "object",
							"requiredProperties": ["name", "path"],
							"properties": {
								"name": {
									"description": "Name of upstream to send requests to for authentication.",
									"type": "string"
								},
								"path": {
									"description": "Path to send the request to, on the other upstream.",
									"type": "string"
								}
							}
						}
					}
				}
			]
		},
		"upstream": {
			"description": "A server which requests can be proxied to",
			"type": "object",
			"properties": {
				"addr": {
					"description": "Address of upstream server.",
					"type": "string"
				},
				"max_connections": {
					"description": "Maximum number of connections to this upstream server.",
					"type": "integer"
				},
				"authentication": {
					"description": "How requests to this upstream should be authorized.",
					"type": "object",
					"requiredProperties": [],
					"properties": {
						"exclude": {
							"description": "Paths to exclude from authentication (ex. /exclude, /exclude/*/with-wildcard)",
							"type": "array",
							"items": {
								"type": "string"
							}
						},
						"source": { "$ref": "#/definitions/authentication_source" }
					}
				}
			},
			"required": ["addr"]
		}
	}
}