Merge branch 'master' of github.com:trueos/sysadm

docs/api_reference/classes/dispatcher.rst

@@ -21,15 +21,14 @@ Every dispatcher class request contains several parameters:
 | namespace     | rpc        |                                      |
 |               |            |                                      |
 +---------------+------------+--------------------------------------+
-| action        |            | Actions include "list" and "kill".   |
-|               |            |                                      |
+| action        |            | Actions include "list", "kill", and  |
+|               |            | "run".                               |
 +---------------+------------+--------------------------------------+
 
 The rest of this section provides examples of the available *actions*
 for each type of request, along with their responses.
 
 .. index:: list, dispatcher
-
 .. _List Processes:
 
 List Processes
@@ -131,4 +130,52 @@ running jobs within the dispatcher system.
   "id": "fooid",
   "name": "response",
   "namespace": "rpc"
- }
+ }
+
+.. index:: run, dispatcher
+.. _Run Processes:
+
+Run Process(es)
+===============
+
+The "run" action allows a user with full access to create new jobs
+within the dispatcher system.
+
+**REST Request**
+
+::
+
+ PUT /rpc/dispatcher
+ {
+   "action" : "run",
+   "job_id" : "<some_command -with_flags>",
+   "multi_job_id" : ["<command1>", "<command2>", "<command3>"]
+ }
+
+**WebSocket Request**
+
+.. code-block:: json
+
+ {
+   "args" : {
+      "action" : "run",
+      "job_id" : "<some_command -with_flags>",
+      "multi_job_id" : ["<command1>", "<command2>", "<command3>"]
+   },
+   "namespace" : "rpc",
+   "name" : "dispatcher",
+   "id" : "fooid"
+ }
+
+**Response**
+
+.. code-block:: json
+
+ {
+  "args": {
+    "started": ["job_id", "multi-job_id"]
+  },
+  "id": "fooid",
+  "name": "response",
+  "namespace": "rpc"
+ }

docs/client_handbook/sysadmclient.rst

@@ -381,37 +381,54 @@ The :guilabel:`Settings` tab is shown in
 
 .. _update4:
 
-.. figure:: images/update4.png
+.. figure:: images/update4a.png
 
-   : Settings Tab
+   : Update Manager Settings Tab
 
 This tab contains several configurable options:
 
 * **Max Boot Environments:** |trueos| automatically creates a boot
   environment before updating any software, the operating system, or
   applying a system update. Once the configured maximum number of boot
-  environments is reached, |trueos| will automatically prune (delete)
-  the oldest automatically created boot environment. However, it will
-  not delete any boot environments created manually using
+  environments is reached, |trueos| will automatically delete the oldest
+  automatically created boot environment. However, it will not delete
+  any boot environments created manually using the
   :ref:`Boot Environment Manager`. The default number of boot
   environments is *5*, with an allowable range from *1* to *10*.
 
 * **Automatically perform updates:** When checked, the automatic
-  updater automatically keeps your system and packages up-to-date.
-  An update has completed when the pop-up menu indicates a reboot is
-  needed to complete the update process. If
+  updater keeps the system and packages up-to-date. An update has
+  completed when the pop-up menu indicates a reboot is needed to
+  complete the update process. If
   :guilabel:`Automatically perform updates` is unchecked, an update will
-  only occur at the user's discretion. Updates are not required to be
-  initiated manually. |trueos| uses an automated updater which
-  automatically checks for updates, no more than once per day, 20
-  minutes after a reboot and then every 24 hours.
+  only occur at the user's discretion. By default, updates will **not**
+  be automatic. |trueos| uses an automated updater which checks for
+  updates no more than once per day, 20 minutes after a reboot and then
+  every 24 hours.
 
-* **Custom Package Repository:** To use a custom package repository for
-  updates, check this box. This will activate the :guilabel:`URL`
-  field so the user can input the URL to the custom repository.
+* **Automatically reboot to finish updates:** This selection initiates
+  a system reboot at a designated time in order to finish the update
+  process. By default, this selection is **unchecked**. Once checked,
+  the reboot time can be configured to a specific hour of the day.
+  Highlight the hour number and either type a new hour, or use the
+  :guilabel:`arrows` to increase or decrease the hour. Highlight
+  :guilabel:`AM/PM` to adjust this value. 
+
+* **Repositories:** |trueos| uses two repositories for updates,
+  :guilabel:`STABLE` and :guilabel:`UNSTABLE`. :guilabel:`STABLE` will
+  only update to formally released updates. :guilabel:`UNSTABLE` is the
+  testing location for upcoming updates. It is recommended only for
+  advanced users or those who wish to help test |trueos| and |lumina|.
+
+  To use a custom package repository for updates, check
+  :guilabel:`CUSTOM`. This will activate the :guilabel:`URL` field so
+  the user can input the URL to the custom repository.
+
+Once all options are configured to their desired settings, click
+:guilabel:`Save Settings`.
 
 .. index:: updates
-.. _Upgrading from PC-BSD® 10.x to TrueOS®:
+.. _Upgrading from PCBSD 10.x to TrueOS:
 
 Upgrading from |pcbsd| 10.x to |trueos|
 ---------------------------------------

