Doc changes

Author: JLiscom

Doc/Install.md

@@ -1,32 +1,89 @@
 # How To Install
 [Download most resent release from here.][Download]
 
-# Using Docker(Full Stack)
-Make sure docker in running in daemon mode with restart previously running containers on
-`docker -d -r` or you could louse your notes if you do not know what your doing
+# HTML5 based new super fancy version
+## Web app
+Just extract in a HTML5 compatible webserver public directory. Or just use the GitHub hosted version.
+
+## CouchDB Install
+If you want sync your notes with a server, you will need to install CouchDB.
+[CouchDB Download page](http://couchdb.apache.org/)
+
+You will need to enable CORS in CouchDB
+The easiest way to do this is to use `add-cors-to-couchdb`
+```shell
+npm install -g add-cors-to-couchdb
+add-cors-to-couchdb
+```
 
-Pull the current docker image 
-`docker pull foxusa/opennote`
+Run the commands below substituting `http://127.0.0.1:5984/` with the url of your server
+```shell
+# Create DB
+curl -X PUT http://127.0.0.1:5984/opennote
+
+# Set permissions on opennote database
+curl -X PUT http://localhost:5984/opennote/_security \
+	-u admin:password \
+	-H "Content-Type: application/json" \
+	-d '{"admins": { "names": ["admin"], "roles": [] }, "members": { "names": ["admin"], "roles": [] } }'
+
+# SSL
+curl -X PUT http://localhost:5984/_config/daemons/httpsd \
+	-u admin:password \
+	-H "Content-Type: application/json" \
+	-d '"{couch_httpd, start_link, [https]}"'
+
+mkdir /etc/couchdb/cert
+openssl genrsa > /etc/couchdb/cert/privkey.pem
+openssl req -new -x509 -key /etc/couchdb/cert/privkey.pem -out /etc/couchdb/cert/mycert.pem -days 1095
+
+curl -X PUT http://127.0.0.1:5984/_config/ssl/cert_file \
+	-u admin:password \
+	-H "Content-Type: application/json" \
+	-d '"/etc/couchdb/cert/mycert.pem"'
+
+curl -X PUT http://127.0.0.1:5984/_config/ssl/key_file \
+	-u admin:password \
+	-H "Content-Type: application/json" \
+	-d '"/etc/couchdb/cert/privkey.pem"'
+
+# Default SSL port 6984
+```
 
-and run it on port 80
-`sudo docker run -d -p 80:80 -p 443:443 foxusa/opennote`
+Now in `/OpenNote/#/settings/database/` put the following connection string in the `Replication url` field `https://admin:[email protected]:6984/opennote`
 
-or if port 80 is in use
-`sudo docker run -d -p 8080:80 -p 8443:443 foxusa/opennote`
+To import a database from older versions check out `/OpenNote/#/settings/legacy/`
 
-# Automatic(Wizard Based Install)
+# Legacy service
+The legacy service is still included to migrate data to the new data structure.
+All write endpoints have been hidden with the exception of the file upload api's.
+
+### Automatic(Wizard Based Install)
 To run the installer open
 `<install path>/Service/install.php`
 
 Make sure you delete `install.php` and `Config.template`.
 
-### Security Note
+#### Security Note
 Be default we put the sqlite databse in the web folder. This is not a good idea. We solved this by putting in a htaccess file to not allow the database to be downloaded.
 
 Still, you should move this file out of the webserver directory and change the location in `Config.php`
 
-## Manual
-###MYSql
+### Using Docker(Full Stack)
+Make sure docker in running in daemon mode with restart previously running containers on
+`docker -d -r` or you could louse your notes if you do not know what your doing
+
+Pull the current docker image
+`docker pull foxusa/opennote`
+
+and run it on port 80
+`sudo docker run -d -p 80:80 -p 443:443 foxusa/opennote`
+
+or if port 80 is in use
+`sudo docker run -d -p 8080:80 -p 8443:443 foxusa/opennote`
+
+### Manual
+####MYSql
 - Create a MYSQL database named "OpenNote"
 - Download and extract OpenNote into a folder on your php web-server called "OpenNote"
 - Open up the `Service/model/sql` folder and run `notebook.sql` in your OpenNote database
@@ -38,10 +95,10 @@ These are stored in the following lines of code in `/OpenNote/Config.php`:
 	$dbServer = "127.0.0.1";
 	$dbName = "notebook";
 ```
-			
+
 - Now the site install is complete. You can now open the site by going to your webserver url +/OpenNote
 
-###SQLite
+####SQLite
 - Download and extract OpenNote into a folder on your php web-server called "OpenNote"
 - Create a SQLite database file and execute the SQL DDL from `Service/model/sql` and run `notebook.sqlite.sql`.
 - Change the database connection settings inside of `Service/Config.php` to match your db settings.
@@ -59,7 +116,7 @@ Comment the following lines in the dbConfig function:
 ```php
 	$dbName = "../<relative path>/OpenNote.sqlite";
 ```
-			
+
 - Now the site install is complete. You can now open the site by going to your webserver url +/OpenNote
 
 [Download]: https://github.com/FoxUSA/OpenNote/releases

Doc/Upgrade.md

@@ -1,5 +1,18 @@
 # How to upgrade
 
+##Upgrading from 14.07(Locomotive) to 14.07.01(Steam Locomotive) or 14.07.01(Steam Locomotive) to 14.07.02 (Diesel Locomotive).
+All you need to do is merge your existing deployment with the release folder while keeping your config files (`openNote\openNote.config.js` and `\Service\Config.php`).
+
+###MySQL(Recomended)
+- Make sure you make a copy of you database and the OpenNote directory
+- Run `Service/model/sql/updateScript/` scripts to roll the database up to current specs.
+- You will copy need to copy the upload directory contents into the new upload direcory in `Service/upload`.
+- You will also need to put int you database information in the new config `Service/Config.php`
+
+###SQLite
+Same as the MySQL. You may need to slightly modify the sql upload script to be compatible with SQLite. I have included as much as I can in scripts with the postfix of .sqlite.sql. SQLite does not fully support the ALTER statement.
+
+
 ##Docker(14.07.01 to 14.07.02)
 Find the container id of your running container by doing a `docker ps` or `docker ps -l` if the OpenNote conatiner was the last one you stopped.
 You should see output like this
@@ -40,7 +53,7 @@ Commit it
 Get another new long containerID
 `cf77323ed72659b3462073763e9115ff16bb4ae64ce406176703bbc781011ccb`
 
-and run that with published ports 
+and run that with published ports
 `sudo docker run -d -p 80:80 -p 443:443 cf77323ed72659b3462073763e9115ff16bb4ae64ce406176703bbc781011ccb /run.sh`
 
 or if port 80 is in use
@@ -51,8 +64,8 @@ All done
 
 ##Manual installs
 
-##Upgrading from 14.07(Locomotive) to 14.07.01(Steam Locomotive) or 14.07.01(Steam Locomotive) to 14.07.02 (Diesel Locomotive). 
-All you need to do is merge your existing deployment with the release folder while keeping your config files (`openNote\openNote.config.js` and `\Service\Config.php`). 
+##Upgrading from 14.07(Locomotive) to 14.07.01(Steam Locomotive) or 14.07.01(Steam Locomotive) to 14.07.02 (Diesel Locomotive).
+All you need to do is merge your existing deployment with the release folder while keeping your config files (`openNote\openNote.config.js` and `\Service\Config.php`).
 
 ###MySQL(Recomended)
 - Make sure you make a copy of you database and the OpenNote directory

OpenNote/bower.json

@@ -4,7 +4,7 @@
     "Jacob Liscom <https://github.com/FoxUSA>"
   ],
   "description": "A note taking software",
-  "version": "15.06.0",
+  "version": "15.07.0",
   "dependencies": {
     "jquery": "2.1.4",
     "bootstrap": "3.3.4",

OpenNote/openNote/openNote.config.js

@@ -2,46 +2,46 @@
  * Angular js config file
  */
 openNote.value("config", {
-	
+
 	/**
 	 * Get current version
 	 */
 	getVersion: function(){
-		return "15.05.00";
+		return "15.07.00";
 	},
-	
+
 	/**
-	 * Get update URL 
+	 * Get update URL
 	 */
 	getUpdateURL: function(){
 		return "//stardrive.us/UpdateService/?appName=OpenNote-prod";
 	},
-	
+
 	/**
 	 * http path to backend rest service
 	 */
 	servicePath: function(){
 		var url = localStorage.getItem("serviceURL");
 		if(url)
 			return url;
-		
+
 		return "./Service/service.php";
 	},
-	
+
 	/**
 	 * Used to compute random short fade speed
 	 */
-	fadeSpeedShort: function(){ 
+	fadeSpeedShort: function(){
 		return 250*Math.random()+200;
 	},
-	
+
 	/**
 	 * Used to compute random long fade speed
 	 */
 	fadeSpeedLong: function(){
 		return 2000*Math.random()+200;
 	},
-	
+
 	/**
 	 * returns help contents
 	 */
@@ -61,17 +61,17 @@ openNote.value("config", {
 			noteTitle: "This the note title field. In edit mode, you can use it to edit the notes title."
 		}
 	},
-	
+
 	/**
 	 * Do we want to show the help button
 	 */
 	showHelpButton: function(){
 		return true;
 	},
-	
+
 	/**
 	 * Get server config
-	 * return - 
+	 * return -
 	 */
 	getServerConfig: function(){
 		return $resource(config.servicePath()+"/config/", {}, {//{} default params
@@ -80,13 +80,13 @@ openNote.value("config", {
 	        }
 	    }).$get();
 	},
-	
+
 	/**
 	 * See if we are dark or light
 	 */
 	isDarkTheme: function(){
 		return false;
-	}	
+	}
 });
 
 /**
@@ -95,4 +95,4 @@ openNote.value("config", {
  */
 openNote.config(function($compileProvider) {
 	$compileProvider.aHrefSanitizationWhitelist("[\s\S]*");
-});
+});

package.json

@@ -1,6 +1,6 @@
 {
   "name": "OpenNote",
-  "version": "14.07.0",
+  "version": "15.07.0",
   "description": "",
   "main": "Gruntfile.js",
   "author": "Jacob Liscom",