diff --git a/README b/README deleted file mode 100644 index 5f47806..0000000 --- a/README +++ /dev/null @@ -1,112 +0,0 @@ -# sngrep [![Build Status](https://travis-ci.org/irontec/sngrep.svg)](https://travis-ci.org/irontec/sngrep) - -sngrep is a tool for displaying SIP calls message flows from terminal. - -It supports live capture to display realtime SIP packets and can also be used -as PCAP viewer. - -[Some screenshots of sngrep](https://github.com/irontec/sngrep/wiki/Screenshots) - -## Installing - -### Binaries -* [Debian / Ubuntu](https://github.com/irontec/sngrep/wiki/Installing-Binaries#debian--ubuntu) -* [CentOS / RedHat / Fedora](https://github.com/irontec/sngrep/wiki/Installing-Binaries#centos--fedora--rhel) -* [Alpine Linux](https://github.com/irontec/sngrep/wiki/Installing-Binaries#alpine-linux) -* [Gentoo](https://github.com/irontec/sngrep/wiki/Installing-Binaries#gentoo) -* [Arch](https://github.com/irontec/sngrep/wiki/Installing-Binaries#arch) -* [OSX](https://github.com/irontec/sngrep/wiki/Installing-Binaries#osx) -* [OpenWRT/LEDE](https://github.com/irontec/sngrep/wiki/Installing-Binaries#openwrtlede) - -### Building from sources -Prerequisites - - - glib - core library - - libncursesw5 - for UI, windows, panels. - - libpcap - for capturing packets. - - gnutls - (optional) for TLS transport decrypt using GnuTLS and libgcrypt - - libncursesw5 - (optional) for UI, windows, panels (wide-character support) - - libpcre - (optional) for Perl Compatible regular expressions - -#### Preparing source code - -Use cmake to generate required makefiles to build the project - - cmake . - -Or, you can use traditional autotools generation scripts - - ./bootstrap.sh - ./configure - -You can pass following flags to ./configure to enable some features - -| configure flag | Feature | -| ------------- | ------------- | -| `--with-ssl` | Adds GnuTLS support to parse TLS captured messages (req. gnutls) | -| `--enable-unicode` | Adds Ncurses UTF-8/Unicode support (req. libncursesw5) | -| `--enable-ipv6` | Enable IPv6 packet capture support. | -| `--enable-hep` | Enable EEP packet send/receive support. | - - -#### Building and installing - - make - make install (as root) - - -You can find [detailed instructions for some distributions](https://github.com/irontec/sngrep/wiki/Building) on wiki. - - -## Usage - -See `--help` for a list of available flags and their syntax - -For example, sngrep can be used to view SIP packets from a pcap file, also applying filters - - sngrep -I file.pcap host 192.168.1.1 and port 5060 - -or live capturing, saving packets to a new file - - sngrep -d eth0 -O save.pcap port 5060 and udp - - -## Configuration - -You can configure some options using [sngreprc](https://github.com/irontec/sngrep/wiki/Configuration) file - -## Frequent Asked Questions -Any feedback, request or question are welcomed at [#sngrep](https://webchat.freenode.net/?channels=sngrep) channel at irc.freenode.net - -See FAQ on [Github Wiki](https://github.com/irontec/sngrep/wiki#frequent-asked-questions) - -## License - sngrep - SIP Messages flow viewer - Copyright (C) 2013-2018 Irontec S.L. - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - In addition, as a special exception, the copyright holders give - permission to link the code of portions of this program with the - OpenSSL library under certain conditions as described in each - individual source file, and distribute linked combinations - including the two. - You must obey the GNU General Public License in all respects - for all of the code used other than OpenSSL. If you modify - file(s) with this exception, you may extend this exception to your - version of the file(s), but you are not obligated to do so. If you - do not wish to do so, delete this exception statement from your - version. If you delete this exception statement from all source - files in the program, then also delete it here. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - diff --git a/README.md b/README.md deleted file mode 120000 index 100b938..0000000 --- a/README.md +++ /dev/null @@ -1 +0,0 @@ -README \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..5f47806 --- /dev/null +++ b/README.md @@ -0,0 +1,112 @@ +# sngrep [![Build Status](https://travis-ci.org/irontec/sngrep.svg)](https://travis-ci.org/irontec/sngrep) + +sngrep is a tool for displaying SIP calls message flows from terminal. + +It supports live capture to display realtime SIP packets and can also be used +as PCAP viewer. + +[Some screenshots of sngrep](https://github.com/irontec/sngrep/wiki/Screenshots) + +## Installing + +### Binaries +* [Debian / Ubuntu](https://github.com/irontec/sngrep/wiki/Installing-Binaries#debian--ubuntu) +* [CentOS / RedHat / Fedora](https://github.com/irontec/sngrep/wiki/Installing-Binaries#centos--fedora--rhel) +* [Alpine Linux](https://github.com/irontec/sngrep/wiki/Installing-Binaries#alpine-linux) +* [Gentoo](https://github.com/irontec/sngrep/wiki/Installing-Binaries#gentoo) +* [Arch](https://github.com/irontec/sngrep/wiki/Installing-Binaries#arch) +* [OSX](https://github.com/irontec/sngrep/wiki/Installing-Binaries#osx) +* [OpenWRT/LEDE](https://github.com/irontec/sngrep/wiki/Installing-Binaries#openwrtlede) + +### Building from sources +Prerequisites + + - glib - core library + - libncursesw5 - for UI, windows, panels. + - libpcap - for capturing packets. + - gnutls - (optional) for TLS transport decrypt using GnuTLS and libgcrypt + - libncursesw5 - (optional) for UI, windows, panels (wide-character support) + - libpcre - (optional) for Perl Compatible regular expressions + +#### Preparing source code + +Use cmake to generate required makefiles to build the project + + cmake . + +Or, you can use traditional autotools generation scripts + + ./bootstrap.sh + ./configure + +You can pass following flags to ./configure to enable some features + +| configure flag | Feature | +| ------------- | ------------- | +| `--with-ssl` | Adds GnuTLS support to parse TLS captured messages (req. gnutls) | +| `--enable-unicode` | Adds Ncurses UTF-8/Unicode support (req. libncursesw5) | +| `--enable-ipv6` | Enable IPv6 packet capture support. | +| `--enable-hep` | Enable EEP packet send/receive support. | + + +#### Building and installing + + make + make install (as root) + + +You can find [detailed instructions for some distributions](https://github.com/irontec/sngrep/wiki/Building) on wiki. + + +## Usage + +See `--help` for a list of available flags and their syntax + +For example, sngrep can be used to view SIP packets from a pcap file, also applying filters + + sngrep -I file.pcap host 192.168.1.1 and port 5060 + +or live capturing, saving packets to a new file + + sngrep -d eth0 -O save.pcap port 5060 and udp + + +## Configuration + +You can configure some options using [sngreprc](https://github.com/irontec/sngrep/wiki/Configuration) file + +## Frequent Asked Questions +Any feedback, request or question are welcomed at [#sngrep](https://webchat.freenode.net/?channels=sngrep) channel at irc.freenode.net + +See FAQ on [Github Wiki](https://github.com/irontec/sngrep/wiki#frequent-asked-questions) + +## License + sngrep - SIP Messages flow viewer + Copyright (C) 2013-2018 Irontec S.L. + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + In addition, as a special exception, the copyright holders give + permission to link the code of portions of this program with the + OpenSSL library under certain conditions as described in each + individual source file, and distribute linked combinations + including the two. + You must obey the GNU General Public License in all respects + for all of the code used other than OpenSSL. If you modify + file(s) with this exception, you may extend this exception to your + version of the file(s), but you are not obligated to do so. If you + do not wish to do so, delete this exception statement from your + version. If you delete this exception statement from all source + files in the program, then also delete it here. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . +