From f862cc61ac6fd3d34145d36ec216cb145c4ff19c Mon Sep 17 00:00:00 2001
From: Rain <rain.by.zhou@gmail.com>
Date: Sat, 21 Nov 2020 18:46:02 +0800
Subject: [PATCH] add opengrok setup

Signed-off-by: Rain <rain.by.zhou@gmail.com>
---
 README.org | 40 ++++++++++++++++++++++++++++++++++++----
 1 file changed, 36 insertions(+), 4 deletions(-)

diff --git a/README.org b/README.org
index 94cb6b3..14035d9 100644
--- a/README.org
+++ b/README.org
@@ -1,12 +1,44 @@
 ** opengrok-restful.el
    
-   #+begin_src elisp
+*** Setup opengrok
+    
+    - Start opengrok server and limit the cpu usage of opengrok indexer.
+    - Period of automatic mirroring/reindexing (10min).
+    - The volume mounted to ~/Projects should contain the projects you want to make searchable.
+    - Open http://127.0.0.1:8080 to enjoy.
+
+    #+begin_src shell
+    $ sudo docker run -d --cpus="1.0" \
+        --name opengrok \
+        -p 8080:8080/tcp \
+        -e REINDEX="10" \
+        -v ~/Projects:/opengrok/src/ \
+        opengrok/docker:latest
+    #+end_src
+
+    - You can avoid to sync source code from upstream.
+
+    #+begin_src shell
+    $ sudo docker exec -it opengrok sed -i 's/opengrok-mirror/#opengrok-mirror/g' /scripts/index.sh
+    #+end_src
+
+    - You can manually trigger an reindex using docker exec.
+
+    #+begin_src shell
+    $ sudo docker exec -it opengrok /scripts/index.sh
+    #+end_src
+
+*** Setup opengrok-restful
+   
+    #+begin_src elisp
     (global-set-key (kbd "M-d") 'opengrok-restful-lookup-def)
     (global-set-key (kbd "M-f") 'opengrok-restful-lookup-full)
     (global-set-key (kbd "M-s") 'opengrok-restful-lookup-symbol)
     (global-set-key (kbd "M-p") 'opengrok-restful-lookup-path)
-   #+end_src
+    #+end_src
 
-   [[./opengrok-restful.gif]]
+    [[./opengrok-restful.gif]]
 
-   [[./opengrok-restful.png]]
+    [[./opengrok-restful.png]]
+
+