diff --git a/docs/api_reference/getstarted.rst b/docs/api_reference/getstarted.rst index ec73b35..9df8af0 100644 --- a/docs/api_reference/getstarted.rst +++ b/docs/api_reference/getstarted.rst @@ -14,6 +14,13 @@ JSON (JavaScript Object Notation) format. For detailed descriptions of these items, please refer to their respective websites at http://www.websocket.org and http://json.org/. +The |sysadm| API Reference Guide is freely available for sharing and +redistribution under the terms of the +`Creative Commons Attribution License `_. +This means you have permission to copy, distribute, translate, and adapt +the work as long as you attribute the |lumina| Project as the original +source of the Handbook. + .. _Authentication: Authentication diff --git a/docs/client_handbook/index.rst b/docs/client_handbook/index.rst index b3bca8b..e09c71c 100644 --- a/docs/client_handbook/index.rst +++ b/docs/client_handbook/index.rst @@ -15,3 +15,9 @@ Indices and tables * :ref:`modindex` * :ref:`search` +The |sysadm| Client Handbook is freely available for sharing and +redistribution under the terms of the +`Creative Commons Attribution License `_. +This means you have permission to copy, distribute, translate, and adapt +the work as long as you attribute the |lumina| Project as the original +source of the Handbook. \ No newline at end of file diff --git a/docs/server_handbook/basics.rst b/docs/server_handbook/basics.rst index 1b0372c..d11eb9a 100644 --- a/docs/server_handbook/basics.rst +++ b/docs/server_handbook/basics.rst @@ -9,11 +9,11 @@ SysAdm™ files are currently available from the .. _building: -Building SysAdm™ ----------------- +Building |sysadm| +----------------- Several Qt Modules are required before attempting to build -SysAdm™: +|sysadm|: .. code-block:: none @@ -21,7 +21,7 @@ SysAdm™: Qt5 Concurrent (# pkg install qt5-concurrent) Qt5 Websockets (# pkg install qt5-websockets) -Building the prototype version of SysAdm™ assumes you have access to +Building the prototype version of |sysadm| assumes you have access to github.com. .. code-block:: none @@ -33,10 +33,10 @@ github.com. .. _starting: -Starting SysAdm™ ----------------- +Starting |sysadm| +----------------- -SysAdm™ can be started one of two ways: the traditional rc(8) +|sysadm| can be started one of two ways: the traditional rc(8) mechanism or using the new jobd(8) mechanism To run under rc(8) @@ -62,13 +62,13 @@ To run under jobd(8) % sudo jobctl org.pcbsd.sysadm-rest enable .. danger:: Several ports on the system firewall will need to be opened - for SysAdm™ to have remote access functionality: + for |sysadm| to have remote access functionality: * Port 12149 for WebSocket interaction. * Port 12150 for the REST interface. - * Port 12151 for the SysAdm™ bridge server. + * Port 12151 for the |sysadm| bridge server. - The user can also designate their own ports for SysAdm™. + The user can also designate their own ports for |sysadm|. .. _bridge init: @@ -77,7 +77,7 @@ 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 +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. @@ -125,7 +125,7 @@ Adding a Client to the Server/Bridge Connection ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. danger:: 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 + |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 import an SSL key bundle as prompted by the diff --git a/docs/server_handbook/introduction.rst b/docs/server_handbook/introduction.rst index 941873a..93a0f5a 100644 --- a/docs/server_handbook/introduction.rst +++ b/docs/server_handbook/introduction.rst @@ -5,37 +5,44 @@ Introduction **Preface** -Written by users of the SysAdm™ management utility. +Written by users of the |sysadm| management utility. Version |version| Copyright © 2016 iXSystems®. -Welcome to SysAdm™! This documentation is intended to educate the user -on initializing and configuring the SysAdm™ remote management options. +The |sysadm| Server Handbook is freely available for sharing and +redistribution under the terms of the +`Creative Commons Attribution License `_. +This means you have permission to copy, distribute, translate, and adapt +the work as long as you attribute the |lumina| Project as the original +source of the Handbook. + +Welcome to |sysadm|! This documentation is intended to educate the user +on initializing and configuring the |sysadm| remote management options. Initialization and management will be documented in two separate chapters, :ref:`gettingstarted`, and :ref:`management`. -.. warning:: SysAdm™ is still under heavy development, and all +.. warning:: |sysadm| is still under heavy development, and all information contained in the documentation is subject to change. **What is SysAdm™?** -SysAdm™ is a middleware utility designed to streamline system management +|sysadm| is a middleware utility designed to streamline system management with options for both local and remote access. -.. note:: By default, SysAdm™ does **not** allow for remote access. +.. note:: By default, |sysadm| does **not** allow for remote access. The user must configure the system to allow this feature. -One unique element to SysAdm™ is how the middleware is designed to -modify the system directly. SysAdm™ has no middleware database, which -means all changes made with SysAdm™ modify the system configuration +One unique element to |sysadm| is how the middleware is designed to +modify the system directly. |sysadm| has no middleware database, which +means all changes made with |sysadm| modify the system configuration files directly, resulting in a system administrator no longer needing to -log into a system via SSH or relearn system management. SysAdm™ "speaks" +log into a system via SSH or relearn system management. |sysadm| "speaks" the same language, allowing for simple and effective system administration. -For remote access, SysAdm™ is being designed to route encrypted traffic +For remote access, |sysadm| is being designed to route encrypted traffic through a "bridge", a static announcement server which facilitates communication between the user's controlling device and the remote access system. @@ -47,14 +54,14 @@ record or alter critical information flow. **Would you like to know more?** -Documentation for the SysAdm™ project is split amongst three handbooks: +Documentation for the |sysadm| project is split amongst three handbooks: * **API Reference Guide**: A library of all API calls and WebSocket - requests for SysAdm™. This reference is constantly updated as new API + requests for |sysadm|. This reference is constantly updated as new API calls are written. It can be found at https://api.sysadm.us/. * **Client Handbook**: A detailed guide to all client side functions - of SysAdm™. + of |sysadm|. -* **Server Handbook**: A basic guide to initializing SysAdm™ with +* **Server Handbook**: A basic guide to initializing |sysadm| with a bridge and server connection. \ No newline at end of file diff --git a/docs/server_handbook/manage.rst b/docs/server_handbook/manage.rst index cf9de15..73ec436 100644 --- a/docs/server_handbook/manage.rst +++ b/docs/server_handbook/manage.rst @@ -1,14 +1,14 @@ .. _management: -Managing SysAdm™ -================ +Managing |sysadm| +================= -SysAdm™ comes with a standard configuration file located in +|sysadm| comes with a standard configuration file located in :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 :file:`sysadm.conf`. Here are the -current default settings for SysAdm™: +current default settings for |sysadm|: .. code-block:: none @@ -36,5 +36,5 @@ This default configuration also has blacklist options: counter) BLACKLIST_AUTH_FAIL_RESET_MINUTES=10 -Please note these default options are subject to change as the SysAdm™ +Please note these default options are subject to change as the |sysadm| utility is developed. \ No newline at end of file