Commit Graph

785 Commits

Author SHA1 Message Date
Mrt134
751c98f2f0 Update to sysadmclient.rst: TRANSLATIONS
- Update translation files.
2016-11-01 13:37:29 -04:00
Mrt134
3914300bd6 Minor update to sysadmclient.rst:
- Fix a few trademark replacement errors.
2016-11-01 13:36:25 -04:00
Joe Maloney
3b59548333 Remove this depend from sysadm. Not used. 2016-10-31 14:19:50 -04:00
Ken Moore
8da65605c2 Add a new setting to the update manager specifically for SysAdm:
"auto_update_reboot" = "0"-"23" (hour of the day)
If this is set (to a valid number), then SysAdm will automatically reboot the system to finish performing updates at the specified hour. Any other setting (or the value not being set) disables this option.
2016-10-25 14:02:26 -04:00
Ken Moore
37f1633550 Merge branch 'master' of github.com:trueos/sysadm 2016-10-25 12:42:43 -04:00
Ken Moore
2099f39d58 Add the auto-update hooks directly into the sysadm server.
Now the automatic 15 minute health checks will startup the update process if the autoupdate option is set rather than relying on anacrontab.
2016-10-25 12:41:06 -04:00
Mrt134
ac981fced6 Update trademark replacement script: TRANSLATIONS
- Update translation files.
2016-10-24 11:50:10 -04:00
Mrt134
31673de619 Update trademark reUpdate trademark replacement script:
- Registered trademark replacement script now displays the symbol as a superscript.
- Fixed a build error with referencing an image present in the TrueOS handbook, but not with SysAdm. Rewrote the reference to stand alone and should now work in both handbooks.
2016-10-24 11:46:56 -04:00
Kris Moore
301ed021bf Don't display "Time" at the end of dataset in Lifepreserver REST
return call

Fixes: trueos/trueos-core#86
2016-10-19 15:51:09 -04:00
Mrt134
c00cf735ad Update Sysadm Reference Guide:
- Fix errors with the responses for the dispatcher event system.
- Added notes explaining the various system states and their effect on the report.
- Renamed connections.rst to getstarted.rst to reflect the current handbook organization.
2016-10-17 15:43:16 -04:00
mrt134
309ffdb1df Update trueosstyle.css (all handbooks)
These elements are updated:
-Same size typewriter font for all these (same point size as normal font):
    :command:
    :file:
    :samp:
