-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathindex.html
220 lines (188 loc) · 9.57 KB
/
index.html
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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
<!doctype html>
<!--[if lt IE 7]> <html class="lt-ie9 lt-ie8 lt-ie7 documentation"> <![endif]-->
<!--[if IE 7]> <html class="lt-ie9 lt-ie8 documentation"> <![endif]-->
<!--[if IE 8]> <html class="lt-ie9 documentation"> <![endif]-->
<!--[if gt IE 8]><!--> <html lang="en" class="documentation"> <!--<![endif]-->
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Documentation — Vulcand documentation 2.0 documentation</title>
<link rel="stylesheet" href="_static/main.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '2.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="Vulcand documentation 2.0 documentation" href="#" />
<link rel="next" title="Quick Start" href="quickstart.html" />
<link media="only screen and (max-device-width: 480px)" href="_static/mobile.css" type="text/css" rel="stylesheet" />
<link rel="icon" type="image/png" href="_static/img/favicon.png" />
<!-- <link rel="stylesheet" href="_static/docs.css" /> -->
<link rel="stylesheet" href="http://www.mailgun.com/static/css/main.css" />
<meta name="viewport" content="width=device-width">
</head>
<body role="document">
<header style="content:none">
<div class="container">
<a href="http://github.com/mailgun/vulcand/" style="float:left;margin-top:20px;margin-bottom:20px;background:url(_static/img/vulcan.png) no-repeat">
<img src="_static/img/vulcan.png">
</img>
</a>
<nav class="header-nav" id="js-header-nav">
<a href="//www.vulcanproxy.com" class="active"><b>Documentation</b></a>
</nav>
<button id="js-show-nav"><i class="icon-reorder"></i></button>
</div>
</header>
<div id="body">
<section class="subnav">
<div class="container">
<a target="blank" href="https://github.com/mailgun/vulcand-docs" class="edit-docs-link" onclick="mixpanel.track('Clicked Edit Docs Link');">Edit</a>
<ul id="headerButtons" class="nav nav-pills">
<li class="lang-label">
Samples:
</li>
<li class="lang">
<a href="" id="lang_etcd">Etcd</a>
</li>
<li class="lang">
<a href="" id="lang_cli">Vulcanctl</a>
</li>
<li class="lang">
<a href="" id="lang_api">API</a>
</li>
</ul>
</div>
</section>
<section class="main">
<div class="container">
<aside id="sphinxsidebar" class="docs-sidebar">
<div class="sphinxsidebarwrapper">
<ul><li class="toctree-l1"><a href="#">Main Page</a></li></ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quick Start</a></li>
<li class="toctree-l1"><a class="reference internal" href="proxy.html">User Manual</a></li>
<li class="toctree-l1"><a class="reference internal" href="middlewares.html">Middlewares</a></li>
<li class="toctree-l1"><a class="reference internal" href="api.html">API Reference</a></li>
</ul>
</div>
</aside>
<div class="document">
<div id="st-results-container"></div>
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="documentation">
<h1>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h1>
<p>Vulcand is a reverse proxy for HTTP API management and microservices. It is inspired by <a class="reference external" href="https://github.com/Netflix/Hystrix">Hystrix</a>.</p>
<p>It uses Etcd as a configuration backend, so changes to configuration take effect immediately without restarting the service.</p>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">Status: Under active development. Used at Mailgun on moderate workloads.</p>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Version used in this documentation: <code class="docutils literal"><span class="pre">v0.8.0-beta.2</span></code></p>
</div>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quick Start</a><ul>
<li class="toctree-l2"><a class="reference internal" href="quickstart.html#example-setting-up-vulcand">Example: setting up Vulcand</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="proxy.html">User Manual</a><ul>
<li class="toctree-l2"><a class="reference internal" href="proxy.html#glossary">Glossary</a></li>
<li class="toctree-l2"><a class="reference internal" href="proxy.html#configuration">Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="proxy.html#tls">TLS</a></li>
<li class="toctree-l2"><a class="reference internal" href="proxy.html#metrics">Metrics</a></li>
<li class="toctree-l2"><a class="reference internal" href="proxy.html#logging">Logging</a></li>
<li class="toctree-l2"><a class="reference internal" href="proxy.html#process-management">Process management</a></li>
<li class="toctree-l2"><a class="reference internal" href="proxy.html#installation">Installation</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="middlewares.html">Middlewares</a><ul>
<li class="toctree-l2"><a class="reference internal" href="middlewares.html#id2">Middlewares</a></li>
<li class="toctree-l2"><a class="reference internal" href="middlewares.html#middleware-chains">Middleware Chains</a></li>
<li class="toctree-l2"><a class="reference internal" href="middlewares.html#vbundle">Vbundle</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api.html">API Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api.html#status">Status</a></li>
<li class="toctree-l2"><a class="reference internal" href="api.html#log-severity">Log severity</a></li>
<li class="toctree-l2"><a class="reference internal" href="api.html#host">Host</a></li>
<li class="toctree-l2"><a class="reference internal" href="api.html#listener">Listener</a></li>
<li class="toctree-l2"><a class="reference internal" href="api.html#backend">Backend</a></li>
<li class="toctree-l2"><a class="reference internal" href="api.html#server">Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="api.html#frontend">Frontend</a></li>
<li class="toctree-l2"><a class="reference internal" href="api.html#rate-limit">Rate limit</a></li>
<li class="toctree-l2"><a class="reference internal" href="api.html#connection-limit">Connection limit</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p><a href="https://github.com/mailgun/vulcand">Found a typo? Send a pull request!</a></p>
<P>Docs created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.3.3.</P>
</div>
<div class="clearer"></div>
</div>
</div> <!-- /content -->
</section> <!-- /container -->
</div> <!-- /body -->
<footer>
<div class="container">
<nav class="footer-nav">
<a href="http://twitter.com/mail_gun">Mailgun Twitter</a>
<a href="http://vulcan.ghost.io">Blog</a>
</nav>
</div>
</footer>
<script type="text/javascript" charset="utf-8" src="_static/toc.js"></script>
<script type="text/javascript" charset="utf-8" src="_static/jquery.debounce.min.js"></script>
<script type="text/javascript" charset="utf-8" src="_static/jquery.cookie.min.js"></script>
<script type="text/javascript" charset="utf-8" src="_static/jquery.viewport.min.js"></script>
<script type="text/javascript" charset="utf-8" src="_static/samples.js"></script>
<script type="text/javascript" charset="utf-8" src="_static/scroll_hash.js"></script>
<script type="text/javascript" charset="utf-8" src="_static/underscore-min.js"></script>
<script type="text/javascript">
window.underscore = _.noConflict();
</script>
<script type="text/javascript">
$('input[type=\"search\"]').wrap('<span style=\"position:relative;\"></span>').after('<i id="clear-search" class="icon-remove-sign" style=\"position:absolute; right:5px;line-height:26px;\"></i><i class="icon-search" style=\"position:absolute; left:5px;line-height:26px;\"></i>');
$('#clear-search').click(function(){
$(this).parent().find('input').val('');
$(this).parent().find('input').focus();
});
// $("input").focusout(function() {this.value = "";});
// Responsive navigation show/hide main nav
$("#js-show-nav").click(function(){
$("#js-header-nav").slideToggle();
});
// highlight nav on load
$(document).ready(function(){
$('.docs-sidebar li').removeClass('active');
$('.docs-sidebar ul.current li.current a.current').parent().addClass('active');
});
</script>
<script type="text/javascript">
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-55222876-1', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>