From a1014489efeb6d32b6e5fe6f188b99040a681f3b Mon Sep 17 00:00:00 2001 From: shreyamalviya Date: Wed, 19 May 2021 00:20:39 +0530 Subject: [PATCH] Tiny grammar/formatting changes in docs --- docs/content/FAQ/_index.md | 15 +++++++-------- docs/content/reference/data_directory.md | 13 ++++++------- 2 files changed, 13 insertions(+), 15 deletions(-) diff --git a/docs/content/FAQ/_index.md b/docs/content/FAQ/_index.md index d01958f79..9284e2c32 100644 --- a/docs/content/FAQ/_index.md +++ b/docs/content/FAQ/_index.md @@ -42,9 +42,9 @@ The Infection Monkey agent shuts off either when it can't find new victims or it When you first access the Monkey Island server, you'll be prompted to create an account. To reset the credentials or enable/disable the authentication, edit the `server_config.json` file manually -(located in [data directory](/reference/data_directory)). +(located in the [data directory](/reference/data_directory)). -The following edits need to be made: +In order to reset the credentials, the following edits need to be made: 1. Delete the `user` field if one exists. It will look like this: ```json { @@ -53,7 +53,7 @@ The following edits need to be made: ... } ``` -1. Delete `password_hash` field if one exist. It will look like this: +1. Delete the `password_hash` field if one exists. It will look like this: ```json { ... @@ -66,6 +66,7 @@ The following edits need to be made: { ... "environment": { + ... "server_config": "password", ... }, @@ -142,15 +143,13 @@ The logs contain information about the internals of the Infection Monkey agent's ### How do I change the log level of the Monkey Island logger? The log level of the Monkey Island logger is set in the `log_level` field -in the `server_config.json` file (located in [data directory](/reference/data_directory)). +in the `server_config.json` file (located in the [data directory](/reference/data_directory)). Make sure to leave everything else in `server_config.json` unchanged: ```json { + ... "log_level": "DEBUG", - "environment": { - ... - }, ... } ``` @@ -158,7 +157,7 @@ Make sure to leave everything else in `server_config.json` unchanged: Logging levels correspond to [the logging level constants in python](https://docs.python.org/3.7/library/logging.html#logging-levels). To apply the changes, reset the Monkey Island process. -On Linux use `sudo systemctl restart monkey-island.service`. +On Linux, use `sudo systemctl restart monkey-island.service`. On Windows, restart the program. ## Running the Infection Monkey in a production environment diff --git a/docs/content/reference/data_directory.md b/docs/content/reference/data_directory.md index 83fe03116..418c320fa 100644 --- a/docs/content/reference/data_directory.md +++ b/docs/content/reference/data_directory.md @@ -6,14 +6,13 @@ pre: ' ' weight: 9 --- -## About data directory +## What is the data directory? -Data directory is where the Island server stores runtime artifacts. -Those arfifacts include the Island logs, any custom post-breach action files, +The data directory is where the Island server stores runtime artifacts. +These include the Island logs, any custom post-breach action files, configuration files, etc. -## Where is data directory +## Where is it located? -On **Linux** it's in `$HOME/.monkey_island`. - -On **Windows** it's in `%AppData%\monkey_island`. +On Linux, the default path is `$HOME/.monkey_island`. +On Windows, the default path is `%AppData%\monkey_island`.