Merge pull request #127 from SteveClement/master

chg: [doc] Added quick-start sections in tl;dr

.travis.yml

@@ -8,6 +8,7 @@ sudo: required
 
 install:
     - sudo apt-get -y install libgif-dev calibre npm
+    - sudo npm config set strict-ssl false
     - sudo npm cache clean -f
     - sudo npm install -g n
     - sudo n stable
@@ -18,6 +19,7 @@ install:
     - npm install gitbook-plugin-github
     - npm install gitbook-plugin-toc
     - npm install gitbook-plugin-anchors
+    - npm install gitbook-plugin-image-class
 
 script:
     - gitbook install

USAGE.md

@@ -4,14 +4,18 @@ Install notes
 
 :warning: Make sure to be in the *misp-book* repository directory for the *npm magic*.
 Also: The *npm* plugin *autocover* is broken. It pulls an incompatible *canvas* module version. Thus patched repository used (forked from original)
+Finally: You will get a few errors on Ubuntu 18.04 which you can ignore for now. In the rather near future we need to think about an alternative as gitbook glides towards obsoletion and security risk.
 
-Tested on: *Ubuntu 16.04.4 LTS*
+Tested on: *Ubuntu 18.04 LTS* *Debian 9.5/sid/testing*
+[Terminal Recording of npm install lines on Ubuntu 18.04](https://asciinema.org/a/84JZMuGu2QlFH59q6mK8jbdQS)
 
 ```bash
-curl -sL https://deb.nodesource.com/setup_9.x | sudo -E bash -
+git clone git@github.com:MISP/misp-book.git
+cd misp-book
+curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash -
 sudo apt-get install -y nodejs
 sudo apt-get install -y build-essential
-sudo apt install -y npm pkg-config libcairo2-dev
+sudo apt install -y pkg-config libcairo2-dev libgif-dev
 npm install gitbook git+https://github.com/SteveClement/plugin-autocover.git gitbook-plugin-github gitbook-plugin-toc gitbook-plugin-anchors gitbook-plugin-image-class
 sudo npm install gitbook-cli -g
 gitbook install
@@ -101,7 +105,7 @@ xcode-select --install
 brew install pkg-config cairo pango libpng jpeg giflib
 ```
 
-:warning: Make sure to be in the *misp-book* repository directory for the npm magic.
+:warning: Make sure to be in the *misp-book* repository directory for the npm magic to work correctly.
 
 Installing gitbook and all dependencies wants to look like this (Tested on *macOS 11.13.3*):
 
@@ -111,6 +115,19 @@ npm install gitbook-cli -g
 gitbook install
 ```
 
+gitbook rebuild on change
+=========================
+
+By default gitbook has the '--watch' option enabled.
+If this is broken, use the included 'serve.sh' and the 'inoticoming' package.
+Start 'gitbook serve &' and run the following command line:
+
+```
+inoticoming --foreground . --suffix .md bash serve.sh \;
+```
+
+If any md changes, the gitbook process is killed and restarted.
+
 npm salvage
 ===========
 

quick-start/README.md

@@ -21,10 +21,11 @@ MISP default credentials:
 
 ## Tasks to do after first Start
 
-1. [Change admin password](https://misp.gitbooks.io/misp-book/content/quick-start/#password-policy)
+<!-- TODO: Consollidate all sources to misp-book -->
+1. [Change site admin password](https://misp.gitbooks.io/misp-book/content/quick-start/#password-policy)
 2. [Activate Feeds](https://www.circl.lu/doc/misp/managing-feeds/)
 3. [Setup your User](https://misp.gitbooks.io/misp-book/content/user-management/#first-run-of-the-system)
-3. [Administrate MISP](https://www.circl.lu/doc/misp/administration/)
+4. [MISP Administration](https://www.circl.lu/doc/misp/administration/)
 
 ## Password Policy 
 - [12]: Ensure that the password is at least 12 characters long
@@ -38,11 +39,25 @@ If you need a password generator use:
 - Ubuntu / Debian: [pwgen](https://linux.die.net/man/1/pwgen)
 - Website: [LastPass PW Generator](https://lastpass.com/generatepassword.php)
 - Built-in generator in Keepass* and other passwort manager
+- Built-in generator in various web browsers
 
 **All Generator tools are only possibilities without any guarantee!**
 
 <div class="pagebreak"></div>
 
+## tl;dr
+
+### Create an Event
+![Overview create an event in MISP](figures/quick_create.jpg)
+
+### Browse Past Events
+![Overview browse past evente in MISP](figures/quick_browse.jpg)
+
+### Export Events for logsearches
+![Overview export events for logsearches](figures/quick_export.jpg)
+
+<div class="pagebreak"></div>
+
 ## Create an Event
 
 ![Create an Event in MISP](figures/AddEvent.jpg)
@@ -51,7 +66,7 @@ You only have to add a few pieces of information to register your Event. Further
 
 ## Describe Event
 
-Red is totally normal. No worries. (In future releases this will potentially change to a more harmonious color)
+Red is totally normal. No worries. (In future releases this will change to a more harmonious color)
 
 ![Describe Event](figures/AddEventOK.jpg)
 

serve.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+# Kill any existing instances of "gitbook serve"
+ps -Af | grep node | grep "gitbook serve" | awk '{print $2}' | xargs kill 2>/dev/null
+if [ "$1" = "shutdown" ]; then echo "Goodbye!"; exit 0; fi;
+
+# Launch the server
+gitbook serve . &