From fe5735cc738d5a690ff110140bd7e4132805b8cb Mon Sep 17 00:00:00 2001
From: Steve Clement <steve@localhost.lu>
Date: Wed, 24 Oct 2018 18:48:24 +0900
Subject: [PATCH] new: [docs] Added globalVariables files to be included by all
 Install Guides chg: [tools] Updated dependencies on docs creator chg: [docs]
 Some minor changes to Ubuntu Install guide and added VariableglobalVariables
 chg: [docs] Updated mkdocs.yml with new dependencies

---
 docs/INSTALL.ubuntu1804.md     |  7 ++++--
 docs/globalVariables.md        | 46 ++++++++++++++++++++++++++++++++++
 mkdocs.yml                     |  4 +++
 tools/gen_misp_install_docs.sh |  2 +-
 4 files changed, 56 insertions(+), 3 deletions(-)
 create mode 100644 docs/globalVariables.md

diff --git a/docs/INSTALL.ubuntu1804.md b/docs/INSTALL.ubuntu1804.md
index f9a764de5..f6613322c 100644
--- a/docs/INSTALL.ubuntu1804.md
+++ b/docs/INSTALL.ubuntu1804.md
@@ -7,6 +7,8 @@
     Maintained and tested by the community.
     It is also partially the basis of the [bootstrap.sh](https://github.com/MISP/misp-packer/blob/18.04/scripts/bootstrap.sh) script of misp-packer.
 
+{!globalVariables.md!}
+
 ### 1/ Minimal Ubuntu install
 -------------------------
 
@@ -233,7 +235,7 @@ sudo openssl req -newkey rsa:4096 -days 365 -nodes -x509 \
 ============================================= End sample working SSL config for MISP
 ```
 
-```
+```bash
 # activate new vhost
 sudo a2dissite default-ssl
 sudo a2ensite misp-ssl
@@ -301,7 +303,8 @@ sudo -u www-data gpg --homedir /var/www/MISP/.gnupg --gen-key
 ```
 
 !!! notice
-    If entropy is not high enough, you can install rng-tools and then run rngd -r /dev/urandom do fix it quickly
+    If entropy is not high enough, you can install rng-tools and then run rngd -r /dev/urandom do fix it quickly<br />
+    In case rng-tools gives you troubles, haveged is an alternative.
 
 ```bash
 # And export the public key to the webroot
diff --git a/docs/globalVariables.md b/docs/globalVariables.md
new file mode 100644
index 000000000..7d526894f
--- /dev/null
+++ b/docs/globalVariables.md
@@ -0,0 +1,46 @@
+#### MISP configuration variables
+
+```bash
+
+# MISP configuration variables
+PATH_TO_MISP='/var/www/MISP'
+CAKE="$PATH_TO_MISP/app/Console/cake"
+MISP_BASEURL='""'
+MISP_LIVE='1'
+
+# Database configuration
+DBHOST='localhost'
+DBNAME='misp'
+DBUSER_ADMIN='root'
+DBPASSWORD_ADMIN="$(openssl rand -hex 32)"
+DBUSER_MISP='misp'
+DBPASSWORD_MISP="$(openssl rand -hex 32)"
+
+# Webserver configuration
+FQDN='localhost'
+
+# OpenSSL configuration
+OPENSSL_CN='Common Name'
+OPENSSL_C='LU'
+OPENSSL_ST='State'
+OPENSSL_L='Location'
+OPENSSL_O='Organization'
+OPENSSL_OU='Organizational Unit'
+OPENSSL_EMAILADDRESS='info@localhost'
+
+# GPG configuration
+GPG_REAL_NAME='Autogenerated Key'
+GPG_COMMENT='WARNING: MISP AutoGenerated Key consider this Key VOID!'
+GPG_EMAIL_ADDRESS='admin@admin.test'
+GPG_KEY_LENGTH='2048'
+GPG_PASSPHRASE='Password1234'
+
+# php.ini configuration
+upload_max_filesize=50M
+post_max_size=50M
+max_execution_time=300
+memory_limit=512M
+
+echo "Admin (root) DB Password: $DBPASSWORD_ADMIN"
+echo "User  (misp) DB Password: $DBPASSWORD_MISP"
+```
diff --git a/mkdocs.yml b/mkdocs.yml
index 78d78ca68..7d64d1b64 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -34,6 +34,10 @@ theme:
 
 # Extensions
 markdown_extensions:
+  - markdown_include.include:
+      base_path: docs
+  # mkdcomments is buggy atm, see: https://github.com/ryneeverett/python-markdown-comments/issues/3
+  #- mkdcomments
   - markdown.extensions.admonition
   - markdown.extensions.codehilite:
       guess_lang: false
diff --git a/tools/gen_misp_install_docs.sh b/tools/gen_misp_install_docs.sh
index 9eb4758e5..c262d8cdc 100755
--- a/tools/gen_misp_install_docs.sh
+++ b/tools/gen_misp_install_docs.sh
@@ -12,7 +12,7 @@ fi
 
 if [ -z "$VIRTUAL_ENV" ]; then
     virtualenv -p python3 mkdocs
-    ${PWD}/mkdocs/bin/pip install mkdocs mkdocs-material
+    ${PWD}/mkdocs/bin/pip install mkdocs mkdocs-material markdown-include python-markdown-comments
 fi
 
 wget -O ../docs/Changelog.md https://www.misp-project.org/Changelog.txt