docs/index.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
<meta name="description" content="">
<meta name="author" content="">
<link rel="icon" href="../../favicon.ico">
<title>Redis Sniffer</title>
<!-- Bootstrap core CSS -->
<link href="dist/css/bootstrap.min.css" rel="stylesheet">
<!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
<!-- Custom styles for this template -->
<link href="css/carousel.css" rel="stylesheet">
</head>
<!-- NAVBAR
================================================== -->
<body>
<div class="navbar-wrapper">
<div class="container">
<nav class="navbar navbar-inverse navbar-static-top">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="/">Redis Sniffer</a>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li class="active"><a href="/">Home</a></li>
<li><a href="#about">About</a></li>
<li><a href="#contact">Roadmap</a></li>
<li><a href="#documentation">Documentation</a></li>
<li><a href="#download">Download</a></li>
</ul>
</div>
</div>
</nav>
</div>
</div>
<!-- Carousel
================================================== -->
<div id="myCarousel" class="carousel slide" data-ride="carousel">
<!-- Indicators -->
<ol class="carousel-indicators">
<li data-target="#myCarousel" data-slide-to="0" class="active"></li>
<li data-target="#myCarousel" data-slide-to="1"></li>
<li data-target="#myCarousel" data-slide-to="2"></li>
</ol>
<div class="carousel-inner" role="listbox">
<div class="item active">
<img class="first-slide" src="data:image/gif;base64,R0lGODlhAQABAIAAAHd3dwAAACH5BAAAAAAALAAAAAABAAEAAAICRAEAOw==" alt="First slide">
<div class="container">
<div class="carousel-caption">
<h1>Redis Sniffer</h1>
<p>Redis Sniffer is a packet capture and filter utility geared toward capturing and logging both ingress and egress Redis traffic going across a specific interface on a specific port.</p>
<p><a class="btn btn-lg btn-primary" href="#" role="button">Learn More</a></p>
</div>
</div>
</div>
<div class="item">
<img class="second-slide" src="data:image/gif;base64,R0lGODlhAQABAIAAAHd3dwAAACH5BAAAAAAALAAAAAABAAEAAAICRAEAOw==" alt="Second slide">
<div class="container">
<div class="carousel-caption">
<h1>Redis Sniffer v1.1.0 Released!</h1>
<p>v1.1.0 introduces a debug mode that will capture and log raw ethernet and tcp packets. Redis command filtering has also been implemented, allowing for only specified redis commands to be logged.</p>
<p><!-- Place this tag where you want the button to render. -->
<a class="github-button" href="https://github.com/jplesperance/redis-sniffer/archive/v1.1.0.zip" data-icon="octicon-cloud-download" data-size="large" aria-label="Download jplespeance/redis-sniffer on GitHub">Download .zip</a>
<a class="github-button" href="https://github.com/jplesperance/redis-sniffer/archive/v1.1.0.tar.gz" data-icon="octicon-cloud-download" data-size="large" aria-label="Download jplespeance/redis-sniffer on GitHub">Download .tar.gz</a></p>
</div>
</div>
</div>
<div class="item">
<img class="third-slide" src="data:image/gif;base64,R0lGODlhAQABAIAAAHd3dwAAACH5BAAAAAAALAAAAAABAAEAAAICRAEAOw==" alt="Third slide">
<div class="container">
<div class="carousel-caption">
<h1>Redis Sniffer on Github</h1>
<p>As an Open Source project, we utilize Github as out primary code repository.</p>
<p><!-- Place this tag where you want the button to render. -->
<a class="github-button" href="https://github.com/jplesperance/redis-sniffer" data-icon="octicon-star" data-show-count="true" aria-label="Star jplesperance/redis-sniffer on GitHub">Star</a> <!-- Place this tag where you want the button to render. -->
<a class="github-button" href="https://github.com/jplesperance/redis-sniffer/fork" data-icon="octicon-repo-forked" aria-label="Fork jplesperance/redis-sniffer on GitHub">Fork</a></p>
</div>
</div>
</div>
</div>
<a class="left carousel-control" href="#myCarousel" role="button" data-slide="prev">
<span class="glyphicon glyphicon-chevron-left" aria-hidden="true"></span>
<span class="sr-only">Previous</span>
</a>
<a class="right carousel-control" href="#myCarousel" role="button" data-slide="next">
<span class="glyphicon glyphicon-chevron-right" aria-hidden="true"></span>
<span class="sr-only">Next</span>
</a>
</div><!-- /.carousel -->
<!-- Place this tag where you want the button to render. -->
<!-- Marketing messaging and featurettes
================================================== -->
<!-- Wrap the rest of the page in another container to center all the content. -->
<div class="container marketing">
<!-- Three columns of text below the carousel -->
<!--<div class="row">
<div class="col-lg-4">
<img class="img-circle" src="data:image/gif;base64,R0lGODlhAQABAIAAAHd3dwAAACH5BAAAAAAALAAAAAABAAEAAAICRAEAOw==" alt="Generic placeholder image" width="140" height="140">
<h2>Heading</h2>
<p>Donec sed odio dui. Etiam porta sem malesuada magna mollis euismod. Nullam id dolor id nibh ultricies vehicula ut id elit. Morbi leo risus, porta ac consectetur ac, vestibulum at eros. Praesent commodo cursus magna.</p>
<p><a class="btn btn-default" href="#" role="button">View details »</a></p>
</div><!– /.col-lg-4 –>
<div class="col-lg-4">
<img class="img-circle" src="data:image/gif;base64,R0lGODlhAQABAIAAAHd3dwAAACH5BAAAAAAALAAAAAABAAEAAAICRAEAOw==" alt="Generic placeholder image" width="140" height="140">
<h2>Heading</h2>
<p>Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem nec elit. Cras mattis consectetur purus sit amet fermentum. Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh.</p>
<p><a class="btn btn-default" href="#" role="button">View details »</a></p>
</div><!– /.col-lg-4 –>
<div class="col-lg-4">
<img class="img-circle" src="data:image/gif;base64,R0lGODlhAQABAIAAAHd3dwAAACH5BAAAAAAALAAAAAABAAEAAAICRAEAOw==" alt="Generic placeholder image" width="140" height="140">
<h2>Heading</h2>
<p>Donec sed odio dui. Cras justo odio, dapibus ac facilisis in, egestas eget quam. Vestibulum id ligula porta felis euismod semper. Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus.</p>
<p><a class="btn btn-default" href="#" role="button">View details »</a></p>
</div><!– /.col-lg-4 –>
</div>--><!-- /.row -->
<!-- START THE FEATURETTES -->
<div class="row featurette">
<div class="col-md-12">
<h2 class="featurette-heading">Getting Started: <span class="text-muted">Installation</span></h2>
<p class="lead">*nix - Debian/Ubuntu/Mint - pip<br />
<pre><code>sudo apt-get install libpcap-dev
pip install redis-sniffer</code></pre></p>
<p class="lead">*nix - Debian/Ubuntu/Mint - apt<br />
<pre><code>// Add our apt key
wget -O - http://apt.eternalprojects.com/conf/apt.eternalprojects.com.gpg.key|apt-key add -
// add our repo to your source list
echo "deb http://apt.eternalprojects.com/ stable main" >> /etc/apt/sources.list
sudo apt-get udpate
sudo apt-get install libpcap-dev redis-sniffer</code></pre></p>
<p class="lead">*nix - Redhat/CentOS<br />
<pre><code>sudo yum install libpcap-devel
pip install redis-sniffer</code></pre></p>
</div>
</div>
<hr class="featurette-divider">
<div class="row featurette">
<div class="col-md-12">
<h2 class="featurette-heading">Getting Started: <span class="text-muted">Using Redis Sniffer</span></h2>
<p class="lead">Redis Sniffer binds to a network interface and analyzes the traffic that is crossing that interface on a specified port. The most basic usage can be seen here: <br />
<pre><code># format: redis-sniffer -i <interface> -p <port>
sudo redis-sniffer -i bond0 -p 6379</code></pre>
This will log all ingress and egress traffic on the interface/port to a log file in the current directory. Some additional examples are shown below:<br />
<pre><code># log all redis traffic on port 6379 crossing bond0 interface and have logs written to the /var/log/redis-sniffer folder.
sudo redis-sniffer -i bond0 -p 6379 --out /var/log/redis-sniffer
# log only select redis commands; -f allows a comma separated list of redis commands to filter and log. When using the -f flag, each filtered command will be logged to its own file.
sudo redis-sniffer -i bond0 -p 6379 --out /var/log/redis-sniffer -f select
#other options
-l [full,event,debug] - The level of logging, defaults to <strong>full</strong>
-el, --event-log - The name of the file that redis events are logged to
-fl, --full-log - The name of the file that all traffic is logged to
--append - A suffix to append to the log file names created when using filters</code></pre></p>
</div>
</div>
<hr class="featurette-divider">
<!-- /END THE FEATURETTES -->
<!-- FOOTER -->
<footer>
<p class="pull-right"><a href="#">Back to top</a></p>
<p>© 2017 Jesse P Lesperance · <a href="#">Privacy</a> · <a href="#">Terms</a></p>
</footer>
</div><!-- /.container -->
<!-- Bootstrap core JavaScript
================================================== -->
<!-- Placed at the end of the document so the pages load faster -->
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script>
<script>window.jQuery || document.write('<script src="../../assets/js/vendor/jquery.min.js"><\/script>')</script>
<script src="dist/js/bootstrap.min.js"></script>
<!-- Place this tag in your head or just before your close body tag. -->
<script async defer src="https://buttons.github.io/buttons.js"></script>
</body>
</html>