github-personal/sysadm
1
0
Fork 0
mirror of https://github.com/outbackdingo/sysadm.git synced 2026-01-27 02:20:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

-Added tm to 'SysAdm'

Browse Source
This commit is contained in:
Tim Moore II
2016-04-04 13:48:55 -04:00
parent 185f064b34
commit b11281e2bc
3 changed files with 18 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/basics.rst
View File

@@ -3,16 +3,16 @@
Getting Started
===============
Beginning with SysAdm is a relatively simple process.
SysAdm files are currently available from the `github repository <https://github.com/pcbsd/sysadm.git>`_
Beginning with SysAdm™ is a relatively simple process.
SysAdm™ files are currently available from the `github repository <https://github.com/pcbsd/sysadm.git>`_
.. _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"

5
docs/introduction.rst
View File

@@ -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.

10
docs/manage.rst
View File

@@ -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.
Please note these default options are subject to change as the SysAdm™ utility is developed.