-(command is good, code.file still does 95% in main text)
-Table column headers like Description should be left-justified like table title and contents (also helps with finding them in wide browser windows)
-Semicircle ends on search box make it kind of not look like a search box.  Maybe just reduce the rounding.
-Font sizes in tables is reduced by one standard size.  No need for these to be smaller at all, just use the same size as main text.
2016-10-12 13:39:42 -04:00
Mrt134
5308c3e211 Update Client Handbook: TRANSLATIONS
- Update translation files
2016-10-11 15:21:48 -04:00
Mrt134
691d901856 Update Client Handbook:
- Port over sysadm.rst from trueos-docs; maintain parity
- Add new images to fix build errors
- Remove obsolete directory "TrueOS Handbook port"
2016-10-11 15:19:30 -04:00
Mrt134
e2ae246e15 Update client handbook with trueos-docs commit: TRANSLATIONS
- Update translation files.
2016-10-03 10:26:37 -04:00
Mrt134
473257fc7b Update client handbook with trueos-docs commit: Issue resolution and other small changes
- maintain parity with trueos handbook
2016-10-03 10:24:39 -04:00
Mrt134
6f2fe69a80 Update Life Preserver "Replication" section to warn about snapshot frequency.
- Added additional bullet point to the list of snapshot requirements for configuring replication.
- Updated translation files.
2016-09-29 13:47:48 -04:00
mrt134
512092be71 SysAdm Client Handbook Update (Firewall Manager)
- Add new section for Firewall Manager.
- Add screenshot of manager interface.
- Write full walkthrough of the interface.
- Update translation files.
2016-09-21 16:54:51 -04:00
Ken Moore
58334a1fa1 Merge branch 'master' of github.com:trueos/sysadm 2016-09-19 09:51:34 -04:00
Ken Moore
6924dad755 When making changes to the update manager repo/url - clear out the last check for updates so the next ping will re-check using the new settings.
Also remove some old comments from the service manager.
2016-09-19 09:50:43 -04:00
Kris Moore
2380a15a3d Add i18n stuff for sysadm handbooks 2016-09-16 13:42:13 -04:00
Mrt134
2de60fc3df Update sysadm client:
- Add new section for "Service Manager"
- Update all screenshots to be properly captioned.
- Add screenshot for the service manager.
- A few minor whitespace and wording fixes.
2016-09-15 13:37:07 -04:00
Mrt134
010fc464a2 Merge branch 'master' of github.com:trueos/sysadm 2016-09-13 13:03:53 -04:00
Mrt134
1149f0b365 API update: Guide up to date 9/13/16
- Add new class to API reference guide: firewall.
- Add all new actions to firewall class.
- Format code blocks and text descriptions.
2016-09-13 13:00:47 -04:00
Ken Moore
44b6b88699 Clean up the firewall manager check for if it is enabled. Now it returns almost instantly instead of waiting for a few seconds. 2016-09-13 12:41:16 -04:00
Ken Moore
70289f9d7a Oops - now the top parser will output the whole command. 2016-09-13 12:13:09 -04:00
Ken Moore
024c049f35 Merge branch 'master' of github.com:trueos/sysadm 2016-09-13 12:08:13 -04:00
Ken Moore
9df060fd3d Cleanup a couple backend API calls:
1) In the system manager "process info" function, use the -a flag for top so we get the whole command instead of just the first binary.
2)Cleanup a bit more of the backend of the new firewall manager.
2016-09-13 12:05:38 -04:00
Mrt134
3ee59ea0cc Small fix to references:
- Fixed some broken references in TrueOS handbook due to trademark symbols.
- Ported changes back to this handbook to ensure parity; no build errors created.
2016-09-13 10:48:33 -04:00
Mrt134
cf42180fbd Full review of sysadmclient.rst
- Whitespace fixes.
- Clean up unnecessary sentence fragments.
- Add guilabel roles.
- Grammar and spelling rewrites.
- PEP8 fixes.
- Trademark substitutions added.
- Added TODO comments for screenshots which require an update or new screenshot.
- Rewrote internal references to be external. The sysadm client file should now be completely agnostic, and able to be copy/pasted between the TrueOS handbook and SysAdm client handbook.
2016-09-13 10:31:42 -04:00
Ken Moore
c9f227eebc API CHANGE: last sysadm/firewall action
Final action for the sysadm/firewall class: "action" = "reset-defaults"
This will reset all the firewall settings back to defaults and restart the firewall.
NOTE: This will only work on TrueOS - plain FreeBSD does not have any concept of default firewall settings and this API call will return an error in that case.

REST Request (example):
-------------------------------
PUT /sysadm/firewall
{
   "action" : "reset-defaults"
}

WebSocket Request:
-------------------------------
{
   "id" : "fooid",
   "args" : {
      "action" : "reset-defaults"
   },
   "namespace" : "sysadm",
   "name" : "firewall"
}

Response:
-------------------------------
{
  "args": {
    "result": "success"
  },
  "id": "fooid",
  "name": "response",
  "namespace": "sysadm"
}
2016-09-13 08:07:31 -04:00
Ken Moore
c089525bf7 API CHANGE: 5 simple "actions" for sysadm/firewall
Add five new "actions" for managing the firewall:
"start" - turn on the firewall
"stop" - turn off the firewall
"restart" - reload the firewall (catches any settings changes - not generally needed)
"enable" - automatically start the firewall on bootup
"disable" - do not start the firewall on bootup

They all use the same input/output syntax, just the "action" input field is different

REST Request (example):
-------------------------------
PUT /sysadm/firewall
{
   "action" : "restart"
}

WebSocket Request:
-------------------------------
{
   "id" : "fooid",
   "args" : {
      "action" : "restart"
   },
   "namespace" : "sysadm",
   "name" : "firewall"
}

Response:
-------------------------------
{
  "args": {
    "result": "success"
  },
  "id": "fooid",
  "name": "response",
  "namespace": "sysadm"
}
2016-09-13 07:39:27 -04:00
Ken Moore
aca7bbc7b0 API CHANGE: new action for sysadm/firewall
"action":"close"
REQUIRED: "ports":["<number>/<type>", "<number2>"/"<type2>"]

This will close the designated ports in the firewall

REST Request (example):
-------------------------------
PUT /sysadm/firewall
{
   "action" : "close",
   "ports" : [
      "12151/tcp"
   ]
}