port-files/files/sysadm-bridge.in

@@ -2,13 +2,44 @@
 # Copyright (c) 2016 Ken Moore <ken@ixsystems.com>
 # Released under the 2-clause BSD license
 
-command="%%PREFIX%%/bin/sysadm-bridge"
-command_args="&"
-pid=/var/run/sysadm-bridge.pid
-name="SysAdm Bridge"
+name="SysAdm Server (Bridge)"
 
 depend() { 
-	need syscons net
+	need net
 	after bootmisc
 	keyword -shutdown
 }
+
+start()
+{
+	ebegin "Starting $name"
+	start-stop-daemon --start -m -b -p /var/run/sysadm-bridge.pid \
+		%%PREFIX%%/bin/sysadm-bridge
+	eend $?
+}
+
+stop()
+{
+	ebegin "Stopping $name"
+	start-stop-daemon --stop --exec %%PREFIX%%/bin/sysadm-bridge \
+		-p /var/run/sysadm-bridge.pid
+	eend $?
+}
+
+ssl_keygen()
+{
+	if [ ! -d "%%PREFIX%%/etc/sysadm" ] ; then
+    		mkdir -p %%PREFIX%%/etc/sysadm
+	fi
+	if [ ! -e "%%PREFIX%%/etc/sysadm/ws_bridge.key" ] ; then
+		openssl req -x509 -nodes -newkey rsa:2048 \
+		-keyout %%PREFIX%%/etc/sysadm/ws_bridge.key \
+		-out %%PREFIX%%/etc/sysadm/ws_bridge.crt -days 102400 \
+		-subj "/C=US/ST=MY/L=NULL/O=SysAdm/OU=SysAdm/CN=SysAdm/emailAddress=none@example.org" 2>/dev/null
+	fi
+}
+
+start_pre()
+{
+	ssl_keygen "$1"
+}

port-files/files/sysadm-rest.in

@@ -2,13 +2,42 @@
 # Copyright (c) 2016 Ken Moore <ken@ixsystems.com>
 # Released under the 2-clause BSD license
 
-command="%%PREFIX%%/bin/sysadm-server"
-command_args="-rest &"
-pid=/var/run/sysadm-rest.pid
 name="SysAdm Server (REST)"
 
 depend() { 
-	need syscons net
+	need net
 	after bootmisc
 	keyword -shutdown
 }
+
+start()
+{
+	ebegin "Starting $name"
+	start-stop-daemon --start -m -b -p /var/run/sysadm-rest.pid \
+		%%PREFIX%%/bin/sysadm-binary -- -rest
+	eend $?
+}
+
+stop()
+{
+	ebegin "Stopping $name"
+	start-stop-daemon --stop --exec %%PREFIX%%/bin/sysadm-binary \
+		-p /var/run/sysadm-rest.pid
+	eend $?
+}
+
+ssl_keygen()
+{
+	if [ ! -d "%%PREFIX%%/etc/sysadm" ] ; then
+    		mkdir -p %%PREFIX%%/etc/sysadm
+	fi
+	openssl req -x509 -nodes -newkey rsa:2048 \
+		-keyout %%PREFIX%%/etc/sysadm/restserver.key \
+		-out %%PREFIX%%/etc/sysadm/restserver.crt -days 1024 \
+		-subj "/C=US/ST=MY/L=NULL/O=SysAdm/OU=SysAdm/CN=SysAdm/emailAddress=none@example.org" 2>/dev/null
+}
+
+start_pre()
+{
+	ssl_keygen "$1"
+}

port-files/files/sysadm.in

@@ -2,13 +2,42 @@
 # Copyright (c) 2016 Ken Moore <ken@ixsystems.com>
 # Released under the 2-clause BSD license
 
-command="%%PREFIX%%/bin/sysadm-server"
-command_args="&"
-pid=/var/run/sysadm.pid
 name="SysAdm Server (WebSocket)"
 
 depend() { 
-	need syscons net
+	need net
 	after bootmisc
 	keyword -shutdown
 }
+
+start()
+{
+	ebegin "Starting $name"
+	start-stop-daemon --start -m -b -p /var/run/sysadm.pid \
+		%%PREFIX%%/bin/sysadm-binary
+	eend $?
+}
+
+stop()
+{
+	ebegin "Stopping $name"
+	start-stop-daemon --stop --exec %%PREFIX%%/bin/sysadm-binary \
+		-p /var/run/sysadm.pid
+	eend $?
+}
+
+ssl_keygen()
+{
+	if [ ! -d "%%PREFIX%%/etc/sysadm" ] ; then
+    		mkdir -p %%PREFIX%%/etc/sysadm
+	fi
+  	openssl req -x509 -nodes -newkey rsa:2048 \
+		-keyout %%PREFIX%%/etc/sysadm/wsserver.key \
+		-out %%PREFIX%%/etc/sysadm/wsserver.crt -days 1024 \
+		-subj "/C=US/ST=MY/L=NULL/O=SysAdm/OU=SysAdm/CN=SysAdm/emailAddress=none@example.org" 2>/dev/null
+}
+
+start_pre()
+{
+	ssl_keygen "$1"
+}