server-configuration.md

title	draft	description	pre
Server configuration	false	Reference material for the server_config.json file	<i class='fa fa-cogs'></i>

{{< table_of_contents >}}

Configuration

Property	Type	Required	Nullable
data_dir	string	Optional	cannot be null
log_level	string	Optional	cannot be null
mongodb	object	Optional	cannot be null
ssl_certificate	object	Optional	cannot be null
island_port	integer	Optional	cannot be null

data_dir

The directory where the Island will store runtime artifacts.

data_dir

• is optional

• Type: string

• cannot be null

data_dir Constraints

The value of this string must be a valid path.

data_dir Default Value

The default value for Windows is:

"%AppData%\\monkey_island"

The default value for Linux is:

"$HOME/.monkey_island"

log_level

The threshold for the Island logger.

log_level

• is optional

• Type: string

• cannot be null

log_level Default Value

The default value is:

"INFO"

mongodb

The MongoDB configuration for the Island server.

mongodb

• is optional

• Type: object

• cannot be null

mongodb Properties

start_mongodb

If enabled, the MongoDB server will be started automatically with the Island.

start_mongodb

• is optional

• Type: boolean

• cannot be null

start_mongodb Default Value

The default value is:

true

mongodb Default Value

The default value is:

{
  "start_mongodb": true
}

ssl_certificate

The SSL certificates configuration for the Island server.

ssl_certificate

• is optional

• Type: object

• cannot be null

ssl_certificate Properties

ssl_certificate_file

The path to the SSL certificate file that the Island server will use.

ssl_certificate_file

• is optional

• Type: string

• cannot be null

ssl_certificate_file Constraints

The value of this string must be a valid path.

ssl_certificate_file Default Value

The default value is:

"<infection_monkey_installation_path>\\monkey_island\\cc\\server.crt"

ssl_certificate_key_file

The path to the SSL certificate key file that the Island server will use.

ssl_certificate_key_file

• is optional

• Type: string

• cannot be null

ssl_certificate_key_file Constraints

The value of this string must be a valid path.

ssl_certificate_key_file Default Value

The default value is:

"<infection_monkey_installation_path>\\monkey_island\\cc\\server.key"

ssl_certificate Default Value

The default value is:

{
  "ssl_certificate_file": "<infection_monkey_installation_path>\\monkey_island\\cc\\server.crt",
  "ssl_certificate_key_file": "<infection_monkey_installation_path>\\monkey_island\\cc\\server.key"
}

island_port

The port on which the Island server should listen.

island_port

• is optional

• Type: integer

• cannot be null

island_port Default Value

The default value is:

443