github
/
gixy
mirror of https://github.com/yandex/gixy
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #7 from yandex/master 

Docs
pull/8/head
Andrew Krasichkov 2017-04-05 01:26:12 +03:00 committed by GitHub
parent 91bbf05f29 696dbc1c47
commit b52e598e30
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -15,7 +15,7 @@ Disclaimer: Gixy is well tested only on GNU/Linux, in other OS may have some iss
# Installation # Installation
Gixy is distributed on PyPI. The best way to install it is with pip: Gixy is distributed on PyPI. The best way to install it is with pip:
```bash ```bash
pip install bandit pip install gixy
``` ```
Run Gixy and check results: Run Gixy and check results:
@ -24,7 +24,9 @@ gixy
``` ```
# Usage # Usage
By default Gixy will try to analyze Nginx configuration placed in `/etc/nginx/nginx.conf`. But you can always specify needed path: By default Gixy will try to analyze Nginx configuration placed in `/etc/nginx/nginx.conf`.
But you always can specify needed path:
``` ```
$ gixy /etc/nginx/nginx.conf $ gixy /etc/nginx/nginx.conf
@ -55,7 +57,7 @@ Total issues:
Or skip some tests: Or skip some tests:
``` ```
$ ./gixy-cli.py --skips http_splitting /etc/nginx/nginx.conf $ gixy --skips http_splitting /etc/nginx/nginx.conf
==================== Results =================== ==================== Results ===================
No issues found. No issues found.
@ -73,7 +75,6 @@ Or something else, you can find all other `gixy` arguments with the help command
# Documentation # Documentation
Full documentation and recommendations can be found [here](https://github.com/yandex/gixy/docs/ru/README.md) (sorry, but Russian language only so far) Full documentation and recommendations can be found [here](https://github.com/yandex/gixy/docs/ru/README.md) (sorry, but Russian language only so far)
# Contributing # Contributing
Contributions to Gixy are always welcome! You can help us in different ways: Contributions to Gixy are always welcome! You can help us in different ways:
* Open an issue with suggestions for improvements and errors you're facing; * Open an issue with suggestions for improvements and errors you're facing;