diff --git a/warden3/warden_server/README b/warden3/warden_server/README index 089205d2c4db5edfd0b5f098fbb8753dcc277b15..9e46ce18cd5ea6e7dab498d0fcbdefb10721df21 100644 --- a/warden3/warden_server/README +++ b/warden3/warden_server/README @@ -13,8 +13,8 @@ Content ------------------------------------------------------------------------------ A. Introduction - Warden is a system for efficient sharing information about detected events -(threats). Warden Server is server-side part of the software, the + Warden is a system for efficient sharing of information about detected +events (threats). Warden Server is server-side part of the software, the communication hub, allowing to publish detected events and download yet unprocessed ones. @@ -28,7 +28,7 @@ of Warden Server administration. Warden Server is Python/WSGI based, written primarily with Apache mod_wsgi in mind. Other WSGI servers/frameworks are not yet tested, so your mileage may vary. Authentication is X509 certificate (for machine or client -identification) + shared secret (for client icentification, where +identification) + shared secret (for client identification, where certificate does not suffice). ------------------------------------------------------------------------------ @@ -65,11 +65,11 @@ C. Installation mysql> CREATE DATABASE warden3; mysql> GRANT ALL ON warden3.* TO `warden`@`localhost`; mysql> SET PASSWORD FOR 'warden'@'localhost' = PASSWORD('example'); - mysql> FLUSH PRIVILEDGES; + mysql> FLUSH PRIVILEGES; * Create necessary table structure - mysql -p -u warden warden3 < warden3.0.sql + mysql -p -u warden warden3 < warden_3.0.sql * Enable mod_wsgi, mod_ssl, include Warden configuration @@ -122,7 +122,7 @@ particular implementation object of the aspect, for example type of logger Log: FileLogger, SysLogger DB: MySQL Auth: X509Authenticator, NoAuthenticator - Validator: JSONSchemaValidator, "NoValidator + Validator: JSONSchemaValidator, NoValidator Handler: WardenHandler "type" keyword is not mandatory, if not specified, first implementation @@ -150,7 +150,8 @@ object from particular section list is used ("FileLogger" for example). JSONSchemaValidator: validate incoming events based on JSON schema file filename: path to schema file, defaults to "idea.schema" at - installation directory + installation directory, for information on obtaining current + IDEA schema file, refer to https://idea.cesnet.cz/en/schema MySQL: database storage backend host: database server host, default "localhost"