knox-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From lmc...@apache.org
Subject svn commit: r1581370 - /knox/trunk/books/0.4.0/quick_start.md
Date Tue, 25 Mar 2014 15:25:20 GMT
Author: lmccay
Date: Tue Mar 25 15:25:20 2014
New Revision: 1581370

URL: http://svn.apache.org/r1581370
Log:
removed reference to starting the gateway from java and added knoxcli for create-master

Modified:
    knox/trunk/books/0.4.0/quick_start.md

Modified: knox/trunk/books/0.4.0/quick_start.md
URL: http://svn.apache.org/viewvc/knox/trunk/books/0.4.0/quick_start.md?rev=1581370&r1=1581369&r2=1581370&view=diff
==============================================================================
--- knox/trunk/books/0.4.0/quick_start.md (original)
+++ knox/trunk/books/0.4.0/quick_start.md Tue Mar 25 15:25:20 2014
@@ -140,7 +140,7 @@ or
 Knox comes with an LDAP server for demonstration purposes.
 
     cd {GATEWAY_HOME}
-    java -jar bin/ldap.jar conf &
+    bin/ldap.sh start
 
 
 ### 7 - Start Knox  ###
@@ -148,33 +148,27 @@ Knox comes with an LDAP server for demon
 The gateway can be started in one of two ways, as java -jar or with a shell script.
 
 
-###### Starting via Java
+###### Starting via script
 
-This is the simplest way to start the gateway.
-Starting this way will result in all logging being written directly to standard output.
+Run the knoxcli create-master command in order to persist the master secret that is used
to protect the key and credential stores for the gateway instance.
 
+###### linux
     cd {GATEWAY_HOME}
-    java -jar bin/gateway.jar
-
-
-Upon start, Knox server will prompt you for the master secret (i.e. password).
-This secret is used to secure artifacts used by the gateway server for things like SSL and
credential/password aliasing.
-This secret will have to be entered at startup unless you choose to persist it.
-
-
-###### Starting via script (*nix only)
-
-Run the setup command with root privileges.
-
+    bin/knoxcli.sh create-master
+##### windows
     cd {GATEWAY_HOME}
-    sudo bin/gateway.sh setup
+    bin\knoxcli.cmd create-master
 
-The server will prompt you for the master secret (i.e. password).
+The cli will prompt you for the master secret (i.e. password).
 
-The server can then be started without root privileges using this command.
+The server will discover the persisted master secret during start up and complete the setup
process for demo installs. A demo install will consist of a knox gateway instance with an
identity certificate for localhost. This will require clients to be on the same machine or
to turn off hostname verification. For more involved deployments, See the Knox CLI section
of this document for additional commands - incuding the ability to create a self-signed certificate
for a specific hostname.
 
+##### linux
     cd {GATEWAY_HOME}
     bin/gateway.sh start
+##### windows
+    cd {GATEWAY_HOME}
+    bin\gateway.cmd start
 
 When starting the gateway this way the process will be run in the backgroud.
 The log output is written into the directory /var/log/knox.
@@ -182,13 +176,21 @@ In addition a PID (process ID) is writte
 
 In order to stop a gateway that was started with the script use this command.
 
+##### linux
     cd {GATEWAY_HOME}
     bin/gateway.sh stop
+##### windows
+    cd {GATEWAY_HOME}
+    bin\gateway.cmd start
 
 If for some reason the gateway is stopped other than by using the command above you may need
to clear the tracking PID.
 
+##### linux
     cd {GATEWAY_HOME}
     bin/gateway.sh clean
+##### windows
+    cd {GATEWAY_HOME}
+    bin\gateway.cmd clean
 
 __NOTE: This command will also clear any log output in /var/log/knox so use this with caution.__
 



Mime
View raw message