guides/user/REST-server.md
0 → 100644
## REST Server -- v1.4 | ||
The REST server allows for remote management of scans over a simple web service. | ||
* [Setup](#setup) | ||
* [Help output](#help) | ||
## <a name="setup" href="#setup">Setup</a> | ||
Starting the server is as simple as running: | ||
arachni_rest_server | ||
This will bind on `http://localhost:7331` by default. | ||
### <a name="help" href="#help">Help output</a> | ||
``` | ||
Arachni - Web Application Security Scanner Framework v1.4 | ||
Author: Tasos "Zapotek" Laskos <[email protected]> | ||
(With the support of the community and the Arachni Team.) | ||
Website: http://arachni-scanner.com | ||
Documentation: http://arachni-scanner.com/wiki | ||
Usage: ./bin/arachni_rest_server [options] | ||
Generic | ||
-h, --help Output this message. | ||
--version Show version information. | ||
Server | ||
--address ADDRESS Hostname or IP address to bind to. | ||
(Default: 127.0.0.1) | ||
--port NUMBER Port to listen to. | ||
(Default: 7331) | ||
Output | ||
--reroute-to-logfile Reroute scan output to log-files under: /home/zapotek/workspace/arachni/logs/ | ||
--verbose Show verbose output. | ||
(Only applicable when '--reroute-to-logfile' is enabled.) | ||
--debug [LEVEL 1-3] Show debugging information. | ||
(Only applicable when '--reroute-to-logfile' is enabled.) | ||
--only-positives Only output positive results. | ||
(Only applicable when '--reroute-to-logfile' is enabled.) | ||
Authentication | ||
--authentication-username USERNAME | ||
Username to use for HTTP authentication. | ||
--authentication-password PASSWORD | ||
Password to use for HTTP authentication. | ||
SSL | ||
--ssl-ca FILE Location of the CA certificate (.pem). | ||
If provided, peer verification will be enabled, otherwise no verification will take place. | ||
--ssl-private-key FILE Location of the SSL private key (.pem). | ||
--ssl-certificate FILE Location of the SSL certificate (.pem). | ||
``` | ||
\ No newline at end of file |