From bfb99d34ce0588a5a77af6a04ad9d8374a0daa61 Mon Sep 17 00:00:00 2001 From: Tim Moore II Date: Mon, 4 Apr 2016 13:06:12 -0400 Subject: [PATCH 1/4] Content addition to the SysAdm server docs -Added two new docs as chapters -Bringing readme information over to .rst for downloading and building SysAdm --- docs/index.rst | 2 ++ docs/introduction.rst | 10 +++++++++- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index 7c24d02..1694719 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -12,6 +12,8 @@ Contents: :maxdepth: 4 introduction + basics + manage Indices and tables ================== diff --git a/docs/introduction.rst b/docs/introduction.rst index 05ae05d..15aa3be 100644 --- a/docs/introduction.rst +++ b/docs/introduction.rst @@ -1,3 +1,6 @@ + +.. _intro: + Introduction ============ @@ -9,4 +12,9 @@ Version |version| Copyright © 2016 iXSystems®. -Welcome to SysAdm®! +.. Intro Text WIP +Welcome to SysAdm®! This documentation is intended to educate the user on initializing and managing SysAdm. +Initialization and management will be documented in two separate chapters, :ref:`gettingstarted`, and :ref:`management`. +API documentation is being handled at https://api.pcbsd.org. + + From 919457d54f4ff7a61de5aee651fe9a70a5f91103 Mon Sep 17 00:00:00 2001 From: Tim Moore II Date: Mon, 4 Apr 2016 13:11:32 -0400 Subject: [PATCH 2/4] Forgot to add the new files from the previous commit. --- docs/basics.rst | 55 +++++++++++++++++++++++++++++++++++++++++++++++++ docs/manage.rst | 8 +++++++ 2 files changed, 63 insertions(+) create mode 100644 docs/basics.rst create mode 100644 docs/manage.rst diff --git a/docs/basics.rst b/docs/basics.rst new file mode 100644 index 0000000..13dd45f --- /dev/null +++ b/docs/basics.rst @@ -0,0 +1,55 @@ +.. _gettingstarted: + +Getting Started +=============== + +Beginning with SysAdm is a relatively simple process. +SysAdm files are currently available from the `github repository `_ + + +.. _building: + +Building SysAdm +--------------- + +The following Qt Modules are required before attempting to build SysAdm: :: + + Qt5 Core (# pkg install qt5-core) + Qt5 Concurrent (# pkg install qt5-concurrent) + Qt5 Network (# pkg install qt-network) + Qt5 Sql (# pkg install qt5-sql) + Qt5 Websockets (# pkg install qt5-websockets) + +Building the prototype version of SysAdm assumes you have access to github.com. :: + + % git clone https://github.com/pcbsd/sysadm.git + % cd sysadm/src + % /usr/local/lib/qt5/bin/qmake -recursive + % make && sudo make install + +.. _starting: + +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 + + (Optional for REST) + % sudo sysrc -f /etc/rc.conf sysadm_rest_enable="YES" + % sudo service sysadm-rest start + + +.. _adddoc: + +Additional Documentation +------------------------ + +API documentation can be found at https://api.pcbsd.org . + diff --git a/docs/manage.rst b/docs/manage.rst new file mode 100644 index 0000000..9080b88 --- /dev/null +++ b/docs/manage.rst @@ -0,0 +1,8 @@ +.. _management: + +SysAdm Management +================= + +.. WIP + + \ No newline at end of file From 185f064b34f3b10e9cf1551d13b90d55f34350c3 Mon Sep 17 00:00:00 2001 From: Tim Moore II Date: Mon, 4 Apr 2016 13:34:52 -0400 Subject: [PATCH 3/4] Text addition to manage.rst - added sysadm default config settings and the process to create custom configs to manage.rst --- docs/manage.rst | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/docs/manage.rst b/docs/manage.rst index 9080b88..5b9c3c0 100644 --- a/docs/manage.rst +++ b/docs/manage.rst @@ -3,6 +3,28 @@ SysAdm Management ================= -.. WIP +SysAdm comes with a standard configuration file located at :file:`/usr/local/etc/sysadm.conf.dist`. + +It is possible to edit this file for a custom configuration, but the result will need to be saved as :kbd:`sysadm.conf`. +Here is the current default settings for SysAdm:: - \ No newline at end of file + #Sample Configuration file for the sysadm server + + ### Server Port Number ### + # - Websocket Server (standard) + PORT=12150 + # - REST Server (started with the "-rest" CLI flag) + PORT_REST=12151 + +This default configuration also has blacklist options, recreated here:: + + ### Blacklist options ### + # - Number of minutes that an IP remains on the blacklist + BLACKLIST_BLOCK_MINUTES=60 + # - Number of authorization failures before an IP is placed on the blacklist + BLACKLIST_AUTH_FAIL_LIMIT=5 + # - Number of minutes of no activity from an IP before resetting the failure counter + # (Note: A successful authorization will always reset the fail counter) + BLACKLIST_AUTH_FAIL_RESET_MINUTES=10 + +Please note these default options are subject to change as the SysAdm utility is developed. \ No newline at end of file From b11281e2bc6bc18e054609435f5ea3288e927738 Mon Sep 17 00:00:00 2001 From: Tim Moore II Date: Mon, 4 Apr 2016 13:48:55 -0400 Subject: [PATCH 4/4] -Added tm to 'SysAdm' --- docs/basics.rst | 20 ++++++++++---------- docs/introduction.rst | 5 +++-- docs/manage.rst | 10 +++++----- 3 files changed, 18 insertions(+), 17 deletions(-) diff --git a/docs/basics.rst b/docs/basics.rst index 13dd45f..7b6dc63 100644 --- a/docs/basics.rst +++ b/docs/basics.rst @@ -3,16 +3,16 @@ Getting Started =============== -Beginning with SysAdm is a relatively simple process. -SysAdm files are currently available from the `github repository `_ +Beginning with SysAdm™ is a relatively simple process. +SysAdm™ files are currently available from the `github repository `_ .. _building: -Building SysAdm ---------------- +Building SysAdm™ +---------------- -The following Qt Modules are required before attempting to build SysAdm: :: +The following Qt Modules are required before attempting to build SysAdm™: :: Qt5 Core (# pkg install qt5-core) Qt5 Concurrent (# pkg install qt5-concurrent) @@ -20,7 +20,7 @@ The following Qt Modules are required before attempting to build SysAdm: :: Qt5 Sql (# pkg install qt5-sql) Qt5 Websockets (# pkg install qt5-websockets) -Building the prototype version of SysAdm assumes you have access to github.com. :: +Building the prototype version of SysAdm™ assumes you have access to github.com. :: % git clone https://github.com/pcbsd/sysadm.git % cd sysadm/src @@ -29,13 +29,13 @@ Building the prototype version of SysAdm assumes you have access to github.com. .. _starting: -Starting SysAdm ---------------- +Starting SysAdm™ +---------------- -SysAdm has two functioning states, WebSockets (preferred) and REST. +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. :: +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" diff --git a/docs/introduction.rst b/docs/introduction.rst index 15aa3be..554756f 100644 --- a/docs/introduction.rst +++ b/docs/introduction.rst @@ -6,14 +6,15 @@ Introduction **Preface** -Written by users of the SysAdm® management utility. +Written by users of the SysAdm™ management utility. Version |version| Copyright © 2016 iXSystems®. .. Intro Text WIP -Welcome to SysAdm®! This documentation is intended to educate the user on initializing and managing SysAdm. + +Welcome to SysAdm™! This documentation is intended to educate the user on initializing and managing SysAdm™. Initialization and management will be documented in two separate chapters, :ref:`gettingstarted`, and :ref:`management`. API documentation is being handled at https://api.pcbsd.org. diff --git a/docs/manage.rst b/docs/manage.rst index 5b9c3c0..58b05eb 100644 --- a/docs/manage.rst +++ b/docs/manage.rst @@ -1,12 +1,12 @@ .. _management: -SysAdm Management -================= +SysAdm™ Management +================== -SysAdm comes with a standard configuration file located at :file:`/usr/local/etc/sysadm.conf.dist`. +SysAdm™ comes with a standard configuration file located at :file:`/usr/local/etc/sysadm.conf.dist`. It is possible to edit this file for a custom configuration, but the result will need to be saved as :kbd:`sysadm.conf`. -Here is the current default settings for SysAdm:: +Here is the current default settings for SysAdm™:: #Sample Configuration file for the sysadm server @@ -27,4 +27,4 @@ This default configuration also has blacklist options, recreated here:: # (Note: A successful authorization will always reset the fail counter) BLACKLIST_AUTH_FAIL_RESET_MINUTES=10 -Please note these default options are subject to change as the SysAdm utility is developed. \ No newline at end of file +Please note these default options are subject to change as the SysAdm™ utility is developed. \ No newline at end of file