WebSocket Request:
-------------------------------
{
   "id" : "fooid",
   "namespace" : "sysadm",
   "name" : "firewall",
   "args" : {
      "ports" : [
         "12151/tcp"
      ],
      "action" : "close"
   }
}

Response:
-------------------------------
{
  "args": {
    "result": "success"
  },
  "id": "fooid",
  "name": "response",
  "namespace": "sysadm"
}
2016-09-12 15:52:56 -04:00
Ken Moore
ed3296eaf3 API CHANGE: New action for sysadm/firewall
"action":"open"
REQUIRES: "ports":[<number>/<type>, <number2>/<type2>]

REST Request (example):
-------------------------------
PUT /sysadm/firewall
{
   "action" : "open",
   "ports" : [
      "12151/tcp"
   ]
}

WebSocket Request:
-------------------------------
{
   "namespace" : "sysadm",
   "name" : "firewall",
   "args" : {
      "ports" : [
         "12151/tcp"
      ],
      "action" : "open"
   },
   "id" : "fooid"
}

Response:
-------------------------------
{
  "args": {
    "result": "success"
  },
  "id": "fooid",
  "name": "response",
  "namespace": "sysadm"
}
2016-09-12 15:47:54 -04:00
Ken Moore
108a2da675 API CHANGE: New action for sysadm/firewall
"action":"status"
Returns the current status of the firewall

REST Request (example):
-------------------------------
PUT /sysadm/firewall
{
   "action" : "status"
}

WebSocket Request:
-------------------------------
{
   "name" : "firewall",
   "args" : {
      "action" : "status"
   },
   "id" : "fooid",
   "namespace" : "sysadm"
}

Response:
-------------------------------
{
  "args": {
    "is_enabled": "true",
    "is_running": "true"
  },
  "id": "fooid",
  "name": "response",
  "namespace": "sysadm"
}
2016-09-12 15:29:24 -04:00
Ken Moore
6b348c3940 API CHANGE:
Add a new "action" for the new sysadm/firewall class:
"action":"list_open"
Returns an array of all the open port/type combinations for the firewall.

REST Request (example):
-------------------------------
PUT /sysadm/firewall
{
   "action" : "list_open"
}

WebSocket Request:
-------------------------------
{
   "args" : {
      "action" : "list_open"
   },
   "id" : "fooid",
   "name" : "firewall",
   "namespace" : "sysadm"
}

Response:
-------------------------------
{
  "args": {
    "openports": [
      "5353/udp"
    ]
  },
  "id": "fooid",
  "name": "response",
  "namespace": "sysadm"
}
2016-09-12 15:21:02 -04:00
Ken Moore
45bb83a05f API CHANGE:
Add a new class to sysadm: sysadm/firewall
This is the new firewall manager (ipfw), for setting options for the system firewall.

Initial API Call: "action":"known_ports"
This will return a list of all known ports and any names/descriptions for them (this is a static list - it does not reflect which ports are in-use or opened on the system. It is just for matching a port to a name/description)

REST Request (example):
-------------------------------
PUT /sysadm/firewall
{
   "action" : "known_ports"
}

WebSocket Request:
-------------------------------
{
   "id" : "fooid",
   "namespace" : "sysadm",
   "args" : {
      "action" : "known_ports"
   },
   "name" : "firewall"
}

Response:
-------------------------------
{
  "args": {
    "1/tcp": {
      "description": "#TCP Port Service Multiplexer",
      "name": "tcpmux",
      "port": "1/tcp"
    },
    "1/udp": {
      "description": "#TCP Port Service Multiplexer",
      "name": "tcpmux",
      "port": "1/udp"
    },
    "100/tcp": {
      "description": "#[unauthorized use]",
      "name": "newacct",
      "port": "100/tcp"
    }
  }
  "id": "fooid",
  "name": "response",
  "namespace": "sysadm"
}
2016-09-12 13:18:32 -04:00
Ken Moore
efc7bfeaad Merge branch 'master' of github.com:trueos/sysadm 2016-09-09 15:24:44 -04:00
Ken Moore
341082fe42 Cleanup a lot of the firewall manager backend class. Should be ready for hooking up API calls now. 2016-09-09 15:24:02 -04:00
Mrt134
68e8bb16bb Add substitutions patch to conf.py for all handbooks. 2016-09-08 12:44:59 -04:00
Mrt134
5e60b7479c Update sysadmclient.rst
- Fix build errors related to internal references to the TrueOS handbook.
  Internal references have been replaced with links to specific sections of the
  online trueos handbook.
