diff --git a/REFERENCE.md b/REFERENCE.md
index a1816f5..94426cb 100644
--- a/REFERENCE.md
+++ b/REFERENCE.md
@@ -10,42 +10,55 @@
## Classes
-### `dropbear`
+### `dropbear`
Install and configure dropbear using puppet.
#### Examples
-#####
+##### Install Dropbear
```puppet
include 'dropbear'
```
-#####
+##### Install Dropbear with no-default configuration.
```puppet
-class {
- 'dropbear':
- port => 443,
- extra_args => '-s',
- banner => '/etc/banner',
+class { 'dropbear':
+ port => 443,
+ extra_args => '-s',
+ banner => '/etc/banner',
}
```
#### Parameters
-The following parameters are available in the `dropbear` class.
+The following parameters are available in the `dropbear` class:
-##### `no_start`
+* [`no_start`](#-dropbear--no_start)
+* [`port`](#-dropbear--port)
+* [`extra_args`](#-dropbear--extra_args)
+* [`banner`](#-dropbear--banner)
+* [`receive_window`](#-dropbear--receive_window)
+* [`package_name`](#-dropbear--package_name)
+* [`package_version`](#-dropbear--package_version)
+* [`service_name`](#-dropbear--service_name)
+* [`start_service`](#-dropbear--start_service)
+* [`rsakey`](#-dropbear--rsakey)
+* [`dsskey`](#-dropbear--dsskey)
+* [`cfg_file`](#-dropbear--cfg_file)
+* [`cfg_template`](#-dropbear--cfg_template)
+
+##### `no_start`
Data type: `Optional[Enum['0', '1']]`
Integer (0|1) used to prevent dropbear start.
-Default value: ``undef``
+Default value: `undef`
-##### `port`
+##### `port`
Data type: `Variant[Stdlib::Port, Pattern[/^\d+$/]]`
@@ -53,7 +66,7 @@ Integer, dropbear listen port
Default value: `22`
-##### `extra_args`
+##### `extra_args`
Data type: `String`
@@ -61,15 +74,15 @@ Extra argument passed to dropbear deamon (see man)
Default value: `''`
-##### `banner`
+##### `banner`
Data type: `Optional[String[1]]`
Display the contents of the file banner before user login.
-Default value: ``undef``
+Default value: `undef`
-##### `receive_window`
+##### `receive_window`
Data type: `Variant[Integer[1], Pattern[/^\d+$/]]`
@@ -79,13 +92,13 @@ Use -h to see the default buffer size.
Default value: `65536`
-##### `package_name`
+##### `package_name`
Data type: `String[1]`
Dropbear package name.
-##### `package_version`
+##### `package_version`
Data type: `String[1]`
@@ -93,44 +106,42 @@ Version of the Dropbear package
Default value: `'installed'`
-##### `service_name`
+##### `service_name`
Data type: `String[1]`
Dropbear service name.
-##### `start_service`
+##### `start_service`
Data type: `Boolean`
Boolean to control whether to ensure the service is running
-Default value: ``true``
+Default value: `true`
-##### `rsakey`
+##### `rsakey`
Data type: `Stdlib::Absolutepath`
Use the contents of the file rsakey for the rsa host key
-(default: /etc/dropbear/dropbear_rsa_host_key).
This file is generated with dropbearkey
-##### `dsskey`
+##### `dsskey`
Data type: `Stdlib::Absolutepath`
Use the contents of the file dsskey for the DSS host key
-(default: /etc/dropbear/dropbear_dss_host_key).
Note that some SSH implementations use the term "DSA" rather than "DSS",
they mean the same thing. This file is generated with dropbearkey.
-##### `cfg_file`
+##### `cfg_file`
Data type: `Stdlib::Absolutepath`
Location of configuration file.
-##### `cfg_template`
+##### `cfg_template`
Data type: `String`