From e184d4b9d65bfe110e6cccbe50aa4705efc96ead Mon Sep 17 00:00:00 2001 From: Mrt134 Date: Thu, 2 Jun 2016 15:02:17 -0400 Subject: [PATCH] Updated "starting sysadm" section - Updated Starting SysAdm section to reflect current instructions - Fixed a couple grammar and spelling errors in the Bridge Initialization section --- docs/basics.rst | 40 ++++++++++++++++++++++++---------------- 1 file changed, 24 insertions(+), 16 deletions(-) diff --git a/docs/basics.rst b/docs/basics.rst index 6ece666..4f752df 100644 --- a/docs/basics.rst +++ b/docs/basics.rst @@ -32,25 +32,33 @@ Building the prototype version of SysAdm™ assumes you have access to github.co Starting SysAdm™ ---------------- -SysAdm™ has two functioning states, WebSockets (preferred) and REST. -Websockets allow the client to stay connected over a long period of time, allowing the usage of notifications and events. -The REST server mode is more limited as it only allows the user to send and receive single messages over a short term connection. -Please note that it is possible to enable SysAdm™ to function in both states simultaneously. :: - - (Websocket - recommended) - % sudo sysrc -f /etc/rc.conf sysadm_enable="YES" - % sudo service sysadm start +SysAdm can be started one of two ways: 1. The traditional rc(8) mechanism 2. The new jobd(8) mechanism - (Optional for REST) - % sudo sysrc -f /etc/rc.conf sysadm_rest_enable="YES" - % sudo service sysadm-rest start +To run under rc(8):: + + (For WebSockets - Required for SysAdm Client) + % sudo sysrc -f /etc/rc.conf sysadm_enable="YES" + % sudo service sysadm start + + (Optional for REST) + % sudo sysrc -f /etc/rc.conf sysadm_rest_enable="YES" + % sudo service sysadm-rest start + + +To run under jobd(8):: + + (For WebSockets - Required for SysAdm Client) + % sudo jobctl org.pcbsd.sysadm enable + + (Optional for REST) + % sudo jobctl org.pcbsd.sysadm-rest enable .. _bridge init: Bridge Initialization --------------------- -Configuring and connecting to a bridge can be a complicated process. Thankfully, there are several steps that are done the first time a server and bridge are configured with SysAdm but do not need to be repeated later. Once these steps are complete, it becomes a much simpler process to for a new user to add their client to the now configured server and bridge. +Configuring and connecting to a bridge can be a complicated process. Thankfully, there are several steps that are done the first time a server and bridge are configured with SysAdm but do not need to be repeated later. Once these steps are complete, it becomes a much simpler process for a new user to configure their client to communicate with the now configured server and bridge. .. _serverbridge init: @@ -61,12 +69,12 @@ To initialize the server and bridge, begin with the server. Run :command:`sudo s .. note:: For both server and client, giving SSL key files an easy to remember name and location will simplify the process of finding those files for import to the bridge. -Now, we must transition to the bridge to import this token. Login to the bridge as the administrator (or root), then type :command:`sysadm-bridge -import_ssl_file ` to import the server key file. If not already active, start the bridge now. +Now, we must transition to the bridge to import the server key. Login to the bridge as the administrator (or root), then type :command:`sysadm-bridge -import_ssl_file `, replacing and with the server key filename and location. Once the server key file is successfully imported, start the bridge (if not already running). .. note:: The bridge can import SSL files whether it is active or not with no negative effects. -Moving back to the server, run :command:`sudo sysadm-binary bridge_add ` to point the server at the bridge. A bridge runs on **port 12149** by default, so the URL will likely need **:12149** added to the end (Example URL: 127.0.0.1:12149). If necessary, (re)start the server. The log (:file:`/var/log/sysadm-server-ws.log`) should display messages about connecting to the bridge. -The server and bridge should now be configured and communicating with each other. Now we can begin to add clients which will communicate with the server through the bridge. +Back on the server, run :command:`sudo sysadm-binary bridge_add ` to point the server at the bridge. A bridge runs on **port 12149** by default, so the URL will likely need **:12149** added on the end of the address (Example URL: 127.0.0.1:12149). If necessary, (re)start the server. The log (:file:`/var/log/sysadm-server-ws.log`) will display messages about connecting to the bridge. +If properly configured, the server and bridge will now be communicating with each other. At this point clients can be added to the mix which will communicate with the server through the bridge. .. _add client: @@ -75,7 +83,7 @@ Adding a Client to the Server/Bridge Connection .. note:: If you have an old SSL bundle from a pre-alpha version of SysAdm created before June 2016, it will need to be removed prior to proceeding with the client initialization process. -In the client UI, create or manage the SSL bundle as prompted by the UI. Once the new SSL keys are created, open :menuselection:`Setup SSL --> View Certificates` in the connection manager and click "Save to File" for both the server and bridge keys. This will export both SSL keys in file form, depositing them in either the "Desktop" folder or home directory (depending on operating system). If necessary, send these key files as an email attachment to your system administrator as part of a request for server/bridge access. +In the client UI, create or import an SSL key bundle as prompted by the UI. Once the new SSL keys are created, open :menuselection:`Setup SSL --> View Certificates` in the connection manager and click "Save to File" for both the server and bridge keys. This will export both SSL keys in file form, depositing them in either the "Desktop" folder or home directory (depending on operating system). If necessary, send these key files as an email attachment to the system administrator as part of a request for server/bridge access. Moving to the bridge, as the administrator (or root), run :command:`sysadm-bridge -import_ssl_file ` for the requesting client's bridge key file. Now the client and bridge should be able to communicate, but the client/server connection still needs to be established.