Updates to documentation (#277)

* Updates to documentation

fixes #79
fixes #68
fixes #69

* update Foreman Host 1 image

Author: tuxmea

FOREMAN_SCREENSHOTS.md

@@ -0,0 +1,12 @@
+# Foreman Screenshots
+
+## Foreman Smart Proxy
+
+![](screenshots/foreman/Foreman-Smart-Proxy-1.png)
+![](screenshots/foreman/Foreman-Smart-Proxy-2.png)
+
+## Foreman Host
+
+![](screenshots/foreman/Foreman-Host-1.png)
+![](screenshots/foreman/Foreman-Host-2.png)
+![](screenshots/foreman/Foreman-Host-3.png)

README.md

@@ -14,13 +14,64 @@ At the moment manual installation is only tested on macOS, CentOS 7 and 8 Stream
 
 See [MANUAL_INSTALL.md](MANUAL_INSTALL.md)
 
-## Automated Installation
+## Automated installation
 
 Docker containers are made available. You can find more information in [DOCKER.md](DOCKER.md).
 For automated installations we recommend using Puppet code. A working profile example can be found in [PUPPET.md](PUPPET.md)
 
+## Configuration Options
+
+HDM needs a configuration file (hdm.yml). Location depends on installation method:
+
+- Manual installation: within the HDM git clone in `config/hdm.yml`
+- Docker installation: on the docker host in `/etc/hdm/hdm.yml`
+
+Configurations are provided as a Hash. The main hash key describes the Rails environment HDM is running in:
+
+- Manual installation: depending on RAILS ENVIRONMENT env var - defaults to `development`
+- Docker installation: set to `production`
+
+The following configuration options are possible:
+
+```yaml
+# hdm.yml
+production:
+  authentication_disabled: false    # disable user auth and management
+
+  read_only: true                   # read/write mode?
+
+  allow_encryption: false           # encypting eyaml
+
+  puppet_db:                        # PuppetDB access - plain text (default)
+    server: http://localhost:8080
+  puppet_db:                        # PuppetDB access-  PE token auth
+    server: 'https://localhost:8081'
+    token: '/etc/hdm/puppetdb.token'
+    cacert: '<path to cacert>'
+  puppet_db:                        # PuppetDB access - SSL Cert auth
+    server: 'https://localhost:8081'
+    pem:
+      key: <path to key>
+      cert: <path to cert>
+      ca_file: <path to ca_file>
+
+  hiera_config_file: "hiera.yaml"   # hiera config file name
+
+  config_dir: /etc/puppetlabs/code  # puppet code directory
+
+  ldap:                             # LDAP User auth
+    host: 'localhost'
+    port: 389
+    base_dn: 'ou=hdm,dc=nodomain'
+    bind_dn: 'cn=admin,dc=nodomain'
+    bind_dn_password: 'openldap'
+    ldaps: false
+```
+
 ## Usermanagement
 
+Usermanagement can be disabled in HDM config file by specifying the `authentication_disabled` option.
+
 A fresh installation needs an admin which has to be created first with the WebGUI. That admin can not read the Puppet configuration. He/She can only create/delete new users. Normal users have the ability to read/change/delete the Puppet configuration data.
 
 ## Use git repositories instead of "live" yaml files

SCREENSHOTS.md

@@ -0,0 +1,51 @@
+# Screenshots
+
+## Initial page
+
+![](screenshots/HDM-01-initial_page.png)
+
+## Create admin
+
+![](screenshots/HDM-02-create_admin.png)
+
+## Create user
+
+![](screenshots/HDM-03-create_user.png)
+
+![](screenshots/HDM-04-create_user_2.png)
+
+![](screenshots/HDM-05-logout_admin.png)
+
+## Login user
+
+![](screenshots/HDM-06-login_user.png)
+
+## Select an environment
+
+![](screenshots/HDM-07-select_env.png)
+
+![](screenshots/HDM-08-select_env_2.png)
+
+## Select a node
+
+![](screenshots/HDM-09-select_node.png)
+
+![](screenshots/HDM-10-node_data.png)
+
+## Select a key
+
+![](screenshots/HDM-11-node_data_details.png)
+
+![](screenshots/HDM-12-node_data_details_2.png)
+
+## Search a key
+
+![](screenshots/HDM-13-search_key.png)
+
+## Search key result
+
+![](screenshots/HDM-14-search_key_result.png)
+
+## Search key result details
+
+![](screenshots/HDM-15-search_key_result_details.png)