Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Installation docs and operation example #42

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,41 @@ $ ./Xerxes -H
--daemonize daemonize
```

## Installation

* Build tools installation

```bash
sudo apt-get -y install build-essential cmake libssl-dev pkgconf
```

* Building from source

```bash
git clone --recursive https://github.com/sepehrdaddev/Xerxes
cd Xerxes
mkdir build && cd build
cmake ..
make -j `nproc`
```

## Testing

* Spin up a python server

```bash
python -m SimpleHTTPServer 9000
```

* Use Xerses to DoS the server

```bash
./bin/Xersxs -h 127.0.0.1 -p 9000
```

* Try reaching `localhost:9000` on the browser to confirm if DoS is working


## License

This software is distributed under the GNU General Public License version 3 (GPLv3)
Expand Down