- Fix PEP8 errors and a few unfinished sentences.
- Rework introduction slightly to reference the server handbook and note the
  remote access elements are disabled by default.
2016-09-06 13:39:38 -04:00
Mrt134
d29ad39e78 Merge sysadmclient.rst from trueos-docs repo into sysadm client handbook
- Copy over sysadmclient.rst from trueos-docs repo and reconfigure index and conf files to incorporate the file.
- Add all required images for sysadmclient.rst.
2016-09-06 12:09:25 -04:00
Mrt134
49fb902581 Review server handbook:
- Rewrite Introduction section for clarity.
- Add references to other SysAdm handbooks.
- Fix whitespace issues in all files.
- Fix numerous errors in all files.
- Add note about the current WIP nature of SysAdm.
- Add note listing current default ports SysAdm needs to be opened for remote access to work.
  Also noted the user can redefine which ports SysAdm uses.
2016-09-06 10:57:30 -04:00
Jeff 'Raid' Baitis
a1dfac0392 Allow for case insensitive matching on the name of packages.
This mimics the behavior of 'pkg search', which performs a case
insensitive search.
2016-09-02 00:00:04 -07:00
Mrt134
f5d9caefed Update API reference, client, and server handbooks
- Edited link colors to be a stronger blue/red color.
- Altered hover role for links to add underlining to the link texts.
- Restyled roles
  - Unified padding boxes and colors (exception: :guilabel: uses a different color).
    All roles should now have the same height padding, which has been reduced as well.
  - Role colors have all been lightened to avoid being distracting or making
    contained text hard to read.
  - Removed bold from :menuselection:.
  - :command: now renders as a monospace font.
- Restyled admonitions
  - Darkened text inside admonition boxes.
  - Rounded border elements around boxes.
  - Reworked borders to be smaller and darker in color.
- Fixed figure captions to be smaller and fit better with the surrounding text.
- Restyled tables
  - Table captions now have the same style as figure captions.
  - Altered color for headers
  - Added hover themeing for tables: mousing over a row or header title will change its color.
2016-09-01 13:37:37 -04:00
Mrt134
cc1c83be7b API Reference Guide update:
- Add new class file: services.rst.
- Update all API calls to current: Aug 30,2016
2016-08-30 14:39:37 -04:00
Ken Moore
75f21cfe1b API CHANGE
Last round of new "action"s for the sysadm/services class,
"action":"[enable/disable]"
Required input arguments:
"services":["service1","service2","etc"]

Exactly the same syntax as the start/stop/restart API calls, just a different action and the output field is "services_[enabled/disabled]" as well.
2016-08-30 14:22:33 -04:00
Ken Moore
0408f61f4c API CHANGE
Add the "is_running" output field to the sysadm/services "list_services" output.
This also cleans up the is_enabled detection routine so it should be more reliable.
2016-08-30 13:32:53 -04:00
Ken Moore
8a594044bb API CHANGE
Add 3 new API calls (all almost the same - just different "actions" and the return message will be slightly different)

"action":"start" OR "stop" OR "restart"
This will [start/stop/restart] services on the system.
REQUIRED ARGUMENTS:
"services" : <string with a single service, or array of services>

EXAMPLE "start" command (change "services_started" in responce to "services_[started/stopped/restarted]" as needed to match the action:

REST Request (example):
-------------------------------
PUT /sysadm/services
{
   "action" : "start",
   "services" : [
      "cupsd"
   ]
}

WebSocket Request:
-------------------------------
{
   "args" : {
      "action" : "start",
      "services" : [
         "cupsd"
      ]
   },
   "name" : "services",
   "id" : "fooid",
   "namespace" : "sysadm"
}

Response:
-------------------------------
{
  "args": {
    "services_started": [
      "cupsd"
    ]
  },
  "id": "fooid",
  "name": "response",
  "namespace": "sysadm"
}
2016-08-30 11:27:51 -04:00
Ken Moore
200a7de9e0 API CHANGE
Add a new output field to the sysadm/updates "check for updates".

args:{
  "details":"<details about updates>"
}
2016-08-30 10:04:30 -04:00
Kris Moore
cd959daa3f Ken missed a } 2016-08-29 22:54:04 -04:00