niku-server/index.html

36 lines
1.2 KiB
HTML

<html>
<head>
<title>Niku</title>
</head>
<body>
<h1>
Welcome to niku - almost
</h1>
<p>
This year, our IDS is a <em>client-based web server</em>.
In order to use it, follow the following steps:
</p>
<ol>
<li>Install the prerequisites: <pre>pip install flask flask_wtf</pre></li>
<li>Download the client: <pre>git clone git@git.seclab.cs.ucsb.edu:sherlock/niku-client.git &amp;&amp; cd niku-client</pre></li>
<li>Run the local server: <pre>python run.py</pre></li>
<li>Navigate to <a href="http://localhost:5000">http://localhost:5000</a> and start your analysis!</li>
</ol>
<p>
If at any point an update is released, you may upgrade to the latest version of the client by simply pulling the git repository.
</p>
<p>
If at any point you run into weird issues, your first debugging step should be to remove <pre>~/.niku</pre>.
This will clear your search history and local cache.
</p>
<p>
<strong>Please be gentle with the server!</strong>
</p>
</body>
</html>