-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathindex.html
executable file
·283 lines (182 loc) · 11.2 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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Welcome to Rumal’s documentation! — Rumal 0.0.1 alpha documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="top" title="Rumal 0.0.1 alpha documentation" href="#"/>
<link rel="next" title="Introduction" href="intro.html"/>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="#" class="icon icon-home"> Rumal
</a>
<div class="version">
0.0.1 alpha
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="architecture.html">Architecture</a></li>
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="docker.html">Docker</a></li>
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart</a></li>
<li class="toctree-l1"><a class="reference internal" href="advancedusage.html">Advanced Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="social.html">Rumal Social</a></li>
<li class="toctree-l1"><a class="reference internal" href="advancedsearch.html">Advanced Search</a></li>
<li class="toctree-l1"><a class="reference internal" href="plugins.html">Plugins</a></li>
<li class="toctree-l1"><a class="reference internal" href="development.html">Development</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">Rumal</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="#">Docs</a> »</li>
<li>Welcome to Rumal’s documentation!</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="welcome-to-rumal-s-documentation">
<h1>Welcome to Rumal’s documentation!<a class="headerlink" href="#welcome-to-rumal-s-documentation" title="Permalink to this headline">¶</a></h1>
<p>From Wikipedia, the free encyclopedia:</p>
<blockquote>
<div>A rumāl is a piece of clothing similar to a handkerchief or bandana. [...] The rumāl was used by the Thugs in India as a method of strangulation. A coin was knotted in one end of the scarf, and would be swung around the neck of the victim; who would then be strangled in the most brutal and abhorrent manner.</div></blockquote>
<p>This project aims to be <a class="reference external" href="http://buffer.github.io/thug/">Thug</a>’s dress - providing a convenient web GUI - but also its weapon, as it should provide a set of tools that should enrich Thug’s output with new metadata and allow for correlation of results.</p>
<p>While it is perfectly possible to use it as a simple web GUI for Thug on your own computer, with you as the only user, Rumāl has been designed to support multi-user environments, where a single back-end can serve to multiple front-ends. Also, work is in progress to extend Rumal so that that you can comfortably share your results, settings, etc. resulting in easy collaboration with other users.</p>
<div class="section" id="user-guide">
<h2>User Guide:<a class="headerlink" href="#user-guide" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a><ul>
<li class="toctree-l2"><a class="reference internal" href="intro.html#features">Features</a></li>
<li class="toctree-l2"><a class="reference internal" href="intro.html#license">License</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="architecture.html">Architecture</a><ul>
<li class="toctree-l2"><a class="reference internal" href="architecture.html#communications">Communications</a></li>
<li class="toctree-l2"><a class="reference internal" href="architecture.html#communication-configuration">Communication Configuration</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="install.html#frontend-gui">Frontend-GUI</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#running-rumal-s-front-end">Running Rumal’s front-end</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#back-end">Back-end</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#running-rumal-s-backend">Running Rumal’s backend</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="docker.html">Docker</a><ul>
<li class="toctree-l2"><a class="reference internal" href="docker.html#requirements">Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="docker.html#id1">Docker</a></li>
<li class="toctree-l2"><a class="reference internal" href="docker.html#installation">Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="docker.html#build">Build</a></li>
<li class="toctree-l2"><a class="reference internal" href="docker.html#run">Run</a></li>
<li class="toctree-l2"><a class="reference internal" href="docker.html#connection">Connection</a></li>
<li class="toctree-l2"><a class="reference internal" href="docker.html#tests">Tests</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart</a><ul>
<li class="toctree-l2"><a class="reference internal" href="quickstart.html#running-first-scan">Running First Scan</a></li>
<li class="toctree-l2"><a class="reference internal" href="quickstart.html#scan-fields">Scan Fields</a></li>
<li class="toctree-l2"><a class="reference internal" href="quickstart.html#understanding-the-results">Understanding the Results</a></li>
<li class="toctree-l2"><a class="reference internal" href="quickstart.html#my-scans">My Scans</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="advancedusage.html">Advanced Usage</a><ul>
<li class="toctree-l2"><a class="reference internal" href="advancedusage.html#configure-default-plugins">Configure Default Plugins</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="social.html">Rumal Social</a><ul>
<li class="toctree-l2"><a class="reference internal" href="social.html#private-and-public">Private and Public</a></li>
<li class="toctree-l2"><a class="reference internal" href="social.html#groups">Groups</a></li>
<li class="toctree-l2"><a class="reference internal" href="social.html#comments">Comments</a></li>
<li class="toctree-l2"><a class="reference internal" href="social.html#tags">Tags</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="advancedsearch.html">Advanced Search</a><ul>
<li class="toctree-l2"><a class="reference internal" href="advancedsearch.html#usage">Usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="advancedsearch.html#searchable-fields">Searchable Fields</a></li>
<li class="toctree-l2"><a class="reference internal" href="advancedsearch.html#useable-operators">Useable Operators</a></li>
<li class="toctree-l2"><a class="reference internal" href="advancedsearch.html#examples">Examples</a></li>
<li class="toctree-l2"><a class="reference internal" href="advancedsearch.html#tests">Tests</a></li>
<li class="toctree-l2"><a class="reference internal" href="advancedsearch.html#error-messages">Error Messages</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="plugins.html">Plugins</a><ul>
<li class="toctree-l2"><a class="reference internal" href="plugins.html#what-and-why">What and Why?</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins.html#adding-removing-plugins">Adding Removing Plugins</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins.html#how-plugins-work">How Plugins work?</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins.html#writing-your-own-plugins">Writing your own Plugins</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="development.html">Development</a><ul>
<li class="toctree-l2"><a class="reference internal" href="development.html#future-developments">Future Developments</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="intro.html" class="btn btn-neutral float-right" title="Introduction" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2014-2016 Rumal Developers.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'0.0.1 alpha',
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>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>