-
Notifications
You must be signed in to change notification settings - Fork 0
/
run_your_own.html
263 lines (179 loc) · 9.4 KB
/
run_your_own.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
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1"><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Run your own Fritz</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/theme.css " type="text/css" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<!-- sphinx script_files -->
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<!-- bundled in js (rollup iife) -->
<!-- <script src="_static/theme-vendors.js"></script> -->
<script src="_static/theme.js" defer></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="API" href="api.html" />
<link rel="prev" title="Fritz User Guide" href="user_guide.html" />
</head>
<body>
<div id="app">
<div class="theme-container" :class="pageClasses"><navbar @toggle-sidebar="toggleSidebar">
<router-link to="index.html" class="home-link">
<span class="site-name">Fritz Marshal</span>
</router-link>
<div class="links">
<navlinks class="can-hide">
</navlinks>
</div>
</navbar>
<div class="sidebar-mask" @click="toggleSidebar(false)">
</div>
<sidebar @toggle-sidebar="toggleSidebar">
<navlinks>
</navlinks><div id="searchbox" class="searchbox" role="search">
<div class="caption"><span class="caption-text">Quick search</span>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Search" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
</div><div class="sidebar-links" role="navigation" aria-label="main navigation">
<div class="sidebar-group">
<p class="caption">
<span class="caption-text"><a href="index.html#fritz-marshal-manual">fritz marshal manual</a></span>
</p>
<ul class="current">
<li class="toctree-l1 ">
<a href="user_guide.html" class="reference internal ">Fritz User Guide</a>
</li>
<li class="toctree-l1 current">
<a href="#" class="reference internal current">Run your own Fritz</a>
<ul>
<li class="toctree-l2"><a href="#configuration" class="reference internal">Configuration</a></li>
<li class="toctree-l2"><a href="#initializing-fritz" class="reference internal">Initializing Fritz</a></li>
<li class="toctree-l2"><a href="#demo-data" class="reference internal">Demo data</a></li>
<li class="toctree-l2"><a href="#launching-fritz" class="reference internal">Launching Fritz</a></li>
<li class="toctree-l2"><a href="#shutting-down-fritz" class="reference internal">Shutting down Fritz</a></li>
</ul>
</li>
<li class="toctree-l1 ">
<a href="api.html" class="reference internal ">API</a>
</li>
<li class="toctree-l1 ">
<a href="catalogs.html" class="reference internal ">Kowalski collection schemas</a>
</li>
<li class="toctree-l1 ">
<a href="technical_implementation.html" class="reference internal ">Technical implementation</a>
</li>
<li class="toctree-l1 ">
<a href="developer.html" class="reference internal ">Developer Guidelines</a>
</li>
<li class="toctree-l1 ">
<a href="license.html" class="reference internal ">License</a>
</li>
</ul>
</div>
</div>
</sidebar>
<page>
<div class="body-header" role="navigation" aria-label="navigation">
<ul class="breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>Run your own Fritz</li>
</ul>
<ul class="page-nav">
<li class="prev">
<a href="user_guide.html"
title="previous chapter">← Fritz User Guide</a>
</li>
<li class="next">
<a href="api.html"
title="next chapter">API →</a>
</li>
</ul>
</div>
<hr>
<div class="content" role="main" v-pre>
<section id="run-your-own-fritz">
<h1>Run your own Fritz<a class="headerlink" href="#run-your-own-fritz" title="Link to this heading">¶</a></h1>
<p>Clone the repo from <code class="docutils literal notranslate"><span class="pre">GitHub</span></code>:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>clone<span class="w"> </span>--recursive<span class="w"> </span>https://github.com/fritz-marshal/fritz.git<span class="w"> </span><span class="o">&&</span><span class="w"> </span><span class="nb">cd</span><span class="w"> </span>fritz
</pre></div>
</div>
<p>All operations are started via the <code class="docutils literal notranslate"><span class="pre">fritz</span></code> script.</p>
<p>Before proceeding, you may want to create/activate a virtual environment, for example:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>-m<span class="w"> </span>venv<span class="w"> </span>fritz-env
<span class="nb">source</span><span class="w"> </span>fritz-env/bin/activate
</pre></div>
</div>
<p>Make sure the requirements to run it are met, e.g.:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>-r<span class="w"> </span>requirements.txt
</pre></div>
</div>
<p>Please type <code class="docutils literal notranslate"><span class="pre">./fritz</span> <span class="pre">--help</span></code> to see available commands.</p>
<section id="configuration">
<h2>Configuration<a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">fritz.yaml</span></code> file should contain settings for the marshal, including a
secret token (which must be customized before deployment), and
authentication tokens.
Please use the <code class="docutils literal notranslate"><span class="pre">fritz.defaults.yaml</span></code> file for the reference.</p>
</section>
<section id="initializing-fritz">
<h2>Initializing Fritz<a class="headerlink" href="#initializing-fritz" title="Link to this heading">¶</a></h2>
<p>Before Fritz is launched for the first time, it needs to be initialized:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">./</span><span class="n">fritz</span> <span class="n">run</span> <span class="o">--</span><span class="n">init</span>
</pre></div>
</div>
</section>
<section id="demo-data">
<h2>Demo data<a class="headerlink" href="#demo-data" title="Link to this heading">¶</a></h2>
<p>To load demo data into Fritz, run:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">./</span><span class="n">fritz</span> <span class="n">test</span>
</pre></div>
</div>
<p>If you are using the default settings, go to <code class="docutils literal notranslate"><span class="pre">http://localhost:5000/</span></code> –
you should see a few real alerts that passed test filters among the displayed sources.</p>
</section>
<section id="launching-fritz">
<h2>Launching Fritz<a class="headerlink" href="#launching-fritz" title="Link to this heading">¶</a></h2>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">./</span><span class="n">fritz</span> <span class="n">run</span>
</pre></div>
</div>
</section>
<section id="shutting-down-fritz">
<h2>Shutting down Fritz<a class="headerlink" href="#shutting-down-fritz" title="Link to this heading">¶</a></h2>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>./fritz<span class="w"> </span>stop
</pre></div>
</div>
</section>
</section>
</div>
<div class="page-nav">
<div class="inner"><ul class="page-nav">
<li class="prev">
<a href="user_guide.html"
title="previous chapter">← Fritz User Guide</a>
</li>
<li class="next">
<a href="api.html"
title="next chapter">API →</a>
</li>
</ul><div class="footer" role="contentinfo">
© Copyright 2020, The Fritz Marshal authors.
<br>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.4.7 with <a href="https://github.com/schettino72/sphinx_press_theme">Press Theme</a> 0.9.1.
</div>
</div>
</div>
</page>
</div></div>
</body>
</html>