Updated /docs folder.

README.md

@@ -1,6 +1,9 @@
 # Nibras PKM
 
-**Nibras PKM** is an __offline open source system__ for the __long-term management__ of __personal__ information. It is a combination of a __web-based__ application intended for desktop use, and an Android __mobile__ reader application.
+**Nibras PKM** is a __local open source__ system for the __long-term management__ of __personal__ information. It is a combination of a __web-based__ application intended for desktop use, and an Android __mobile__ reader application.
+
+![](https://raw.githubusercontent.com/mfakih294/Nibras-PKM/master/docs/images/screenshot.jpg)
+
 
 **Open source**
 
@@ -14,9 +17,6 @@ It manages resources (articles, books, documents), notes, writings, tasks, goals
 
 It was designed with large amounts of information in mind. In current usage, it manages dozens of thousands of records. With its commands and saved searches, it makes easy to navigate through all the information.
 
-
-![Screenshots](http://khuta.org/nibras-doc/images/nibras-1.2.4.jpg)
-
 ## Main Features
 
 * **Flexible text-based commands** to add, update and search records, which provides powerful ways to manage information.
@@ -51,10 +51,12 @@ Once Nibras has finished launching, a text message like the one below will appea
 
 `************************************************************`
 
-Go to * https://localhost:1441/nibras* using Firefox or Chrome. On the login page, enter *nibras* for username and *nibras* for the password.
-
-Note: To stop Nibras, you can close this window, or press ctrl+c in it, or run ./scripts/stop script.
+Go to **https://localhost:1441/nibras** using Firefox or Chrome. On the login page, enter *nibras* for username and *nibras* for the password.
 
+Notes: 
+- As it has a self-signed certificate, you need to accept and bypass the security warning that shows up at the beginning.
+- On Linux, you need to make the files inside ./scripts and ./tomcat/bin folders executable (chmod +x *).
+- To stop Nibras, you can close this window, or press ctrl+c in it, or run ./scripts/stop script.
 
 ## Technical details
 

docs/10.html

@@ -161,12 +161,24 @@
                 <h1 id="installation-and-configuration">Installation and Configuration</h1>
 <h2 id="installation">Installation</h2>
 <p>To install Nibras, you have one of three options:</p>
-<h3 id="quick-demonstration-installation">Quick demonstration installation</h3>
-<p>It requires two steps. First, you need to install JRE (Java runtime environment) 8 or later. Second, download the latest jar file from the releases section on Nibras PKM github page and execute the command:</p>
-<p><code>java -Dgrails.env=h2 -jar nibras.jar</code></p>
-<p>This will instruct Nibras to use h2 as its database, which requires no extra installation or configuration.</p>
-<h3 id="standard-production-installation">Standard production installation</h3>
-<p>As before, you need to install JRE (Java runtime environment) 8 or later. Then download and install MySQL 5.5 or later, and finally download, extract and run the Nibras-Tomcat bundle as detailed below.</p>
+<h3 id="quick-installation">Quick installation</h3>
+<p>The quick installation consists of three steps:</p>
+<ul>
+<li>Download the bundle file corresponding to your platform, e.g. nibras-bundle-windows.zip.</li>
+<li>Extract the zipped file to a location of your choice on your local disk.</li>
+<li>Launch Nibras by double clicking on ./scripts/start file.</li>
+</ul>
+<p>Once Nibras has finished launching, a text message like the one below will appear.</p>
+<p><code>************************************************************</code></p>
+<p><code>* Nibras has launched. You can access it from: *</code></p>
+<p><code>* https://localhost:1441/nibras *</code></p>
+<p><code>************************************************************</code></p>
+<p>Note: To stop Nibras, you can close this window, or press ctrl+c in it, or run ./scripts/stop script.</p>
+<p>and finally download, extract and run the Nibras-Tomcat bundle as detailed below.</p>
+<p>To launch the application server, simply download and extract the file Nibras-Tomcat.zip from the releases section on Nibras PKM GitHub page to your hard disk on <strong>C:/</strong>, and run the batch file "Start-Nibras.bat" found on the /Nibras-Tomcat folder.</p>
+<p>This is the straightforward way to install Nibras on a typical computer. However, you may have other cases that needs changing Nibras configuration files, or its Nibras settings after launching it.</p>
+<h3 id="production-installation">Production installation</h3>
+<p>In addition to the steps of the quick installation, you need to download and install MySQL 5.5 or later.</p>
 <p><strong>MySQL</strong></p>
 <p>To install MySQL, simply download, install it, and then configure it. You can download from the official website, or, for convenience, from <a href="http://www.khuta.org/mysql-5.5.62-win32.msi">this location</a> (for Windows).</p>
 <p>After installation, you need to run the configuration wizard, accepting the default options, and making the two below changes:</p>
@@ -175,10 +187,7 @@ <h3 id="standard-production-installation">Standard production installation</h3>
 <li>Set the root password as "root". So you need to type the word "root" (without quotes) two times.</li>
 </ul>
 <p>Then you are ready to run the batch file "create-database.bat" found in /Nibras/Database folder.</p>
-<p><strong>Application server</strong></p>
-<p>To launch the application server, simply download and extract the file Nibras-Tomcat.zip from the releases section on Nibras PKM GitHub page to your hard disk on <strong>C:/</strong>, and run the batch file "Start-Nibras.bat" found on the /Nibras-Tomcat folder.</p>
-<p>This is the straightforward way to install Nibras on a typical computer. However, you may have other cases that needs changing Nibras configuration files, or its Nibras settings after launching it.</p>
-<p><strong>Other cases</strong></p>
+<h4 id="other-cases">Other cases</h4>
 <p>Your environment may not match or allow the above installation, and so you may want to customize it.</p>
 <p><strong>1 - MySQL already installed:</strong></p>
 <p>Need to change the parameters of MySQL connection in /Nibras/Application/Tomcat/conf/context.xml; specifically changing the hostname, port, username and password.</p>

docs/index.html

@@ -151,7 +151,7 @@ <h1 id="nibras-system">Nibras System</h1>
 
 <!-- **Nibras PKM** is an __offline open source system__ for the __long-term management__ of __personal__ information. It is a combination of a __web-based__ application intended for desktop use, and an Android __mobile__ reader application.-->
 
-<p><img alt="nibras-mainpage" src="images/nibras-main.jpg" /></p>
+<p><img alt="" src="./images/screenshot.jpg" /></p>
 <p><strong>Local</strong></p>
 <p>The user has full control over his/her data, without the need for a (fast) internet connection, and without all the distractions and information overload that the internet can cause.</p>
 <p><strong>Open source</strong></p>
@@ -224,5 +224,5 @@ <h2 id="nibras-reader">Nibras Reader</h2>
 
 <!--
 MkDocs version : 1.0.4
-Build Date UTC : 2020-06-04 08:52:41
+Build Date UTC : 2020-06-04 11:08:52
 -->

docs/source/docs/index.md

@@ -13,10 +13,7 @@ Nibras is a local open source system for the long-term management of personal in
 <!-- **Nibras PKM** is an __offline open source system__ for the __long-term management__ of __personal__ information. It is a combination of a __web-based__ application intended for desktop use, and an Android __mobile__ reader application.-->
 
 
-
-
-![nibras-mainpage](./images/nibras-main.jpg)
-
+![](./images/screenshot.jpg)
 
 
 **Local**

grails-app/init/nibras/BootStrap.groovy

@@ -31,14 +31,13 @@ class BootStrap {
         println ''
         println ' ************************************************************'
         println ' *                                                          *'
-        println ' * Nibras has launched.                                     *'
-        println ' * In the standard configuration, you can access it from:   *'
+        println ' * Nibras has launched. You can access it from:   *'
         println ' *                                                          *'
         println ' * https://localhost:1441/nibras                            *'
         println ' *                                                          *'
-	println ' * To stop Nibras, press ctrl+c in this window, or          *'
-	println ' * run ./scripts/stop script.                               *'
- 	println ' *                                                          *'
+//	println ' * Note: To stop Nibras, press ctrl+c in this window, or          *'
+//	println ' * run ./scripts/stop script.                               *'
+// 	println ' *                                                          *'
         println ' ************************************************************'
         println ''
         println ''

scripts/build.bat

@@ -2,6 +2,6 @@
 set PATH=D:\dev\grails-3.3.10\bin;C:\Program Files\Java\jdk1.8.0_111\jre\bin;
 set GRAILS_HOME=D:\dev\grails-3.3.10
 set JAVA_HOME=C:\Program Files\Java\jdk1.8.0_111
-set CATALINA=-server -Xmx780m
-
+set CATALINA=-server
+cd ..
 grails war

scripts/build.sh

@@ -5,13 +5,11 @@ export GRAILS_HOME=/nbr/dev/grails-3.3.10/
 
 export JAVA_HOME=/usr/lib/jvm/java-8-openjdk-amd64/
 
-export CATALINA="-server -Xmx780m"
-export JAVA_OPTS="-server -Xmx1400m"
+export CATALINA="-server"
+export JAVA_OPTS="-server"
 
-#grails clean
+cd ..
 grails war
-#grails -disable.auto.recompile=false -Dgrails.gsp.enable.reload=true run-app
-#		cp ./build/libs/nibras.war /home/alef/tomcat9/webapps/nibras.war
 
 # Keep the terminal window open until user enters an input.
  $SHELL

scripts/run.bat

@@ -2,7 +2,7 @@
 set PATH=D:\dev\grails-3.3.10\bin;C:\Program Files\Java\jdk1.8.0_111\jre\bin;
 set GRAILS_HOME=D:\dev\grails-3.3.10
 set JAVA_HOME=C:\Program Files\Java\jdk1.8.0_111
-set CATALINA=-server -Xmx780m
-
+set CATALINA=-server
+cd ..
 grails -disable.auto.recompile=false -Dgrails.gsp.enable.reload=true -https -Dgrails.env=dev run-app
 

scripts/run.sh

@@ -7,6 +7,7 @@ export JAVA_OPTS="-server"
 
 #grails clean
 #grails war
+cd ..
 grails -https -disable.auto.recompile=false -Dgrails.gsp.enable.reload=true run-app
 #		cp ./build/libs/nibras.war /home/alef/tomcat9/webapps/nibras.war