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

Merge branch 'master' of github.com:trueos/sysadm

Browse Source
This commit is contained in:
Ken Moore
2016-09-19 09:51:34 -04:00
parent 6924dad755 2380a15a3d
commit 58334a1fa1
162 changed files with 31383 additions and 192 deletions
Download Patch File Download Diff File Expand all files Collapse all files

72
docs/api_reference/Makefile
View File

@@ -4,9 +4,16 @@
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXINTL = sphinx-intl
PAPER =
BUILDDIR = _build
# User-friendly check for sphinx-build
SPHINXBUILDCHECK= := $(shell which $(SPHINXBUILD) 2>/dev/null)
.ifndef SPHINXBUILDCHECK
.error "The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don\'t have Sphinx installed, grab it from http://sphinx-doc.org/)"
.endif
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
@@ -29,20 +36,60 @@ help:
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " xml to make Docutils-native XML files"
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
@echo " i18n to fetch and prep the i18n files"
i18n:
$(MAKE) gettext
$(SPHINXINTL) -p $(BUILDDIR)/locale -d ./po update \
-l ar \
-l bg \
-l da \
-l de \
-l es \
-l fr \
-l id \
-l it \
-l pt_BR \
-l tr \
-l uk \
-l zh_CN \
-l zh_HK
$(SPHINXINTL) -d ./po build
clean:
-rm -rf $(BUILDDIR)/*
rm -rf $(BUILDDIR)/*
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
.if exists(po)
.if exists($(BUILDDIR)/locale-po)
@rm -rf $(BUILDDIR)/locale-po
.endif
@cp -r ./po $(BUILDDIR)/locale-po
$(SPHINXBUILD) -D language='bg' -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html-bg
$(SPHINXBUILD) -D language='da' -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html-da
$(SPHINXBUILD) -D language='de' -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html-de
$(SPHINXBUILD) -D language='es' -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html-es
$(SPHINXBUILD) -D language='fr' -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html-fr
$(SPHINXBUILD) -D language='id' -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html-id
$(SPHINXBUILD) -D language='it' -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html-it
$(SPHINXBUILD) -D language='pt_BR' -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html-pt_BR
$(SPHINXBUILD) -D language='tr' -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html-tr
$(SPHINXBUILD) -D language='uk' -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html-uk
$(SPHINXBUILD) -D language='zh_CN' -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html-zh_CN
$(SPHINXBUILD) -D language='zh_HK' -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html-zh_HK
.endif
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
@@ -77,17 +124,17 @@ qthelp:
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/FreeNAS.qhcp"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/PC-BSDUserGuide.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/FreeNAS.qhc"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/PC-BSDUserGuide.qhc"
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/FreeNAS"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/FreeNAS"
@echo "# mkdir -p $$HOME/.local/share/devhelp/PC-BSDUserGuide"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/PC-BSDUserGuide"
@echo "# devhelp"
epub:
@@ -108,6 +155,12 @@ latexpdf:
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
latexpdfja:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@@ -152,3 +205,12 @@ doctest:
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

558
docs/api_reference/classes/firewall.rst Normal file
View File

@@ -0,0 +1,558 @@
.. _firewall:
firewall
********
The firewall class is used for managing the "ipfw" firewall on the system.
.. note:: This class does *not* manage a "pf" firewall.
Every user request will have several parameters:
+---------------+-----------+---------------------------------------+
| **Parameter** | **Value** | **Description** |
| | | |
+===============+===========+=======================================+
| id | | any unique value for the request; |
| | | examples include a hash, checksum, |
| | | or uuid |
+---------------+-----------+---------------------------------------+
| name | firewall | |
| | | |
+---------------+-----------+---------------------------------------+
| namespace | sysadm | |
| | | |
+---------------+-----------+---------------------------------------+
| action | | "known_ports", "list_open", "status", |
| | | "open", "close", "start", "stop", |
| | | "restart", "enable", "disable", and |
| | | "reset-defaults" |
+---------------+-----------+---------------------------------------+
.. index:: knownports, firewall
.. _knownports:
Known Ports
===========
:command:`known_ports` will return a list of all known ports and any
names or descriptions for them. This is a static list; it does not
reflect which ports are in use or opened on the system. It is meant to
help match a port to a name or description.
**REST Request**
::
PUT /sysadm/firewall
{
"action" : "known_ports"
}
**WebSocket Request**
.. code-block:: json
{
"id" : "fooid",
"namespace" : "sysadm",
"args" : {
"action" : "known_ports"
},
"name" : "firewall"
}
**Response**
.. code-block:: json
{
"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"
}
.. index:: listopen, firewall
.. _listopen:
List Open
=========
:command:`list_open` returns an array of all the open port/type
combinations for the firewall.
**REST Request**
.. code-block:: none
PUT /sysadm/firewall
{
"action" : "list_open"
}
**WebSocket Request**
.. code-block:: json
{
"args" : {
"action" : "list_open"
},
"id" : "fooid",
"name" : "firewall",
"namespace" : "sysadm"
}
**Response**
.. code-block:: json
{
"args": {
"openports": [
"5353/udp"
]
},
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}
.. index:: status, firewall
.. _status:
Status
======
:command:`status` returns the current state of the firewall.
**REST Request**
.. code-block:: none
PUT /sysadm/firewall
{
"action" : "status"
}
**WebSocket Request**
.. code-block:: json
{
"name" : "firewall",
"args" : {
"action" : "status"
},
"id" : "fooid",
"namespace" : "sysadm"
}
**Response**
.. code-block:: json
{
"args": {
"is_enabled": "true",
"is_running": "true"
},
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}
.. index:: open, firewall
.. _open:
Open
====
:command:`open` will allow traffic through a specified port. The
action requires the argument::
"ports":[<number>/<type>, <number2>/<type2>]
**REST Request**
.. code-block:: none
PUT /sysadm/firewall
{
"action" : "open",
"ports" : [
"12151/tcp"
]
}
**WebSocket Request**
.. code-block:: json
{
"namespace" : "sysadm",
"name" : "firewall",
"args" : {
"ports" : [
"12151/tcp"
],
"action" : "open"
},
"id" : "fooid"
}
**Response**
.. code-block:: json
{
"args": {
"result": "success"
},
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}
.. index:: close, firewall
.. _close:
Close
=====
:command:`close` will close the designated ports in the firewall. An
additional statement is required: ::
"ports":["<number>/<type>", "<number2>"/"<type2>"]
**REST Request**
.. code-block:: none
PUT /sysadm/firewall
{
"action" : "close",
"ports" : [
"12151/tcp"
]
}
**WebSocket Request**
.. code-block:: json
{
"id" : "fooid",
"namespace" : "sysadm",
"name" : "firewall",
"args" : {
"ports" : [
"12151/tcp"
],
"action" : "close"
}
}
**Response**
.. code-block:: json
{
"args": {
"result": "success"
},
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}
.. index:: start, firewall
.. _firewallstart:
Start
=====
:command:`start` will turn on the firewall.
**REST Request**
.. code-block:: none
PUT /sysadm/firewall
{
"action" : "start"
}
**WebSocket Request**
.. code-block:: json
{
"id" : "fooid",
"args" : {
"action" : "start"
},
"namespace" : "sysadm",
"name" : "firewall"
}
**Response**
.. code-block:: json
{
"args": {
"result": "success"
},
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}
.. index:: stop, firewall
.. _firewallstop:
Stop
====
:command:`stop` will turn off the firewall.
**REST Request**
.. code-block:: none
PUT /sysadm/firewall
{
"action" : "stop"
}
**WebSocket Request**
.. code-block:: json
{
"id" : "fooid",
"args" : {
"action" : "stop"
},
"namespace" : "sysadm",
"name" : "firewall"
}
**Response**
.. code-block:: json
{
"args": {
"result": "success"
},
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}
.. index:: restart, firewall
.. _firewallrestart:
Restart
=======
:command:`restart` will reload the firewall. This will catch any
settings changes and is not generally needed.
**REST Request**
.. code-block:: none
PUT /sysadm/firewall
{
"action" : "restart"
}
**WebSocket Request**
.. code-block:: json
{
"id" : "fooid",
"args" : {
"action" : "restart"
},
"namespace" : "sysadm",
"name" : "firewall"
}
**Response**
.. code-block:: json
{
"args": {
"result": "success"
},
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}
.. index:: enable, firewall
.. _firewallenable:
Enable
======
:command:`enable` will automatically start the firewall on bootup.
**REST Request**
.. code-block:: none
PUT /sysadm/firewall
{
"action" : "enable"
}
**WebSocket Request**
.. code-block:: json
{
"id" : "fooid",
"args" : {
"action" : "enable"
},
"namespace" : "sysadm",
"name" : "firewall"
}
**Response**
.. code-block:: json
{
"args": {
"result": "success"
},
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}
.. index:: disable, firewall
.. _firewalldisable:
Disable
=======
:command:`disable` Flags the system to not start the firewall on bootup.
**REST Request**
.. code-block:: none
PUT /sysadm/firewall
{
"action" : "disable"
}
**WebSocket Request**
.. code-block:: json
{
"id" : "fooid",
"args" : {
"action" : "disable"
},
"namespace" : "sysadm",
"name" : "firewall"
}
**Response**
.. code-block:: json
{
"args": {
"result": "success"
},
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}
.. index:: resetdefaults, firewall
.. _resetdefaults:
Reset Defaults
==============
:command:`reset-defaults` will reset all the firewall settings back
to the defaults and restart the firewall.
.. warning:: This will only work in |trueos|; the API call will return
an error if used with FreeBSD.
**REST Request**
.. code-block:: none
PUT /sysadm/firewall
{
"action" : "reset-defaults"
}
**WebSocket Request**
.. code-block:: json
{
"id" : "fooid",
"args" : {
"action" : "reset-defaults"
},
"namespace" : "sysadm",
"name" : "firewall"
}
**Response**
.. code-block:: json
{
"args": {
"result": "success"
},
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}

109
docs/client_handbook/Makefile
View File

@@ -4,9 +4,16 @@
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXINTL = sphinx-intl
PAPER =
BUILDDIR = _build
# User-friendly check for sphinx-build
SPHINXBUILDCHECK= := $(shell which $(SPHINXBUILD) 2>/dev/null)
.ifndef SPHINXBUILDCHECK
.error "The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don\'t have Sphinx installed, grab it from http://sphinx-doc.org/)"
.endif
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
@@ -14,7 +21,8 @@ ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@@ -24,10 +32,8 @@ help:
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " applehelp to make an Apple Help Book"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " epub3 to make an epub3"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@@ -41,92 +47,101 @@ help:
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
@echo " coverage to run coverage check of the documentation (if enabled)"
@echo " dummy to check syntax errors of document sources"
@echo " i18n to fetch and prep the i18n files"
i18n:
$(MAKE) gettext
$(SPHINXINTL) -p $(BUILDDIR)/locale -d ./po update \
-l ar \
-l bg \
-l da \
-l de \
-l es \
-l fr \
-l id \
-l it \
-l pt_BR \
-l tr \
-l uk \
-l zh_CN \
-l zh_HK
$(SPHINXINTL) -d ./po build
.PHONY: clean
clean:
rm -rf $(BUILDDIR)/*
.PHONY: html
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
.if exists(po)
.if exists($(BUILDDIR)/locale-po)
@rm -rf $(BUILDDIR)/locale-po
.endif
@cp -r ./po $(BUILDDIR)/locale-po
$(SPHINXBUILD) -D language='bg' -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html-bg
$(SPHINXBUILD) -D language='da' -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html-da
$(SPHINXBUILD) -D language='de' -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html-de
$(SPHINXBUILD) -D language='es' -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html-es
$(SPHINXBUILD) -D language='fr' -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html-fr
$(SPHINXBUILD) -D language='id' -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html-id
$(SPHINXBUILD) -D language='it' -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html-it
$(SPHINXBUILD) -D language='pt_BR' -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html-pt_BR
$(SPHINXBUILD) -D language='tr' -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html-tr
$(SPHINXBUILD) -D language='uk' -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html-uk
$(SPHINXBUILD) -D language='zh_CN' -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html-zh_CN
$(SPHINXBUILD) -D language='zh_HK' -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html-zh_HK
.endif
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
.PHONY: dirhtml
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
.PHONY: singlehtml
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
.PHONY: pickle
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
.PHONY: json
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
.PHONY: htmlhelp
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
.PHONY: qthelp
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/SysAdmClientHandbook.qhcp"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/PC-BSDUserGuide.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/SysAdmClientHandbook.qhc"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/PC-BSDUserGuide.qhc"
.PHONY: applehelp
applehelp:
$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
@echo
@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
@echo "N.B. You won't be able to view it unless you put it in" \
"~/Library/Documentation/Help or install it in your application" \
"bundle."
.PHONY: devhelp
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/SysAdmClientHandbook"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/SysAdmClientHandbook"
@echo "# mkdir -p $$HOME/.local/share/devhelp/PC-BSDUserGuide"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/PC-BSDUserGuide"
@echo "# devhelp"
.PHONY: epub
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
.PHONY: epub3
epub3:
$(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3
@echo
@echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3."
.PHONY: latex
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@@ -134,33 +149,28 @@ latex:
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
.PHONY: latexpdf
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
.PHONY: latexpdfja
latexpdfja:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
.PHONY: text
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
.PHONY: man
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
.PHONY: texinfo
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@@ -168,58 +178,39 @@ texinfo:
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
.PHONY: info
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
.PHONY: gettext
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
.PHONY: changes
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
.PHONY: linkcheck
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
.PHONY: doctest
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
.PHONY: coverage
coverage:
$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
@echo "Testing of coverage in the sources finished, look at the " \
"results in $(BUILDDIR)/coverage/python.txt."
.PHONY: xml
xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
.PHONY: pseudoxml
pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
.PHONY: dummy
dummy:
$(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy
@echo
@echo "Build finished. Dummy builder generates no files."

BIN
docs/client_handbook/images/service1.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 28 KiB

BIN
docs/client_handbook/po/ar/LC_MESSAGES/index.mo Normal file
View File

Binary file not shown.

36
docs/client_handbook/po/ar/LC_MESSAGES/index.po Normal file
View File

@@ -0,0 +1,36 @@
#
msgid ""
msgstr ""
"Project-Id-Version: SysAdm™ Client Handbook 1.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2016-09-16 13:42-0400\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
#: ../../index.rst:11
msgid "Welcome to SysAdm™ Client Handbook's documentation!"
msgstr ""
#: ../../index.rst:13
msgid "Contents:"
msgstr ""
#: ../../index.rst:21
msgid "Indices and tables"
msgstr ""
#: ../../index.rst:23
msgid ":ref:`genindex`"
msgstr ""
#: ../../index.rst:24
msgid ":ref:`modindex`"
msgstr ""
#: ../../index.rst:25
msgid ":ref:`search`"
msgstr ""

BIN
docs/client_handbook/po/ar/LC_MESSAGES/sysadmclient.mo Normal file
View File

Binary file not shown.

1923
docs/client_handbook/po/ar/LC_MESSAGES/sysadmclient.po Normal file
View File

File diff suppressed because it is too large Load Diff

BIN
docs/client_handbook/po/bg/LC_MESSAGES/index.mo Normal file
View File

Binary file not shown.

36
docs/client_handbook/po/bg/LC_MESSAGES/index.po Normal file
View File

@@ -0,0 +1,36 @@
#
msgid ""
msgstr ""
"Project-Id-Version: SysAdm™ Client Handbook 1.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2016-09-16 13:42-0400\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
#: ../../index.rst:11
msgid "Welcome to SysAdm™ Client Handbook's documentation!"
msgstr ""
#: ../../index.rst:13
msgid "Contents:"
msgstr ""
#: ../../index.rst:21
msgid "Indices and tables"
msgstr ""
#: ../../index.rst:23
msgid ":ref:`genindex`"
msgstr ""
#: ../../index.rst:24
msgid ":ref:`modindex`"
msgstr ""
#: ../../index.rst:25
msgid ":ref:`search`"
msgstr ""

BIN
docs/client_handbook/po/bg/LC_MESSAGES/sysadmclient.mo Normal file
View File

Binary file not shown.

1923
docs/client_handbook/po/bg/LC_MESSAGES/sysadmclient.po Normal file
View File

File diff suppressed because it is too large Load Diff

BIN
docs/client_handbook/po/da/LC_MESSAGES/index.mo Normal file
View File

Binary file not shown.

36
docs/client_handbook/po/da/LC_MESSAGES/index.po Normal file
View File

@@ -0,0 +1,36 @@
#
msgid ""
msgstr ""
"Project-Id-Version: SysAdm™ Client Handbook 1.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2016-09-16 13:42-0400\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
#: ../../index.rst:11
msgid "Welcome to SysAdm™ Client Handbook's documentation!"
msgstr ""
#: ../../index.rst:13
msgid "Contents:"
msgstr ""
#: ../../index.rst:21
msgid "Indices and tables"
msgstr ""
#: ../../index.rst:23
msgid ":ref:`genindex`"
msgstr ""
#: ../../index.rst:24
msgid ":ref:`modindex`"
msgstr ""
#: ../../index.rst:25
msgid ":ref:`search`"
msgstr ""

BIN
docs/client_handbook/po/da/LC_MESSAGES/sysadmclient.mo Normal file
View File

Binary file not shown.

1923
docs/client_handbook/po/da/LC_MESSAGES/sysadmclient.po Normal file
View File

File diff suppressed because it is too large Load Diff

BIN
docs/client_handbook/po/de/LC_MESSAGES/index.mo Normal file
View File

Binary file not shown.

36
docs/client_handbook/po/de/LC_MESSAGES/index.po Normal file
View File

@@ -0,0 +1,36 @@
#
msgid ""
msgstr ""
"Project-Id-Version: SysAdm™ Client Handbook 1.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2016-09-16 13:42-0400\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
#: ../../index.rst:11
msgid "Welcome to SysAdm™ Client Handbook's documentation!"
msgstr ""
#: ../../index.rst:13
msgid "Contents:"
msgstr ""
#: ../../index.rst:21
msgid "Indices and tables"
msgstr ""
#: ../../index.rst:23
msgid ":ref:`genindex`"
msgstr ""
#: ../../index.rst:24
msgid ":ref:`modindex`"
msgstr ""
#: ../../index.rst:25
msgid ":ref:`search`"
msgstr ""

BIN
docs/client_handbook/po/de/LC_MESSAGES/sysadmclient.mo Normal file
View File

Binary file not shown.

1923
docs/client_handbook/po/de/LC_MESSAGES/sysadmclient.po Normal file
View File

File diff suppressed because it is too large Load Diff

BIN
docs/client_handbook/po/es/LC_MESSAGES/index.mo Normal file
View File

Binary file not shown.

36
docs/client_handbook/po/es/LC_MESSAGES/index.po Normal file
View File

@@ -0,0 +1,36 @@
#
msgid ""
msgstr ""
"Project-Id-Version: SysAdm™ Client Handbook 1.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2016-09-16 13:42-0400\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
#: ../../index.rst:11
msgid "Welcome to SysAdm™ Client Handbook's documentation!"
msgstr ""
#: ../../index.rst:13
msgid "Contents:"
msgstr ""
#: ../../index.rst:21
msgid "Indices and tables"
msgstr ""
#: ../../index.rst:23
msgid ":ref:`genindex`"
msgstr ""
#: ../../index.rst:24
msgid ":ref:`modindex`"
msgstr ""
#: ../../index.rst:25
msgid ":ref:`search`"
msgstr ""

BIN
docs/client_handbook/po/es/LC_MESSAGES/sysadmclient.mo Normal file
View File

Binary file not shown.

1923
docs/client_handbook/po/es/LC_MESSAGES/sysadmclient.po Normal file
View File

File diff suppressed because it is too large Load Diff

BIN
docs/client_handbook/po/fr/LC_MESSAGES/index.mo Normal file
View File

Binary file not shown.

36
docs/client_handbook/po/fr/LC_MESSAGES/index.po Normal file
View File

@@ -0,0 +1,36 @@
#
msgid ""
msgstr ""
"Project-Id-Version: SysAdm™ Client Handbook 1.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2016-09-16 13:42-0400\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
#: ../../index.rst:11
msgid "Welcome to SysAdm™ Client Handbook's documentation!"
msgstr ""
#: ../../index.rst:13
msgid "Contents:"
msgstr ""
#: ../../index.rst:21
msgid "Indices and tables"
msgstr ""
#: ../../index.rst:23
msgid ":ref:`genindex`"
msgstr ""
#: ../../index.rst:24
msgid ":ref:`modindex`"
msgstr ""
#: ../../index.rst:25
msgid ":ref:`search`"
msgstr ""

BIN
docs/client_handbook/po/fr/LC_MESSAGES/sysadmclient.mo Normal file
View File

Binary file not shown.

1923
docs/client_handbook/po/fr/LC_MESSAGES/sysadmclient.po Normal file
View File

File diff suppressed because it is too large Load Diff

BIN
docs/client_handbook/po/id/LC_MESSAGES/index.mo Normal file
View File

Binary file not shown.

36
docs/client_handbook/po/id/LC_MESSAGES/index.po Normal file
View File

@@ -0,0 +1,36 @@
#
msgid ""
msgstr ""
"Project-Id-Version: SysAdm™ Client Handbook 1.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2016-09-16 13:42-0400\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
#: ../../index.rst:11
msgid "Welcome to SysAdm™ Client Handbook's documentation!"
msgstr ""
#: ../../index.rst:13
msgid "Contents:"
msgstr ""
#: ../../index.rst:21
msgid "Indices and tables"
msgstr ""
#: ../../index.rst:23
msgid ":ref:`genindex`"
msgstr ""
#: ../../index.rst:24
msgid ":ref:`modindex`"
msgstr ""
#: ../../index.rst:25
msgid ":ref:`search`"
msgstr ""

BIN
docs/client_handbook/po/id/LC_MESSAGES/sysadmclient.mo Normal file
View File

Binary file not shown.

1923
docs/client_handbook/po/id/LC_MESSAGES/sysadmclient.po Normal file
View File

File diff suppressed because it is too large Load Diff

BIN
docs/client_handbook/po/it/LC_MESSAGES/index.mo Normal file
View File

Binary file not shown.

36
docs/client_handbook/po/it/LC_MESSAGES/index.po Normal file
View File

@@ -0,0 +1,36 @@
#
msgid ""
msgstr ""
"Project-Id-Version: SysAdm™ Client Handbook 1.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2016-09-16 13:42-0400\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
#: ../../index.rst:11
msgid "Welcome to SysAdm™ Client Handbook's documentation!"
msgstr ""
#: ../../index.rst:13
msgid "Contents:"
msgstr ""
#: ../../index.rst:21
msgid "Indices and tables"
msgstr ""
#: ../../index.rst:23
msgid ":ref:`genindex`"
msgstr ""
#: ../../index.rst:24
msgid ":ref:`modindex`"
msgstr ""
#: ../../index.rst:25
msgid ":ref:`search`"
msgstr ""

BIN
docs/client_handbook/po/it/LC_MESSAGES/sysadmclient.mo Normal file
View File

Binary file not shown.

1923
docs/client_handbook/po/it/LC_MESSAGES/sysadmclient.po Normal file
View File

File diff suppressed because it is too large Load Diff

BIN
docs/client_handbook/po/pt_BR/LC_MESSAGES/index.mo Normal file
View File

Binary file not shown.

36
docs/client_handbook/po/pt_BR/LC_MESSAGES/index.po Normal file
View File

@@ -0,0 +1,36 @@
#
msgid ""
msgstr ""
"Project-Id-Version: SysAdm™ Client Handbook 1.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2016-09-16 13:42-0400\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
#: ../../index.rst:11
msgid "Welcome to SysAdm™ Client Handbook's documentation!"
msgstr ""
#: ../../index.rst:13
msgid "Contents:"
msgstr ""
#: ../../index.rst:21
msgid "Indices and tables"
msgstr ""
#: ../../index.rst:23
msgid ":ref:`genindex`"
msgstr ""
#: ../../index.rst:24
msgid ":ref:`modindex`"
msgstr ""
#: ../../index.rst:25
msgid ":ref:`search`"
msgstr ""

BIN
docs/client_handbook/po/pt_BR/LC_MESSAGES/sysadmclient.mo Normal file
View File

Binary file not shown.

1923
docs/client_handbook/po/pt_BR/LC_MESSAGES/sysadmclient.po Normal file
View File

File diff suppressed because it is too large Load Diff

BIN
docs/client_handbook/po/tr/LC_MESSAGES/index.mo Normal file
View File

Binary file not shown.

36
docs/client_handbook/po/tr/LC_MESSAGES/index.po Normal file
View File

@@ -0,0 +1,36 @@
#
msgid ""
msgstr ""
"Project-Id-Version: SysAdm™ Client Handbook 1.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2016-09-16 13:42-0400\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
#: ../../index.rst:11
msgid "Welcome to SysAdm™ Client Handbook's documentation!"
msgstr ""
#: ../../index.rst:13
msgid "Contents:"
msgstr ""
#: ../../index.rst:21
msgid "Indices and tables"
msgstr ""
#: ../../index.rst:23
msgid ":ref:`genindex`"
msgstr ""
#: ../../index.rst:24
msgid ":ref:`modindex`"
msgstr ""
#: ../../index.rst:25
msgid ":ref:`search`"
msgstr ""

BIN
docs/client_handbook/po/tr/LC_MESSAGES/sysadmclient.mo Normal file
View File

Binary file not shown.

1923
docs/client_handbook/po/tr/LC_MESSAGES/sysadmclient.po Normal file
View File

File diff suppressed because it is too large Load Diff

BIN
docs/client_handbook/po/uk/LC_MESSAGES/index.mo Normal file
View File

Binary file not shown.

36
docs/client_handbook/po/uk/LC_MESSAGES/index.po Normal file
View File

@@ -0,0 +1,36 @@
#
msgid ""
msgstr ""
"Project-Id-Version: SysAdm™ Client Handbook 1.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2016-09-16 13:42-0400\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
#: ../../index.rst:11
msgid "Welcome to SysAdm™ Client Handbook's documentation!"
msgstr ""
#: ../../index.rst:13
msgid "Contents:"
msgstr ""
#: ../../index.rst:21
msgid "Indices and tables"
msgstr ""
#: ../../index.rst:23
msgid ":ref:`genindex`"
msgstr ""
#: ../../index.rst:24
msgid ":ref:`modindex`"
msgstr ""
#: ../../index.rst:25
msgid ":ref:`search`"
msgstr ""

BIN
docs/client_handbook/po/uk/LC_MESSAGES/sysadmclient.mo Normal file
View File

Binary file not shown.

1923
docs/client_handbook/po/uk/LC_MESSAGES/sysadmclient.po Normal file
View File

File diff suppressed because it is too large Load Diff

BIN
docs/client_handbook/po/zh_CN/LC_MESSAGES/index.mo Normal file
View File

Binary file not shown.

36
docs/client_handbook/po/zh_CN/LC_MESSAGES/index.po Normal file
View File

@@ -0,0 +1,36 @@
#
msgid ""
msgstr ""
"Project-Id-Version: SysAdm™ Client Handbook 1.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2016-09-16 13:42-0400\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
#: ../../index.rst:11
msgid "Welcome to SysAdm™ Client Handbook's documentation!"
msgstr ""
#: ../../index.rst:13
msgid "Contents:"
msgstr ""
#: ../../index.rst:21
msgid "Indices and tables"
msgstr ""
#: ../../index.rst:23
msgid ":ref:`genindex`"
msgstr ""
#: ../../index.rst:24
msgid ":ref:`modindex`"
msgstr ""
#: ../../index.rst:25
msgid ":ref:`search`"
msgstr ""

BIN
docs/client_handbook/po/zh_CN/LC_MESSAGES/sysadmclient.mo Normal file
View File

Binary file not shown.

1923
docs/client_handbook/po/zh_CN/LC_MESSAGES/sysadmclient.po Normal file
View File

File diff suppressed because it is too large Load Diff

BIN
docs/client_handbook/po/zh_HK/LC_MESSAGES/index.mo Normal file
View File

Binary file not shown.

36
docs/client_handbook/po/zh_HK/LC_MESSAGES/index.po Normal file
View File

@@ -0,0 +1,36 @@
#
msgid ""
msgstr ""
"Project-Id-Version: SysAdm™ Client Handbook 1.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2016-09-16 13:42-0400\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
#: ../../index.rst:11
msgid "Welcome to SysAdm™ Client Handbook's documentation!"
msgstr ""
#: ../../index.rst:13
msgid "Contents:"
msgstr ""
#: ../../index.rst:21
msgid "Indices and tables"
msgstr ""
#: ../../index.rst:23
msgid ":ref:`genindex`"
msgstr ""
#: ../../index.rst:24
msgid ":ref:`modindex`"
msgstr ""
#: ../../index.rst:25
msgid ":ref:`search`"
msgstr ""

BIN
docs/client_handbook/po/zh_HK/LC_MESSAGES/sysadmclient.mo Normal file
View File

Binary file not shown.

1923
docs/client_handbook/po/zh_HK/LC_MESSAGES/sysadmclient.po Normal file
View File

File diff suppressed because it is too large Load Diff

320
docs/client_handbook/sysadmclient.rst
View File

@@ -69,35 +69,37 @@ Finding Software
----------------
The "Browse" tab, shown in
:numref:`Figure %s: Browse Tab of AppCafe® <appcafe1>`, is used to find
:numref:`Figure %s <appcafe1>`, is used to find
available software.
.. _appcafe1:
.. figure:: images/appcafe1.png
Browse Tab of AppCafe®
This screen contains the following options:
**Back:** click this button to leave a category or search result and
**Back:** Click this button to leave a category or search result and
return to the previous screen.
**Repository drop-down menu:** use this drop-down menu to select the
**Repository drop-down menu:** Use this drop-down menu to select the
repository to search or browse. The selections include: "major"
(applications available for installation), "base" (applications that
are part of the base operating system), and "local" (all installed
applications).
**Search:** to see if an application is available, enter its name and
**Search:** To see if an application is available, enter its name and
click the "binoculars" icon. Alternately, enter a description. For
example, a search for "browser" will display software with "browser"
in the name as well as applications which provide browser
functionality, such as Firefox.
**Browse Categories:** this drop-down menu lists the available software
**Browse Categories:** This drop-down menu lists the available software
categories. If you select a category, it will only display or show
search results from that category.
**Popular Searches and Popular Categories:** the buttons in these
**Popular Searches and Popular Categories:** The buttons in these
sections can be used to quickly find applications which are recommended
by other |trueos| users. Click a button to get a curated list of
applications that match the button's description.
@@ -110,7 +112,7 @@ down arrow icon which can be clicked to install that application.
Click the name of an application to view more information about that
application. In the example shown in
:numref:`Figure %s: Viewing the Details of an Installed Application <appcafe2>`,
:numref:`Figure %s <appcafe2>`,
the user has clicked :guilabel:`Firefox` on a system that has Firefox
installed.
@@ -126,6 +128,8 @@ installed.
.. figure:: images/appcafe2.png
AppCafe®: Viewing the Details of an Installed Application
As seen in this example, the information for an application includes
the application's icon, name, and description. Click the application's
name to open the website for the application in the default web
@@ -138,12 +142,14 @@ second (bottom) pane displays the message that appears when the
package is installed.
An example of the "?" tab is shown in
:numref:`Figure %s: More Application Details <appcafe3>`
:numref:`Figure %s <appcafe3>`
.. _appcafe3:
.. figure:: images/appcafe3.png
AppCafe®: More Application Details
This tab displays a variety of information:
* Software version.
@@ -164,19 +170,23 @@ This tab displays a variety of information:
If the package includes screenshots of the application, you can click
the next tab, which has an image icon, to view and scroll through the
screenshots. An example is shown in
:numref:`Figure %s: Viewing the Application's Screenshots <appcafe4>`
:numref:`Figure %s <appcafe4>`
.. _appcafe4:
.. figure:: images/appcafe4.png
AppCafe®: Viewing the Application's Screenshots
An example of the last tab, which has a list icon, is shown in
:numref:`Figure %s: Viewing the Details of an Installed Application <appcafe5>`.
:numref:`Figure %s <appcafe5>`.
.. _appcafe5:
.. figure:: images/appcafe5.png
AppCafe®: Viewing the Details of an Installed Application
This tab contains the following information. Click the right arrow next
to an entry to expand its information and the down arrow to collapse
the information.
@@ -198,12 +208,14 @@ Managing Installed Software
To view and manage the applications which are installed on the system,
click the :guilabel:`Installed` tab. An example is seen in
:numref:`Figure %s: Installed Tab of AppCafe® <appcafe6>`.
:numref:`Figure %s <appcafe6>`.
.. _appcafe6:
.. figure:: images/appcafe6.png
AppCafe®: Installed Tab
This screen offers several actions:
* **All:** check this box to select all installed applications or
@@ -245,7 +257,7 @@ allows you to select or deselect a number of options:
automatically uninstall.
In the example shown in
:numref:`Figure %s: Viewing Applications With All Options Checked <appcafe7>`,
:numref:`Figure %s <appcafe7>`,
the user has checked all available options. In this example,
:guilabel:`aalib` has dependencies (banner icon), :guilabel:`alsa-lib`
has been locked, and :guilabel:`alsa-plugins` is an orphan (flag icon).
@@ -253,10 +265,12 @@ has been locked, and :guilabel:`alsa-plugins` is an orphan (flag icon).
.. _appcafe7:
.. figure:: images/appcafe7.png
AppCafe®: Viewing Applications With All Options Checked
If you install or uninstall any software, click the :guilabel:`Pending`
tab to view the details of the operation. In the example shown in
:numref:`Figure %s: Viewing the Status of the Operation <appcafe8>`,
:numref:`Figure %s <appcafe8>`,
this system has had a package install and a package locking operation,
and each has a dated entry in the process log. Highlight an entry and
check the :guilabel:`View Process Log` box to review the log for the
@@ -266,6 +280,8 @@ operation.
.. figure:: images/appcafe8.png
AppCafe®: Viewing the Status of the Operation
.. index:: updates
.. _Update Manager:
@@ -326,12 +342,14 @@ Managing Updates
----------------
An example of the :guilabel:`Updates` tab is shown in
:numref:`Figure %s: Managing Updates <update1>`.
:numref:`Figure %s <update1>`.
.. _update1:
.. figure:: images/update1.png
Managing Updates
In this example, updates are available for installed packages. If a
security update is available, it will be listed as such. Apply the
available updates by clicking the box next to each entry you want to
@@ -357,23 +375,26 @@ system last checked for updates. To manually check for updates, click
The :guilabel:`Branches` tab of Update Manager provides a listing of
available branches. In the example shown in
:numref:`Figure %s: Switching Branches <update3>`, this system is
currently running the 10.2 branch and the upcoming 11.0 branch is
available for selection.
:numref:`Figure %s <update3>`, this system is currently running the 10.2
branch and the upcoming 11.0 branch is available for selection.
.. TODO update3.png needs to be added to images file.
.. _update3:
.. figure:: images/update3.png
.. figure:: images/update3.png
Switching Branches
The :guilabel:`Settings` tab is shown in
:numref:`Figure %s: Settings Tab <update4>`.
:numref:`Figure %s <update4>`.
.. _update4:
.. figure:: images/update4.png
Settings Tab
This tab contains several configurable options:
* **Max Boot Environments:** |trueos| automatically creates a boot
@@ -426,13 +447,14 @@ To perform the installation to a new boot environment, start the
`TrueOS® Handbook <https://www.trueos.org/handbook/trueos.html>`_. In
the `System Selection Screen <https://www.trueos.org/handbook/install.html#system-selection-screen>`_,
choose to install either a desktop or a server. Press :guilabel:`Next`
to view the pop-up screen shown in
:numref:`Figure %s: Install to Boot Environment <upgrade1>`.
to view the pop-up screen shown in :numref:`Figure %s <upgrade1>`.
.. _upgrade1:
.. figure:: images/upgrade1.png
Install to Boot Environment
To upgrade, select the existing pool to install into and press
:guilabel:`OK`.
@@ -443,12 +465,14 @@ To upgrade, select the existing pool to install into and press
If you press :guilabel:`OK` to proceed with an installation into a new
boot environment, the installer will skip the "Disk Selection" screen
and instead show a summary, seen in
:numref:`Figure %s: Start the Install to Boot Environment <upgrade2>`.
:numref:`Figure %s <upgrade2>`.
.. _upgrade2:
.. figure:: images/upgrade2.png
Start the Install to Boot Environment
Press :guilabel:`Next` to start the installation. Once the installation
is complete, reboot the system and remove the installation media. The
post-installation screens will run as described in the
@@ -517,14 +541,15 @@ which boot environment is selected at system boot.
To view, manage, and create boot environments using the |sysadm|
graphical client, go to
:menuselection:`System Management --> Boot Environment Manager`. In the
example shown in :numref:`Figure %s: Managing Boot Environments <be1>`,
there is an entry named *initial* that represents the original |trueos|
installation.
example shown in :numref:`Figure %s <be1>`, there is an entry named
*initial* that represents the original |trueos| installation.
.. _be1:
.. figure:: images/be1.png
Managing Boot Environments
Each entry contains the same information:
* **Name:** The name of the boot entry as it will appear in the boot
@@ -579,23 +604,79 @@ column to *R*.
.. figure:: images/install1b.png
TrueOS® Boot Menu
To boot into another boot environment, press :kbd:`7` at the
:numref:`Figure %s: TrueOS® Boot Menu <install1b>` to access the boot
menu selection screen. In the example shown in
:numref:`Figure %s: Boot Environments Menu <be2>`, two boot environments
are available in the "Boot Environments" section: the entry named
"initial" represents the initial installation and the entry named
"mybootenvironment" was manually created using Boot Environment Manager.
The upper section of this menu indicates the "initial" boot environment
is set to active, or the one the system has been configured to boot into
unless another BE is manually selected in this menu. Use the arrow keys
to highlight the boot environment you would like to boot into, and press
:kbd:`Enter` to continue booting into the selected boot environment.
:numref:`Figure %s <be2>`, two boot environments are available in the
"Boot Environments" section: the entry named "initial" represents the
initial installation and the entry named "mybootenvironment" was
manually created using Boot Environment Manager. The upper section of
this menu indicates the "initial" boot environment is set to active, or
the one the system has been configured to boot into unless another BE is
manually selected in this menu. Use the arrow keys to highlight the boot
environment you would like to boot into, and press :kbd:`Enter` to
continue booting into the selected boot environment.
.. _be2:
.. figure:: images/be2.png
Boot Environments Menu
.. index:: sysadm, configuration
.. _Firewall Manager:
Firewall Manager
================
This section to be filled in when the firewall manager is operational.
.. index:: sysadm, configuration
.. _Server Manager:
Service Manager
===============
The Service Manager offers a view of all the system's installed
services, as seen in :numref:`Figure %s <service1>`. There are also
several options to configure these services.
.. _service1:
.. figure:: images/service1.png
SysAdm™ Service Manager
Services are listed in a chart with four columns:
* **Name:** The name of the service. All services are listed
alphabetically by name.
* **Running:** Indicates if the service is active. "True" means the
service is running, "false" means it is not.
* **Start on Boot:** Shows with "true" or "false" if the service will be
automatically activated when the system is initialized.
* **Description:** If available, displays text describing the server.
Underneath the chart is a row with multiple buttons:
* **Play Icon:** Starts the selected service.
* **Pause Icon:** Stops the selected service.
* **Reload Icon:** Restarts the selected service.
* **Power On Icon:** Enables the service to automatically start on boot.
* **Power Off Icon:** Disables the service from starting on boot.
Hovering over any of these icons will display a helpful description
across the bottom of the window.
.. index:: sysadm, configuration
.. _Task Manager:
@@ -604,13 +685,15 @@ Task Manager
Task Manager provides a graphical view of memory use, per-CPU use and
a listing of currently running applications. An example is shown in
:numref:`Figure %s: Task Manager <task1>`.
:numref:`Figure %s <task1>`.
.. _task1:
.. figure:: images/task1.png
The "Running Programs: section provides a graphical front-end to
SysAdm™ Task Manager
The "Running Programs:" section provides a graphical front-end to
`top(1) <https://www.freebsd.org/cgi/man.cgi?query=top>`_.
The :guilabel:`Kill Selected Process` button can be used to terminate
@@ -626,15 +709,16 @@ The |trueos| User Manager utility allows you to easily add, configure,
and delete users and groups. To access this utility in |sysadm|, click
:menuselection:`System Management --> User Manager`.
In the example shown in
:numref:`Figure %s: Viewing User Accounts in User Manager <user1>`,
the system has one user account that was created in the "Create a User
Screen" during installation.
In the example shown in :numref:`Figure %s <user1>`, the system has one
user account that was created in the "Create a User" screen during
installation.
.. _user1:
.. figure:: images/user1.png
Viewing User Accounts in User Manager
The :guilabel:`Standard` view allows you to configure the following:
* **User Name:** The name the user will use when they log in to the
@@ -662,13 +746,15 @@ The :guilabel:`Standard` view allows you to configure the following:
If you make any changes to a user's "Details", click the
:guilabel:`Save` button to save them.
:numref:`Figure %s: Creating a New User Account <user2>` demonstrates
how this screen changes when you click the :guilabel:`New User` button.
:numref:`Figure %s <user2>` demonstrates how this screen changes when
clicking :guilabel:`New User`.
.. _user2:
.. figure:: images/user2.png
Creating a New User Account
Fields outlined in red are required when creating a user. The
:guilabel:`User Name`, :guilabel:`Full Name`, and :guilabel:`Password`
fields are the same as described in the :guilabel:`Details` tab. There
@@ -712,15 +798,16 @@ highlight the user that started |sysadm|. It will also be greyed out if
there is only one user account, as you need at least one user to login
to the |trueos| system.
If you click :guilabel:`Advanced View`, this screen will change to show
all of the accounts on the system, not just the user accounts you
created. An example is seen in
:numref:`Figure %s: Viewing All Accounts and Their Details <user3>`.
Click :guilabel:`Advanced View` to show all of the accounts on the
system, not just the user accounts you created. An example is seen in
:numref:`Figure %s <user3>`.
.. _user3:
.. figure:: images/user3.png
Viewing All Accounts and Their Details
The accounts you did not create are known as system accounts and are
needed by the operating system or installed applications. Do **not**
delete any accounts you did not create yourself as doing so may cause a
@@ -766,9 +853,8 @@ worthless without the system it was paired with.
The :guilabel:`PersonaCrypt` tab can be used to initialize a
PersonaCrypt device for any login user, **except** for the currently
logged in user. In the example shown in
:numref:`Figure %s: Initialize PersonaCrypt Device <user5>`, a new user,
named *dlavigne*, has been created and the entry for the user has been
clicked.
:numref:`Figure %s <user5>`, a new user, named *dlavigne*, has been
created and the entry for the user has been clicked.
.. TODO Add user5.png to images folder.
@@ -776,6 +862,8 @@ clicked.
.. figure:: images/user5.png
Initialize PersonaCrypt Device
Before a user is configured to use PersonaCrypt on a |trueos| system,
two buttons are available in the "PersonaCrypt" section of "Advanced
Mode". Note this section is hidden if the currently logged in user is
@@ -809,7 +897,7 @@ will ask if you are ready. Click :guilabel:`Yes` to initialize the
device. The User Manager screen will be greyed out while the device is
prepared. Once the initialization is complete, the User Manager screen
will change to display the device's key options, as seen in
:numref:`Figure %s: PersonaCrypt Key Options <user6>`.
:numref:`Figure %s <user6>`.
.. TODO Add user6.png to images folder.
@@ -817,6 +905,8 @@ will change to display the device's key options, as seen in
.. figure:: images/user6.png
PersonaCrypt Key Options
Several options are now available:
* **Export Key:** Used to create a copy of the encryption key so it can
@@ -857,13 +947,15 @@ Managing Groups
Click the :guilabel:`Groups` tab to view and manage the groups on the
system. The :guilabel:`Standard` tab, seen in
:numref:`Figure %s: Managing Groups Using User Manager <user4>`,
shows the group membership for the *operator* and *wheel* groups:
:numref:`Figure %s <user4>`, shows the group membership for the
*operator* and *wheel* groups:
.. _user4:
.. figure:: images/user4.png
Managing Groups Using User Manager
This screen has 2 columns:
**Members:** Indicates if the highlighted group contains any user
@@ -938,14 +1030,15 @@ Life Preserver.
Snapshots Tab
-------------
:numref:`Figure %s: Snapshot Tab <lpreserver1>` shows the
:guilabel:`Snapshots` tab on a system not yet configured. This system
has a "ZFS Pool" named "tank".
:numref:`Figure %s <lpreserver1>` shows the :guilabel:`Snapshots` tab on
a system not yet configured. This system has a "ZFS Pool" named "tank".
.. _lpreserver1:
.. figure:: images/lpreserver1.png
Snapshot Tab
This screen will display any created snapshots and provides buttons to:
**Create:** Used to create a manual snapshot of the specified pool
@@ -1005,7 +1098,7 @@ the snapshots must first meet several requirements:
the |trueos| system and the backup system, make sure it has a rule to
allow SSH.
:numref:`Figure %s: Replication Tab <lpreserver2>` shows the initial
:numref:`Figure %s <lpreserver2>` shows the initial
:guilabel:`Replication` tab on a system that has not yet been configured
for replication. This screen is used to create, view, remove, and
configure the replication schedule.
@@ -1014,14 +1107,18 @@ configure the replication schedule.
.. figure:: images/lpreserver2.png
Replication Tab
To schedule the replication, click :guilabel:`+` to display the
"Setup Replication" screen shown in
:numref:`Figure %s: Scheduling a Replication <lpreserver3>`.
:numref:`Figure %s <lpreserver3>`.
.. _lpreserver3:
.. figure:: images/lpreserver3.png
Scheduling a Replication
Input the following information:
* **Host IP:** The IP address of the remote system to store the
@@ -1088,13 +1185,14 @@ pools.
To create a snapshot schedule, click the :guilabel:`camera` icon in the
lower left corner of this tab. This will activate the "Setup Snapshot
Schedule" pane as seen in
:numref:`Figure %s: Scheduling a Snapshot <lpreserver4>`.
Schedule" pane as seen in :numref:`Figure %s <lpreserver4>`.
.. _lpreserver4:
.. figure:: images/lpreserver4.png
Scheduling a Snapshot
This pane contains several options:
**ZPool:** Select the ZFS pool to snapshot.
@@ -1124,18 +1222,20 @@ have multiple pools, create a scrub schedule for each pool.
To schedule when the scrub occurs, click the third icon from the right
which will activate the "Setup Scrub Schedule" screen shown in
:numref:`Figure %s: Scheduling a Scrub <lpreserver5>`.
:numref:`Figure %s <lpreserver5>`.
.. _lpreserver5:
.. figure:: images/lpreserver5.png
Select the pool from the "ZPool" drop-down menu, then select the
"Frequency". Supported frequencies are "Daily", "Weekly", or
"Monthly". If you select "Daily", you can configure the "Hour". If you
select "Weekly", you can configure the "Day of week" and the "Hour". If
you select "Monthly", you can configure the "Date" and "Hour". Since a
scrub can be disk I/O intensive, it is recommended to pick a time when
Scheduling a Scrub
Select the pool from the :guilabel:`ZPool` drop-down menu, then select
the :guilabel:`Frequency`. Supported frequencies are "Daily", "Weekly",
or "Monthly". If you select "Daily", you can configure the "Hour". If
you select "Weekly", you can configure the "Day of week" and the "Hour".
If you select "Monthly", you can configure the "Date" and "Hour". Since
a scrub can be disk I/O intensive, it is recommended to pick a time when
the system will not be in heavy use.
Once you have created a scrub schedule, you can use the "gear" icon
@@ -1149,12 +1249,14 @@ Settings Tab
-------------
The :guilabel:`Settings` tab is shown in
:numref:`Figure %s: Life Preserver Settings <lpreserver6>`.
:numref:`Figure %s <lpreserver6>`.
.. _lpreserver6:
.. figure:: images/lpreserver6.png
Life Preserver Settings
Many settings are configurable:
**Disk Usage Warning:** Enter a number up to 99 to indicate at which
@@ -1260,41 +1362,43 @@ the :command:`lpreserver cronsnap` command, type:
listexclude <dataset>
List which datasets are excluded from schedule snapshots.
Table 10.10a shows the command line equivalents to the graphical
options provided by the Life Preserver GUI.
:numref:`Table %s <table_1>` shows the command line equivalents to the
graphical options provided by the Life Preserver GUI.
**Table 10.10a: Command Line and GUI Equivalents**
.. _table_1:
+------------------+-------------------+------------------------------------+
| **Command Line** | **GUI** | **Description** |
+==================+===================+====================================+
| **cronsnap** | "Snapshots" tab | schedule when snapshots occur |
| | | and how long to keep them; the |
| | | **stop** option can be used to |
| | | disable snapshot creation |
+------------------+-------------------+------------------------------------+
| **cronscrub** | "Schedules" tab | schedule a ZFS scrub |
+------------------+-------------------+------------------------------------+
| **get** | "Settings" tab | list Life Preserver options |
+------------------+-------------------+------------------------------------+
| **replicate** | "Replication" tab | used to list, add, and remove |
| | | backup server; read the **help** |
| | | for this command for examples |
| | | |
+------------------+-------------------+------------------------------------+
| **set** | "Settings" tab | configures Life Preserver options; |
| | | read **help** for the list of |
| | | configurable options |
+------------------+-------------------+------------------------------------+
| **snapshot** | "Snapshots" tab | create and replicate a new ZFS |
| | | snapshot; by default, snapshots |
| | | are recursive, meaning that a |
| | | that a snapshot is taken of every |
| | | dataset within a pool |
+------------------+-------------------+------------------------------------+
| **status** | | lists the last snapshot name and |
| | | replication status |
+------------------+-------------------+------------------------------------+
.. table:: Command Line and GUI Equivalents
+------------------+-------------------+------------------------------------+
| **Command Line** | **GUI** | **Description** |
+==================+===================+====================================+
| **cronsnap** | "Snapshots" tab | schedule when snapshots occur |
| | | and how long to keep them; the |
| | | **stop** option can be used to |
| | | disable snapshot creation |
+------------------+-------------------+------------------------------------+
| **cronscrub** | "Schedules" tab | schedule a ZFS scrub |
+------------------+-------------------+------------------------------------+
| **get** | "Settings" tab | list Life Preserver options |
+------------------+-------------------+------------------------------------+
| **replicate** | "Replication" tab | used to list, add, and remove |
| | | backup server; read the **help** |
| | | for this command for examples |
| | | |
+------------------+-------------------+------------------------------------+
| **set** | "Settings" tab | configures Life Preserver options; |
| | | read **help** for the list of |
| | | configurable options |
+------------------+-------------------+------------------------------------+
| **snapshot** | "Snapshots" tab | create and replicate a new ZFS |
| | | snapshot; by default, snapshots |
| | | are recursive, meaning that a |
| | | that a snapshot is taken of every |
| | | dataset within a pool |
+------------------+-------------------+------------------------------------+
| **status** | | lists the last snapshot name and |
| | | replication status |
+------------------+-------------------+------------------------------------+
.. _Restoring the Operating System:
@@ -1305,12 +1409,14 @@ If you have replicated the system's snapshots to a remote backup
server, you can use a |trueos| installation media to perform an
operating system restore or to clone another system. Start the
installation as usual until you get to the screen shown in
:numref:`Figure %s: Selecting to Restore/Clone From Backup <restore1>`.
:numref:`Figure %s <restore1>`.
.. _restore1:
.. figure:: images/restore1.png
Selecting to Restore/Clone From Backup
Before you can perform a restore, the network interface must be
configured. Click :guilabel:`Network Connectivity` (second icon from the
left) in order to determine if the network connection was automatically
@@ -1322,7 +1428,7 @@ working before continuing.
Once you are ready, click :guilabel:`Restore from Life-Preserver backup`
and :guilabel:`Next`. This will start the Restore Wizard. In the screen
shown in
:numref:`Figure %s: Input the Information for a SSH Restore <restore2>`,
:numref:`Figure %s <restore2>`,
input the IP address of the backup server and the name of the user
account used to replicate the snapshots. If the server is listening on
a non-standard SSH port, change the "SSH port" number.
@@ -1331,14 +1437,16 @@ a non-standard SSH port, change the "SSH port" number.
.. figure:: images/restore2.png
Input the Information for a SSH Restore
Click :guilabel:`Next` and the wizard will provide a summary of your
selections. If correct, click :guilabel:`Finish`; otherwise, click
:guilabel:`Back` to correct them.
Once the connection to the backup server succeeds, you will be able to
select which host to restore. In the example shown in
:numref:`Figure %s: Select the Host to Restore <restore4>`,
only one host has been backed up to the replication server.
:numref:`Figure %s <restore4>`, only one host has been backed up to the
replication server.
.. TODO Add restore4.png to images folder.
@@ -1346,6 +1454,8 @@ only one host has been backed up to the replication server.
.. figure:: images/restore4.png
Select the Host to Restore
After making your selection, click :guilabel:`Next`. The restore wizard
will provide a summary of which host it will restore from, the name of
the user account associated with the replication, and the hostname of

70
docs/server_handbook/Makefile
View File

@@ -4,13 +4,15 @@
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXINTL = sphinx-intl
PAPER =
BUILDDIR = _build
# User-friendly check for sphinx-build
#ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
#$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
#endif
SPHINXBUILDCHECK= := $(shell which $(SPHINXBUILD) 2>/dev/null)
.ifndef SPHINXBUILDCHECK
.error "The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don\'t have Sphinx installed, grab it from http://sphinx-doc.org/)"
.endif
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
@@ -19,7 +21,7 @@ ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
help:
@echo "Please use \`make <target>' where <target> is one of"
@@ -30,7 +32,6 @@ help:
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " applehelp to make an Apple Help Book"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@@ -46,13 +47,49 @@ help:
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
@echo " coverage to run coverage check of the documentation (if enabled)"
@echo " i18n to fetch and prep the i18n files"
i18n:
$(MAKE) gettext
$(SPHINXINTL) -p $(BUILDDIR)/locale -d ./po update \
-l ar \
-l bg \
-l da \
-l de \
-l es \
-l fr \
-l id \
-l it \
-l pt_BR \
-l tr \
-l uk \
-l zh_CN \
-l zh_HK
$(SPHINXINTL) -d ./po build
clean:
rm -rf $(BUILDDIR)/*
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
.if exists(po)
.if exists($(BUILDDIR)/locale-po)
@rm -rf $(BUILDDIR)/locale-po
.endif
@cp -r ./po $(BUILDDIR)/locale-po
$(SPHINXBUILD) -D language='bg' -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html-bg
$(SPHINXBUILD) -D language='da' -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html-da
$(SPHINXBUILD) -D language='de' -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html-de
$(SPHINXBUILD) -D language='es' -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html-es
$(SPHINXBUILD) -D language='fr' -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html-fr
$(SPHINXBUILD) -D language='id' -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html-id
$(SPHINXBUILD) -D language='it' -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html-it
$(SPHINXBUILD) -D language='pt_BR' -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html-pt_BR
$(SPHINXBUILD) -D language='tr' -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html-tr
$(SPHINXBUILD) -D language='uk' -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html-uk
$(SPHINXBUILD) -D language='zh_CN' -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html-zh_CN
$(SPHINXBUILD) -D language='zh_HK' -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html-zh_HK
.endif
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
@@ -87,25 +124,17 @@ qthelp:
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/SystemsAdministratorUtilityUserGuide.qhcp"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/PC-BSDUserGuide.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/SystemsAdministratorUtilityUserGuide.qhc"
applehelp:
$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
@echo
@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
@echo "N.B. You won't be able to view it unless you put it in" \
"~/Library/Documentation/Help or install it in your application" \
"bundle."
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/PC-BSDUserGuide.qhc"
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/SystemsAdministratorUtilityUserGuide"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/SystemsAdministratorUtilityUserGuide"
@echo "# mkdir -p $$HOME/.local/share/devhelp/PC-BSDUserGuide"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/PC-BSDUserGuide"
@echo "# devhelp"
epub:
@@ -176,11 +205,6 @@ doctest:
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
coverage:
$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
@echo "Testing of coverage in the sources finished, look at the " \
"results in $(BUILDDIR)/coverage/python.txt."
xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo

BIN
docs/server_handbook/po/ar/LC_MESSAGES/basics.mo Normal file
View File

Binary file not shown.

192
docs/server_handbook/po/ar/LC_MESSAGES/basics.po Normal file
View File

@@ -0,0 +1,192 @@
#
msgid ""
msgstr ""
"Project-Id-Version: SysAdm™ Server Handbook 1.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2016-09-16 13:41-0400\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
#: ../../basics.rst:13
msgid "Getting Started"
msgstr ""
#: ../../basics.rst:15
msgid ""
"Beginning with SysAdm™ is a relatively simple process. SysAdm™ files are "
"currently available from the `github repository "
"<https://github.com/trueos/sysadm>`_"
msgstr ""
#: ../../basics.rst:22
msgid "Building SysAdm™"
msgstr ""
#: ../../basics.rst:24
msgid "Several Qt Modules are required before attempting to build SysAdm™:"
msgstr ""
#: ../../basics.rst:33
msgid ""
"Building the prototype version of SysAdm™ assumes you have access to "
"github.com."
msgstr ""
#: ../../basics.rst:46
msgid "Starting SysAdm™"
msgstr ""
#: ../../basics.rst:48
msgid ""
"SysAdm™ can be started one of two ways: the traditional rc(8) mechanism or "
"using the new jobd(8) mechanism"
msgstr ""
#: ../../basics.rst:51
msgid "To run under rc(8)"
msgstr ""
#: ../../basics.rst:63
msgid "To run under jobd(8)"
msgstr ""
#: ../../basics.rst:73
msgid ""
"Several ports on the system firewall will need to be opened for SysAdm™ to "
"have remote access functionality:"
msgstr ""
#: ../../basics.rst:76
msgid "Port 12149 for WebSocket interaction."
msgstr ""
#: ../../basics.rst:77
msgid "Port 12150 for the REST interface."
msgstr ""
#: ../../basics.rst:78
msgid "Port 12151 for the SysAdm™ bridge server."
msgstr ""
#: ../../basics.rst:80
msgid "The user can also designate their own ports for SysAdm™."
msgstr ""
#: ../../basics.rst:85
msgid "Bridge Initialization"
msgstr ""
#: ../../basics.rst:87
msgid ""
"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."
msgstr ""
#: ../../basics.rst:94
msgid ""
"A list of current commands is available by typing :command:`-h` after the "
"utility name (Example: :command:`sysadm-bridge -h`)."
msgstr ""
#: ../../basics.rst:100
msgid "Server and Bridge Initialization"
msgstr ""
#: ../../basics.rst:102
msgid ""
"To initialize the server and bridge, begin with the server. Run "
":command:`sudo sysadm-binary bridge_export_key [optional absolute file "
"path]`. This will export the public SSL key the server uses to authenticate "
"with the bridge."
msgstr ""
#: ../../basics.rst:107
msgid ""
"For both server and client, give SSL key files an easy to remember name and "
"location to simplify the process of finding those files for import to the "
"bridge."
msgstr ""
#: ../../basics.rst:111
msgid ""
"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 <filename> <filepath>`, replacing <filename> and <filepath> "
"with the server key filename and location. Once the server key file is "
"successfully imported, start the bridge (if not already running)."
msgstr ""
#: ../../basics.rst:118
msgid ""
"The bridge can import SSL files regardless of its active state with no "
"negative effects."
msgstr ""
#: ../../basics.rst:121
msgid ""
"Back on the server, run :command:`sudo sysadm-binary bridge_add <nickname> "
"<URL>` 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."
msgstr ""
#: ../../basics.rst:134
msgid "Adding a Client to the Server/Bridge Connection"
msgstr ""
#: ../../basics.rst:136
msgid ""
"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."
msgstr ""
#: ../../basics.rst:140
msgid ""
"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 :guilabel:`Export Public "
"Key` for both the server and bridge keys. This will export both SSL keys in "
"file form, depositing them in either the :file:`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."
msgstr ""
#: ../../basics.rst:150
msgid ""
"Moving to the bridge, as the administrator (or root), run :command:`sysadm-"
"bridge import_ssl_file <nickname> <filepath>` 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."
msgstr ""
#: ../../basics.rst:156
msgid ""
"On the server, run :command:`sudo sysadm-binary import_ssl_key <username> "
"<filepath> [<email>]` to import the client -> server SSL key file. This "
"grants an individual with the specific SSL authorization the same "
"permissions as <user>."
msgstr ""
#: ../../basics.rst:160
msgid ""
"Back in the user client, open the connection manager and choose "
":guilabel:`Bridge Relay` as the connection option. Input the established "
"bridge's URL and click :guilabel:`Connect`. The bridge will now show up in "
"the menu tree with a different icon, and will have a sub-menu of connections"
" within it. Click on the bridged system to will open the standard UI, but "
"note the connection is still being relayed through the bridge."
msgstr ""

BIN
docs/server_handbook/po/ar/LC_MESSAGES/index.mo Normal file
View File

Binary file not shown.

36
docs/server_handbook/po/ar/LC_MESSAGES/index.po Normal file
View File

@@ -0,0 +1,36 @@
#
msgid ""
msgstr ""
"Project-Id-Version: SysAdm™ Server Handbook 1.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2016-09-16 13:41-0400\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
#: ../../index.rst:16
msgid "Welcome to the SysAdm Server Handbook!"
msgstr ""
#: ../../index.rst:18
msgid "Contents:"
msgstr ""
#: ../../index.rst:28
msgid "Indices and tables"
msgstr ""
#: ../../index.rst:30
msgid ":ref:`genindex`"
msgstr ""
#: ../../index.rst:31
msgid ":ref:`modindex`"
msgstr ""
#: ../../index.rst:32
msgid ":ref:`search`"
msgstr ""

BIN
docs/server_handbook/po/ar/LC_MESSAGES/introduction.mo Normal file
View File

Binary file not shown.

116
docs/server_handbook/po/ar/LC_MESSAGES/introduction.po Normal file
View File

@@ -0,0 +1,116 @@
#
msgid ""
msgstr ""
"Project-Id-Version: SysAdm™ Server Handbook 1.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2016-09-16 13:41-0400\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
#: ../../introduction.rst:13
msgid "Introduction"
msgstr ""
#: ../../introduction.rst:15
msgid "**Preface**"
msgstr ""
#: ../../introduction.rst:17
msgid "Written by users of the SysAdm™ management utility."
msgstr ""
#: ../../introduction.rst:19
msgid "Version |version|"
msgstr ""
#: ../../introduction.rst:21
msgid "Copyright © 2016 iXSystems®."
msgstr ""
#: ../../introduction.rst:23
msgid ""
"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`."
msgstr ""
#: ../../introduction.rst:28
msgid ""
"SysAdm™ is still under heavy development, and all information contained in "
"the documentation is subject to change."
msgstr ""
#: ../../introduction.rst:31
msgid "**What is SysAdm™?**"
msgstr ""
#: ../../introduction.rst:33
msgid ""
"SysAdm™ is a middleware utility designed to streamline system management "
"with options for both local and remote access."
msgstr ""
#: ../../introduction.rst:36
msgid ""
"By default, SysAdm™ does **not** allow for remote access. The user must "
"configure the system to allow this feature."
msgstr ""
#: ../../introduction.rst:39
msgid ""
"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\" the same language, "
"allowing for simple and effective system administration."
msgstr ""
#: ../../introduction.rst:47
msgid ""
"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."
msgstr ""
#: ../../introduction.rst:52
msgid ""
"In order to address security concerns, the bridge device is always "
"considered \"untrusted\" and several layers of encryption are added to all "
"traffic flowing through the bridge to ensure it can not be used to record or"
" alter critical information flow."
msgstr ""
#: ../../introduction.rst:57
msgid "**Would you like to know more?**"
msgstr ""
#: ../../introduction.rst:59
msgid ""
"Documentation for the SysAdm™ project is split amongst three handbooks:"
msgstr ""
#: ../../introduction.rst:61
msgid ""
"**API Reference Guide**: A library of all API calls and WebSocket requests "
"for SysAdm™. This reference is constantly updated as new API calls are "
"written. It can be found at https://api.sysadm.us/."
msgstr ""
#: ../../introduction.rst:65
msgid ""
"**Client Handbook**: A detailed guide to all client side functions of "
"SysAdm™."
msgstr ""
#: ../../introduction.rst:68
msgid ""
"**Server Handbook**: A basic guide to initializing SysAdm™ with a bridge and"
" server connection."
msgstr ""

BIN
docs/server_handbook/po/ar/LC_MESSAGES/manage.mo Normal file
View File

Binary file not shown.

39
docs/server_handbook/po/ar/LC_MESSAGES/manage.po Normal file
View File

@@ -0,0 +1,39 @@
#
msgid ""
msgstr ""
"Project-Id-Version: SysAdm™ Server Handbook 1.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2016-09-16 13:41-0400\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
#: ../../manage.rst:13
msgid "Managing SysAdm™"
msgstr ""
#: ../../manage.rst:15
msgid ""
"SysAdm™ comes with a standard configuration file located in "
":file:`/usr/local/etc/sysadm.conf.dist`."
msgstr ""
#: ../../manage.rst:18
msgid ""
"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™:"
msgstr ""
#: ../../manage.rst:32
msgid "This default configuration also has blacklist options:"
msgstr ""
#: ../../manage.rst:48
msgid ""
"Please note these default options are subject to change as the SysAdm™ "
"utility is developed."
msgstr ""

BIN
docs/server_handbook/po/bg/LC_MESSAGES/basics.mo Normal file
View File

Binary file not shown.

192
docs/server_handbook/po/bg/LC_MESSAGES/basics.po Normal file
View File

@@ -0,0 +1,192 @@
#
msgid ""
msgstr ""
"Project-Id-Version: SysAdm™ Server Handbook 1.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2016-09-16 13:41-0400\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
#: ../../basics.rst:13
msgid "Getting Started"
msgstr ""
#: ../../basics.rst:15
msgid ""
"Beginning with SysAdm™ is a relatively simple process. SysAdm™ files are "
"currently available from the `github repository "
"<https://github.com/trueos/sysadm>`_"
msgstr ""
#: ../../basics.rst:22
msgid "Building SysAdm™"
msgstr ""
#: ../../basics.rst:24
msgid "Several Qt Modules are required before attempting to build SysAdm™:"
msgstr ""
#: ../../basics.rst:33
msgid ""
"Building the prototype version of SysAdm™ assumes you have access to "
"github.com."
msgstr ""
#: ../../basics.rst:46
msgid "Starting SysAdm™"
msgstr ""
#: ../../basics.rst:48
msgid ""
"SysAdm™ can be started one of two ways: the traditional rc(8) mechanism or "
"using the new jobd(8) mechanism"
msgstr ""
#: ../../basics.rst:51
msgid "To run under rc(8)"
msgstr ""
#: ../../basics.rst:63
msgid "To run under jobd(8)"
msgstr ""
#: ../../basics.rst:73
msgid ""
"Several ports on the system firewall will need to be opened for SysAdm™ to "
"have remote access functionality:"
msgstr ""
#: ../../basics.rst:76
msgid "Port 12149 for WebSocket interaction."
msgstr ""
#: ../../basics.rst:77
msgid "Port 12150 for the REST interface."
msgstr ""
#: ../../basics.rst:78
msgid "Port 12151 for the SysAdm™ bridge server."
msgstr ""
#: ../../basics.rst:80
msgid "The user can also designate their own ports for SysAdm™."
msgstr ""
#: ../../basics.rst:85
msgid "Bridge Initialization"
msgstr ""
#: ../../basics.rst:87
msgid ""
"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."
msgstr ""
#: ../../basics.rst:94
msgid ""
"A list of current commands is available by typing :command:`-h` after the "
"utility name (Example: :command:`sysadm-bridge -h`)."
msgstr ""
#: ../../basics.rst:100
msgid "Server and Bridge Initialization"
msgstr ""
#: ../../basics.rst:102
msgid ""
"To initialize the server and bridge, begin with the server. Run "
":command:`sudo sysadm-binary bridge_export_key [optional absolute file "
"path]`. This will export the public SSL key the server uses to authenticate "
"with the bridge."
msgstr ""
#: ../../basics.rst:107
msgid ""
"For both server and client, give SSL key files an easy to remember name and "
"location to simplify the process of finding those files for import to the "
"bridge."
msgstr ""
#: ../../basics.rst:111
msgid ""
"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 <filename> <filepath>`, replacing <filename> and <filepath> "
"with the server key filename and location. Once the server key file is "
"successfully imported, start the bridge (if not already running)."
msgstr ""
#: ../../basics.rst:118
msgid ""
"The bridge can import SSL files regardless of its active state with no "
"negative effects."
msgstr ""
#: ../../basics.rst:121
msgid ""
"Back on the server, run :command:`sudo sysadm-binary bridge_add <nickname> "
"<URL>` 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."
msgstr ""
#: ../../basics.rst:134
msgid "Adding a Client to the Server/Bridge Connection"
msgstr ""
#: ../../basics.rst:136
msgid ""
"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."
msgstr ""
#: ../../basics.rst:140
msgid ""
"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 :guilabel:`Export Public "
"Key` for both the server and bridge keys. This will export both SSL keys in "
"file form, depositing them in either the :file:`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."
msgstr ""
#: ../../basics.rst:150
msgid ""
"Moving to the bridge, as the administrator (or root), run :command:`sysadm-"
"bridge import_ssl_file <nickname> <filepath>` 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."
msgstr ""
#: ../../basics.rst:156
msgid ""
"On the server, run :command:`sudo sysadm-binary import_ssl_key <username> "
"<filepath> [<email>]` to import the client -> server SSL key file. This "
"grants an individual with the specific SSL authorization the same "
"permissions as <user>."
msgstr ""
#: ../../basics.rst:160
msgid ""
"Back in the user client, open the connection manager and choose "
":guilabel:`Bridge Relay` as the connection option. Input the established "
"bridge's URL and click :guilabel:`Connect`. The bridge will now show up in "
"the menu tree with a different icon, and will have a sub-menu of connections"
" within it. Click on the bridged system to will open the standard UI, but "
"note the connection is still being relayed through the bridge."
msgstr ""

BIN
docs/server_handbook/po/bg/LC_MESSAGES/index.mo Normal file
View File

Binary file not shown.

36
docs/server_handbook/po/bg/LC_MESSAGES/index.po Normal file
View File

@@ -0,0 +1,36 @@
#
msgid ""
msgstr ""
"Project-Id-Version: SysAdm™ Server Handbook 1.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2016-09-16 13:41-0400\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
#: ../../index.rst:16
msgid "Welcome to the SysAdm Server Handbook!"
msgstr ""
#: ../../index.rst:18
msgid "Contents:"
msgstr ""
#: ../../index.rst:28
msgid "Indices and tables"
msgstr ""
#: ../../index.rst:30
msgid ":ref:`genindex`"
msgstr ""
#: ../../index.rst:31
msgid ":ref:`modindex`"
msgstr ""
#: ../../index.rst:32
msgid ":ref:`search`"
msgstr ""

BIN
docs/server_handbook/po/bg/LC_MESSAGES/introduction.mo Normal file
View File

Binary file not shown.

116
docs/server_handbook/po/bg/LC_MESSAGES/introduction.po Normal file
View File

@@ -0,0 +1,116 @@
#
msgid ""
msgstr ""
"Project-Id-Version: SysAdm™ Server Handbook 1.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2016-09-16 13:41-0400\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
#: ../../introduction.rst:13
msgid "Introduction"
msgstr ""
#: ../../introduction.rst:15
msgid "**Preface**"
msgstr ""
#: ../../introduction.rst:17
msgid "Written by users of the SysAdm™ management utility."
msgstr ""
#: ../../introduction.rst:19
msgid "Version |version|"
msgstr ""
#: ../../introduction.rst:21
msgid "Copyright © 2016 iXSystems®."
msgstr ""
#: ../../introduction.rst:23
msgid ""
"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`."
msgstr ""
#: ../../introduction.rst:28
msgid ""
"SysAdm™ is still under heavy development, and all information contained in "
"the documentation is subject to change."
msgstr ""
#: ../../introduction.rst:31
msgid "**What is SysAdm™?**"
msgstr ""
#: ../../introduction.rst:33
msgid ""
"SysAdm™ is a middleware utility designed to streamline system management "
"with options for both local and remote access."
msgstr ""
#: ../../introduction.rst:36
msgid ""
"By default, SysAdm™ does **not** allow for remote access. The user must "
"configure the system to allow this feature."
msgstr ""
#: ../../introduction.rst:39
msgid ""
"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\" the same language, "
"allowing for simple and effective system administration."
msgstr ""
#: ../../introduction.rst:47
msgid ""
"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."
msgstr ""
#: ../../introduction.rst:52
msgid ""
"In order to address security concerns, the bridge device is always "
"considered \"untrusted\" and several layers of encryption are added to all "
"traffic flowing through the bridge to ensure it can not be used to record or"
" alter critical information flow."
msgstr ""
#: ../../introduction.rst:57
msgid "**Would you like to know more?**"
msgstr ""
#: ../../introduction.rst:59
msgid ""
"Documentation for the SysAdm™ project is split amongst three handbooks:"
msgstr ""
#: ../../introduction.rst:61
msgid ""
"**API Reference Guide**: A library of all API calls and WebSocket requests "
"for SysAdm™. This reference is constantly updated as new API calls are "
"written. It can be found at https://api.sysadm.us/."
msgstr ""
#: ../../introduction.rst:65
msgid ""
"**Client Handbook**: A detailed guide to all client side functions of "
"SysAdm™."
msgstr ""
#: ../../introduction.rst:68
msgid ""
"**Server Handbook**: A basic guide to initializing SysAdm™ with a bridge and"
" server connection."
msgstr ""

BIN
docs/server_handbook/po/bg/LC_MESSAGES/manage.mo Normal file
View File

Binary file not shown.

39
docs/server_handbook/po/bg/LC_MESSAGES/manage.po Normal file
View File

@@ -0,0 +1,39 @@
#
msgid ""
msgstr ""
"Project-Id-Version: SysAdm™ Server Handbook 1.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2016-09-16 13:41-0400\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
#: ../../manage.rst:13
msgid "Managing SysAdm™"
msgstr ""
#: ../../manage.rst:15
msgid ""
"SysAdm™ comes with a standard configuration file located in "
":file:`/usr/local/etc/sysadm.conf.dist`."
msgstr ""
#: ../../manage.rst:18
msgid ""
"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™:"
msgstr ""
#: ../../manage.rst:32
msgid "This default configuration also has blacklist options:"
msgstr ""
#: ../../manage.rst:48
msgid ""
"Please note these default options are subject to change as the SysAdm™ "
"utility is developed."
msgstr ""

BIN
docs/server_handbook/po/da/LC_MESSAGES/basics.mo Normal file
View File

Binary file not shown.

192
docs/server_handbook/po/da/LC_MESSAGES/basics.po Normal file
View File

@@ -0,0 +1,192 @@
#
msgid ""
msgstr ""
"Project-Id-Version: SysAdm™ Server Handbook 1.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2016-09-16 13:41-0400\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
#: ../../basics.rst:13
msgid "Getting Started"
msgstr ""
#: ../../basics.rst:15
msgid ""
"Beginning with SysAdm™ is a relatively simple process. SysAdm™ files are "
"currently available from the `github repository "
"<https://github.com/trueos/sysadm>`_"
msgstr ""
#: ../../basics.rst:22
msgid "Building SysAdm™"
msgstr ""
#: ../../basics.rst:24
msgid "Several Qt Modules are required before attempting to build SysAdm™:"
msgstr ""
#: ../../basics.rst:33
msgid ""
"Building the prototype version of SysAdm™ assumes you have access to "
"github.com."
msgstr ""
#: ../../basics.rst:46
msgid "Starting SysAdm™"
msgstr ""
#: ../../basics.rst:48
msgid ""
"SysAdm™ can be started one of two ways: the traditional rc(8) mechanism or "
"using the new jobd(8) mechanism"
msgstr ""
#: ../../basics.rst:51
msgid "To run under rc(8)"
msgstr ""
#: ../../basics.rst:63
msgid "To run under jobd(8)"
msgstr ""
#: ../../basics.rst:73
msgid ""
"Several ports on the system firewall will need to be opened for SysAdm™ to "
"have remote access functionality:"
msgstr ""
#: ../../basics.rst:76
msgid "Port 12149 for WebSocket interaction."
msgstr ""
#: ../../basics.rst:77
msgid "Port 12150 for the REST interface."
msgstr ""
#: ../../basics.rst:78
msgid "Port 12151 for the SysAdm™ bridge server."
msgstr ""
#: ../../basics.rst:80
msgid "The user can also designate their own ports for SysAdm™."
msgstr ""
#: ../../basics.rst:85
msgid "Bridge Initialization"
msgstr ""
#: ../../basics.rst:87
msgid ""
"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."
msgstr ""
#: ../../basics.rst:94
msgid ""
"A list of current commands is available by typing :command:`-h` after the "
"utility name (Example: :command:`sysadm-bridge -h`)."
msgstr ""
#: ../../basics.rst:100
msgid "Server and Bridge Initialization"
msgstr ""
#: ../../basics.rst:102
msgid ""
"To initialize the server and bridge, begin with the server. Run "
":command:`sudo sysadm-binary bridge_export_key [optional absolute file "
"path]`. This will export the public SSL key the server uses to authenticate "
"with the bridge."
msgstr ""
#: ../../basics.rst:107
msgid ""
"For both server and client, give SSL key files an easy to remember name and "
"location to simplify the process of finding those files for import to the "
"bridge."
msgstr ""
#: ../../basics.rst:111
msgid ""
"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 <filename> <filepath>`, replacing <filename> and <filepath> "
"with the server key filename and location. Once the server key file is "
"successfully imported, start the bridge (if not already running)."
msgstr ""
#: ../../basics.rst:118
msgid ""
"The bridge can import SSL files regardless of its active state with no "
"negative effects."
msgstr ""
#: ../../basics.rst:121
msgid ""
"Back on the server, run :command:`sudo sysadm-binary bridge_add <nickname> "
"<URL>` 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."
msgstr ""
#: ../../basics.rst:134
msgid "Adding a Client to the Server/Bridge Connection"
msgstr ""
#: ../../basics.rst:136
msgid ""
"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."
msgstr ""
#: ../../basics.rst:140
msgid ""
"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 :guilabel:`Export Public "
"Key` for both the server and bridge keys. This will export both SSL keys in "
"file form, depositing them in either the :file:`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."
msgstr ""
#: ../../basics.rst:150
msgid ""
"Moving to the bridge, as the administrator (or root), run :command:`sysadm-"
"bridge import_ssl_file <nickname> <filepath>` 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."
msgstr ""
#: ../../basics.rst:156
msgid ""
"On the server, run :command:`sudo sysadm-binary import_ssl_key <username> "
"<filepath> [<email>]` to import the client -> server SSL key file. This "
"grants an individual with the specific SSL authorization the same "
"permissions as <user>."
msgstr ""
#: ../../basics.rst:160
msgid ""
"Back in the user client, open the connection manager and choose "
":guilabel:`Bridge Relay` as the connection option. Input the established "
"bridge's URL and click :guilabel:`Connect`. The bridge will now show up in "
"the menu tree with a different icon, and will have a sub-menu of connections"
" within it. Click on the bridged system to will open the standard UI, but "
"note the connection is still being relayed through the bridge."
msgstr ""

BIN
docs/server_handbook/po/da/LC_MESSAGES/index.mo Normal file
View File

Binary file not shown.

36
docs/server_handbook/po/da/LC_MESSAGES/index.po Normal file
View File

@@ -0,0 +1,36 @@
#
msgid ""
msgstr ""
"Project-Id-Version: SysAdm™ Server Handbook 1.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2016-09-16 13:41-0400\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
#: ../../index.rst:16
msgid "Welcome to the SysAdm Server Handbook!"
msgstr ""
#: ../../index.rst:18
msgid "Contents:"
msgstr ""
#: ../../index.rst:28
msgid "Indices and tables"
msgstr ""
#: ../../index.rst:30
msgid ":ref:`genindex`"
msgstr ""
#: ../../index.rst:31
msgid ":ref:`modindex`"
msgstr ""
#: ../../index.rst:32
msgid ":ref:`search`"
msgstr ""

BIN
docs/server_handbook/po/da/LC_MESSAGES/introduction.mo Normal file
View File

Binary file not shown.

116
docs/server_handbook/po/da/LC_MESSAGES/introduction.po Normal file
View File

@@ -0,0 +1,116 @@
#
msgid ""
msgstr ""
"Project-Id-Version: SysAdm™ Server Handbook 1.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2016-09-16 13:41-0400\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
#: ../../introduction.rst:13
msgid "Introduction"
msgstr ""
#: ../../introduction.rst:15
msgid "**Preface**"
msgstr ""
#: ../../introduction.rst:17
msgid "Written by users of the SysAdm™ management utility."
msgstr ""
#: ../../introduction.rst:19
msgid "Version |version|"
msgstr ""
#: ../../introduction.rst:21
msgid "Copyright © 2016 iXSystems®."
msgstr ""
#: ../../introduction.rst:23
msgid ""
"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`."
msgstr ""
#: ../../introduction.rst:28
msgid ""
"SysAdm™ is still under heavy development, and all information contained in "
"the documentation is subject to change."
msgstr ""
#: ../../introduction.rst:31
msgid "**What is SysAdm™?**"
msgstr ""
#: ../../introduction.rst:33
msgid ""
"SysAdm™ is a middleware utility designed to streamline system management "
"with options for both local and remote access."
msgstr ""
#: ../../introduction.rst:36
msgid ""
"By default, SysAdm™ does **not** allow for remote access. The user must "
"configure the system to allow this feature."
msgstr ""
#: ../../introduction.rst:39
msgid ""
"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\" the same language, "
"allowing for simple and effective system administration."
msgstr ""
#: ../../introduction.rst:47
msgid ""
"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."
msgstr ""
#: ../../introduction.rst:52
msgid ""
"In order to address security concerns, the bridge device is always "
"considered \"untrusted\" and several layers of encryption are added to all "
"traffic flowing through the bridge to ensure it can not be used to record or"
" alter critical information flow."
msgstr ""
#: ../../introduction.rst:57
msgid "**Would you like to know more?**"
msgstr ""
#: ../../introduction.rst:59
msgid ""
"Documentation for the SysAdm™ project is split amongst three handbooks:"
msgstr ""
#: ../../introduction.rst:61
msgid ""
"**API Reference Guide**: A library of all API calls and WebSocket requests "
"for SysAdm™. This reference is constantly updated as new API calls are "
"written. It can be found at https://api.sysadm.us/."
msgstr ""
#: ../../introduction.rst:65
msgid ""
"**Client Handbook**: A detailed guide to all client side functions of "
"SysAdm™."
msgstr ""
#: ../../introduction.rst:68
msgid ""
"**Server Handbook**: A basic guide to initializing SysAdm™ with a bridge and"
" server connection."
msgstr ""

BIN
docs/server_handbook/po/da/LC_MESSAGES/manage.mo Normal file
View File

Binary file not shown.

39
docs/server_handbook/po/da/LC_MESSAGES/manage.po Normal file
View File

@@ -0,0 +1,39 @@
#
msgid ""
msgstr ""
"Project-Id-Version: SysAdm™ Server Handbook 1.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2016-09-16 13:41-0400\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
#: ../../manage.rst:13
msgid "Managing SysAdm™"
msgstr ""
#: ../../manage.rst:15
msgid ""
"SysAdm™ comes with a standard configuration file located in "
":file:`/usr/local/etc/sysadm.conf.dist`."
msgstr ""
#: ../../manage.rst:18
msgid ""
"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™:"
msgstr ""
#: ../../manage.rst:32
msgid "This default configuration also has blacklist options:"
msgstr ""
#: ../../manage.rst:48
msgid ""
"Please note these default options are subject to change as the SysAdm™ "
"utility is developed."
msgstr ""

BIN
docs/server_handbook/po/de/LC_MESSAGES/basics.mo Normal file
View File

Binary file not shown.

192
docs/server_handbook/po/de/LC_MESSAGES/basics.po Normal file
View File

@@ -0,0 +1,192 @@
#
msgid ""
msgstr ""
"Project-Id-Version: SysAdm™ Server Handbook 1.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2016-09-16 13:41-0400\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
#: ../../basics.rst:13
msgid "Getting Started"
msgstr ""
#: ../../basics.rst:15
msgid ""
"Beginning with SysAdm™ is a relatively simple process. SysAdm™ files are "
"currently available from the `github repository "
"<https://github.com/trueos/sysadm>`_"
msgstr ""
#: ../../basics.rst:22
msgid "Building SysAdm™"
msgstr ""
#: ../../basics.rst:24
msgid "Several Qt Modules are required before attempting to build SysAdm™:"
msgstr ""
#: ../../basics.rst:33
msgid ""
"Building the prototype version of SysAdm™ assumes you have access to "
"github.com."
msgstr ""
#: ../../basics.rst:46
msgid "Starting SysAdm™"
msgstr ""
#: ../../basics.rst:48
msgid ""
"SysAdm™ can be started one of two ways: the traditional rc(8) mechanism or "
"using the new jobd(8) mechanism"
msgstr ""
#: ../../basics.rst:51
msgid "To run under rc(8)"
msgstr ""
#: ../../basics.rst:63
msgid "To run under jobd(8)"
msgstr ""
#: ../../basics.rst:73
msgid ""
"Several ports on the system firewall will need to be opened for SysAdm™ to "
"have remote access functionality:"
msgstr ""
#: ../../basics.rst:76
msgid "Port 12149 for WebSocket interaction."
msgstr ""
#: ../../basics.rst:77
msgid "Port 12150 for the REST interface."
msgstr ""
#: ../../basics.rst:78
msgid "Port 12151 for the SysAdm™ bridge server."
msgstr ""
#: ../../basics.rst:80
msgid "The user can also designate their own ports for SysAdm™."
msgstr ""
#: ../../basics.rst:85
msgid "Bridge Initialization"
msgstr ""
#: ../../basics.rst:87
msgid ""
"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."
msgstr ""
#: ../../basics.rst:94
msgid ""
"A list of current commands is available by typing :command:`-h` after the "
"utility name (Example: :command:`sysadm-bridge -h`)."
msgstr ""
#: ../../basics.rst:100
msgid "Server and Bridge Initialization"
msgstr ""
#: ../../basics.rst:102
msgid ""
"To initialize the server and bridge, begin with the server. Run "
":command:`sudo sysadm-binary bridge_export_key [optional absolute file "
"path]`. This will export the public SSL key the server uses to authenticate "
"with the bridge."
msgstr ""
#: ../../basics.rst:107
msgid ""
"For both server and client, give SSL key files an easy to remember name and "
"location to simplify the process of finding those files for import to the "
"bridge."
msgstr ""
#: ../../basics.rst:111
msgid ""
"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 <filename> <filepath>`, replacing <filename> and <filepath> "
"with the server key filename and location. Once the server key file is "
"successfully imported, start the bridge (if not already running)."
msgstr ""
#: ../../basics.rst:118
msgid ""
"The bridge can import SSL files regardless of its active state with no "
"negative effects."
msgstr ""
#: ../../basics.rst:121
msgid ""
"Back on the server, run :command:`sudo sysadm-binary bridge_add <nickname> "
"<URL>` 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."
msgstr ""
#: ../../basics.rst:134
msgid "Adding a Client to the Server/Bridge Connection"
msgstr ""
#: ../../basics.rst:136
msgid ""
"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."
msgstr ""
#: ../../basics.rst:140
msgid ""
"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 :guilabel:`Export Public "
"Key` for both the server and bridge keys. This will export both SSL keys in "
"file form, depositing them in either the :file:`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."
msgstr ""
#: ../../basics.rst:150
msgid ""
"Moving to the bridge, as the administrator (or root), run :command:`sysadm-"
"bridge import_ssl_file <nickname> <filepath>` 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."
msgstr ""
#: ../../basics.rst:156
msgid ""
"On the server, run :command:`sudo sysadm-binary import_ssl_key <username> "
"<filepath> [<email>]` to import the client -> server SSL key file. This "
"grants an individual with the specific SSL authorization the same "
"permissions as <user>."
msgstr ""
#: ../../basics.rst:160
msgid ""
"Back in the user client, open the connection manager and choose "
":guilabel:`Bridge Relay` as the connection option. Input the established "
"bridge's URL and click :guilabel:`Connect`. The bridge will now show up in "
"the menu tree with a different icon, and will have a sub-menu of connections"
" within it. Click on the bridged system to will open the standard UI, but "
"note the connection is still being relayed through the bridge."
msgstr ""

BIN
docs/server_handbook/po/de/LC_MESSAGES/index.mo Normal file
View File

Binary file not shown.

36
docs/server_handbook/po/de/LC_MESSAGES/index.po Normal file
View File

@@ -0,0 +1,36 @@
#
msgid ""
msgstr ""
"Project-Id-Version: SysAdm™ Server Handbook 1.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2016-09-16 13:41-0400\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
#: ../../index.rst:16
msgid "Welcome to the SysAdm Server Handbook!"
msgstr ""
#: ../../index.rst:18
msgid "Contents:"
msgstr ""
#: ../../index.rst:28
msgid "Indices and tables"
msgstr ""
#: ../../index.rst:30
msgid ":ref:`genindex`"
msgstr ""
#: ../../index.rst:31
msgid ":ref:`modindex`"
msgstr ""
#: ../../index.rst:32
msgid ":ref:`search`"
msgstr ""

BIN
docs/server_handbook/po/de/LC_MESSAGES/introduction.mo Normal file
View File

Binary file not shown.

116
docs/server_handbook/po/de/LC_MESSAGES/introduction.po Normal file
View File

@@ -0,0 +1,116 @@
#
msgid ""
msgstr ""
"Project-Id-Version: SysAdm™ Server Handbook 1.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2016-09-16 13:41-0400\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
#: ../../introduction.rst:13
msgid "Introduction"
msgstr ""
#: ../../introduction.rst:15
msgid "**Preface**"
msgstr ""
#: ../../introduction.rst:17
msgid "Written by users of the SysAdm™ management utility."
msgstr ""
#: ../../introduction.rst:19
msgid "Version |version|"
msgstr ""
#: ../../introduction.rst:21
msgid "Copyright © 2016 iXSystems®."
msgstr ""
#: ../../introduction.rst:23
msgid ""
"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`."
msgstr ""
#: ../../introduction.rst:28
msgid ""
"SysAdm™ is still under heavy development, and all information contained in "
"the documentation is subject to change."
msgstr ""
#: ../../introduction.rst:31
msgid "**What is SysAdm™?**"
msgstr ""
#: ../../introduction.rst:33
msgid ""
"SysAdm™ is a middleware utility designed to streamline system management "
"with options for both local and remote access."
msgstr ""
#: ../../introduction.rst:36
msgid ""
"By default, SysAdm™ does **not** allow for remote access. The user must "
"configure the system to allow this feature."
msgstr ""
#: ../../introduction.rst:39
msgid ""
"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\" the same language, "
"allowing for simple and effective system administration."
msgstr ""
#: ../../introduction.rst:47
msgid ""
"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."
msgstr ""
#: ../../introduction.rst:52
msgid ""
"In order to address security concerns, the bridge device is always "
"considered \"untrusted\" and several layers of encryption are added to all "
"traffic flowing through the bridge to ensure it can not be used to record or"
" alter critical information flow."
msgstr ""
#: ../../introduction.rst:57
msgid "**Would you like to know more?**"
msgstr ""
#: ../../introduction.rst:59
msgid ""
"Documentation for the SysAdm™ project is split amongst three handbooks:"
msgstr ""
#: ../../introduction.rst:61
msgid ""
"**API Reference Guide**: A library of all API calls and WebSocket requests "
"for SysAdm™. This reference is constantly updated as new API calls are "
"written. It can be found at https://api.sysadm.us/."
msgstr ""
#: ../../introduction.rst:65
msgid ""
"**Client Handbook**: A detailed guide to all client side functions of "
"SysAdm™."
msgstr ""
#: ../../introduction.rst:68
msgid ""
"**Server Handbook**: A basic guide to initializing SysAdm™ with a bridge and"
" server connection."
msgstr ""

BIN
docs/server_handbook/po/de/LC_MESSAGES/manage.mo Normal file
View File

Binary file not shown.

39
docs/server_handbook/po/de/LC_MESSAGES/manage.po Normal file
View File

@@ -0,0 +1,39 @@
#
msgid ""
msgstr ""
"Project-Id-Version: SysAdm™ Server Handbook 1.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2016-09-16 13:41-0400\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
#: ../../manage.rst:13
msgid "Managing SysAdm™"
msgstr ""
#: ../../manage.rst:15
msgid ""
"SysAdm™ comes with a standard configuration file located in "
":file:`/usr/local/etc/sysadm.conf.dist`."
msgstr ""
#: ../../manage.rst:18
msgid ""
"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™:"
msgstr ""
#: ../../manage.rst:32
msgid "This default configuration also has blacklist options:"
msgstr ""
#: ../../manage.rst:48
msgid ""
"Please note these default options are subject to change as the SysAdm™ "
"utility is developed."
msgstr ""

BIN
docs/server_handbook/po/es/LC_MESSAGES/basics.mo Normal file
View File

Binary file not shown.

192
docs/server_handbook/po/es/LC_MESSAGES/basics.po Normal file
View File

@@ -0,0 +1,192 @@
#
msgid ""
msgstr ""
"Project-Id-Version: SysAdm™ Server Handbook 1.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2016-09-16 13:41-0400\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
#: ../../basics.rst:13
msgid "Getting Started"
msgstr ""
#: ../../basics.rst:15
msgid ""
"Beginning with SysAdm™ is a relatively simple process. SysAdm™ files are "
"currently available from the `github repository "
"<https://github.com/trueos/sysadm>`_"
msgstr ""
#: ../../basics.rst:22
msgid "Building SysAdm™"
msgstr ""
#: ../../basics.rst:24
msgid "Several Qt Modules are required before attempting to build SysAdm™:"
msgstr ""
#: ../../basics.rst:33
msgid ""
"Building the prototype version of SysAdm™ assumes you have access to "
"github.com."
msgstr ""
#: ../../basics.rst:46
msgid "Starting SysAdm™"
msgstr ""
#: ../../basics.rst:48
msgid ""
"SysAdm™ can be started one of two ways: the traditional rc(8) mechanism or "
"using the new jobd(8) mechanism"
msgstr ""
#: ../../basics.rst:51
msgid "To run under rc(8)"
msgstr ""
#: ../../basics.rst:63
msgid "To run under jobd(8)"
msgstr ""
#: ../../basics.rst:73
msgid ""
"Several ports on the system firewall will need to be opened for SysAdm™ to "
"have remote access functionality:"
msgstr ""
#: ../../basics.rst:76
msgid "Port 12149 for WebSocket interaction."
msgstr ""
#: ../../basics.rst:77
msgid "Port 12150 for the REST interface."
msgstr ""
#: ../../basics.rst:78
msgid "Port 12151 for the SysAdm™ bridge server."
msgstr ""
#: ../../basics.rst:80
msgid "The user can also designate their own ports for SysAdm™."
msgstr ""
#: ../../basics.rst:85
msgid "Bridge Initialization"
msgstr ""
#: ../../basics.rst:87
msgid ""
"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."
msgstr ""
#: ../../basics.rst:94
msgid ""
"A list of current commands is available by typing :command:`-h` after the "
"utility name (Example: :command:`sysadm-bridge -h`)."
msgstr ""
#: ../../basics.rst:100
msgid "Server and Bridge Initialization"
msgstr ""
#: ../../basics.rst:102
msgid ""
"To initialize the server and bridge, begin with the server. Run "
":command:`sudo sysadm-binary bridge_export_key [optional absolute file "
"path]`. This will export the public SSL key the server uses to authenticate "
"with the bridge."
msgstr ""
#: ../../basics.rst:107
msgid ""
"For both server and client, give SSL key files an easy to remember name and "
"location to simplify the process of finding those files for import to the "
"bridge."
msgstr ""
#: ../../basics.rst:111
msgid ""
"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 <filename> <filepath>`, replacing <filename> and <filepath> "
"with the server key filename and location. Once the server key file is "
"successfully imported, start the bridge (if not already running)."
msgstr ""
#: ../../basics.rst:118
msgid ""
"The bridge can import SSL files regardless of its active state with no "
"negative effects."
msgstr ""
#: ../../basics.rst:121
msgid ""
"Back on the server, run :command:`sudo sysadm-binary bridge_add <nickname> "
"<URL>` 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."
msgstr ""
#: ../../basics.rst:134
msgid "Adding a Client to the Server/Bridge Connection"
msgstr ""
#: ../../basics.rst:136
msgid ""
"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."
msgstr ""
#: ../../basics.rst:140
msgid ""
"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 :guilabel:`Export Public "
"Key` for both the server and bridge keys. This will export both SSL keys in "
"file form, depositing them in either the :file:`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."
msgstr ""
#: ../../basics.rst:150
msgid ""
"Moving to the bridge, as the administrator (or root), run :command:`sysadm-"
"bridge import_ssl_file <nickname> <filepath>` 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."
msgstr ""
#: ../../basics.rst:156
msgid ""
"On the server, run :command:`sudo sysadm-binary import_ssl_key <username> "
"<filepath> [<email>]` to import the client -> server SSL key file. This "
"grants an individual with the specific SSL authorization the same "
"permissions as <user>."
msgstr ""
#: ../../basics.rst:160
msgid ""
"Back in the user client, open the connection manager and choose "
":guilabel:`Bridge Relay` as the connection option. Input the established "
"bridge's URL and click :guilabel:`Connect`. The bridge will now show up in "
"the menu tree with a different icon, and will have a sub-menu of connections"
" within it. Click on the bridged system to will open the standard UI, but "
"note the connection is still being relayed through the bridge."
msgstr ""

BIN
docs/server_handbook/po/es/LC_MESSAGES/index.mo Normal file
View File

Binary file not shown.

36
docs/server_handbook/po/es/LC_MESSAGES/index.po Normal file
View File

@@ -0,0 +1,36 @@
#
msgid ""
msgstr ""
"Project-Id-Version: SysAdm™ Server Handbook 1.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2016-09-16 13:41-0400\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
#: ../../index.rst:16
msgid "Welcome to the SysAdm Server Handbook!"
msgstr ""
#: ../../index.rst:18
msgid "Contents:"
msgstr ""
#: ../../index.rst:28
msgid "Indices and tables"
msgstr ""
#: ../../index.rst:30
msgid ":ref:`genindex`"
msgstr ""
#: ../../index.rst:31
msgid ":ref:`modindex`"
msgstr ""
#: ../../index.rst:32
msgid ":ref:`search`"
msgstr ""

BIN
docs/server_handbook/po/es/LC_MESSAGES/introduction.mo Normal file
View File

Binary file not shown.

116
docs/server_handbook/po/es/LC_MESSAGES/introduction.po Normal file
View File

@@ -0,0 +1,116 @@
#
msgid ""
msgstr ""
"Project-Id-Version: SysAdm™ Server Handbook 1.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2016-09-16 13:41-0400\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
#: ../../introduction.rst:13
msgid "Introduction"
msgstr ""
#: ../../introduction.rst:15
msgid "**Preface**"
msgstr ""
#: ../../introduction.rst:17
msgid "Written by users of the SysAdm™ management utility."
msgstr ""
#: ../../introduction.rst:19
msgid "Version |version|"
msgstr ""
#: ../../introduction.rst:21
msgid "Copyright © 2016 iXSystems®."
msgstr ""
#: ../../introduction.rst:23
msgid ""
"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`."
msgstr ""
#: ../../introduction.rst:28
msgid ""
"SysAdm™ is still under heavy development, and all information contained in "
"the documentation is subject to change."
msgstr ""
#: ../../introduction.rst:31
msgid "**What is SysAdm™?**"
msgstr ""
#: ../../introduction.rst:33
msgid ""
"SysAdm™ is a middleware utility designed to streamline system management "
"with options for both local and remote access."
msgstr ""
#: ../../introduction.rst:36
msgid ""
"By default, SysAdm™ does **not** allow for remote access. The user must "
"configure the system to allow this feature."
msgstr ""
#: ../../introduction.rst:39
msgid ""
"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\" the same language, "
"allowing for simple and effective system administration."
msgstr ""
#: ../../introduction.rst:47
msgid ""
"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."
msgstr ""
#: ../../introduction.rst:52
msgid ""
"In order to address security concerns, the bridge device is always "
"considered \"untrusted\" and several layers of encryption are added to all "
"traffic flowing through the bridge to ensure it can not be used to record or"
" alter critical information flow."
msgstr ""
#: ../../introduction.rst:57
msgid "**Would you like to know more?**"
msgstr ""
#: ../../introduction.rst:59
msgid ""
"Documentation for the SysAdm™ project is split amongst three handbooks:"
msgstr ""
#: ../../introduction.rst:61
msgid ""
"**API Reference Guide**: A library of all API calls and WebSocket requests "
"for SysAdm™. This reference is constantly updated as new API calls are "
"written. It can be found at https://api.sysadm.us/."
msgstr ""
#: ../../introduction.rst:65
msgid ""
"**Client Handbook**: A detailed guide to all client side functions of "
"SysAdm™."
msgstr ""
#: ../../introduction.rst:68
msgid ""
"**Server Handbook**: A basic guide to initializing SysAdm™ with a bridge and"
" server connection."
msgstr ""

BIN
docs/server_handbook/po/es/LC_MESSAGES/manage.mo Normal file
View File

Binary file not shown.

39
docs/server_handbook/po/es/LC_MESSAGES/manage.po Normal file
View File

@@ -0,0 +1,39 @@
#
msgid ""
msgstr ""
"Project-Id-Version: SysAdm™ Server Handbook 1.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2016-09-16 13:41-0400\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
#: ../../manage.rst:13
msgid "Managing SysAdm™"
msgstr ""
#: ../../manage.rst:15
msgid ""
"SysAdm™ comes with a standard configuration file located in "
":file:`/usr/local/etc/sysadm.conf.dist`."
msgstr ""
#: ../../manage.rst:18
msgid ""
"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™:"
msgstr ""
#: ../../manage.rst:32
msgid "This default configuration also has blacklist options:"
msgstr ""
#: ../../manage.rst:48
msgid ""
"Please note these default options are subject to change as the SysAdm™ "
"utility is developed."
msgstr ""

BIN
docs/server_handbook/po/fr/LC_MESSAGES/basics.mo Normal file
View File

Binary file not shown.

192
docs/server_handbook/po/fr/LC_MESSAGES/basics.po Normal file
View File

@@ -0,0 +1,192 @@
#
msgid ""
msgstr ""
"Project-Id-Version: SysAdm™ Server Handbook 1.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2016-09-16 13:41-0400\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
#: ../../basics.rst:13
msgid "Getting Started"
msgstr ""
#: ../../basics.rst:15
msgid ""
"Beginning with SysAdm™ is a relatively simple process. SysAdm™ files are "
"currently available from the `github repository "
"<https://github.com/trueos/sysadm>`_"
msgstr ""
#: ../../basics.rst:22
msgid "Building SysAdm™"
msgstr ""
#: ../../basics.rst:24
msgid "Several Qt Modules are required before attempting to build SysAdm™:"
msgstr ""
#: ../../basics.rst:33
msgid ""
"Building the prototype version of SysAdm™ assumes you have access to "
"github.com."
msgstr ""
#: ../../basics.rst:46
msgid "Starting SysAdm™"
msgstr ""
#: ../../basics.rst:48
msgid ""
"SysAdm™ can be started one of two ways: the traditional rc(8) mechanism or "
"using the new jobd(8) mechanism"
msgstr ""
#: ../../basics.rst:51
msgid "To run under rc(8)"
msgstr ""
#: ../../basics.rst:63
msgid "To run under jobd(8)"
msgstr ""
#: ../../basics.rst:73
msgid ""
"Several ports on the system firewall will need to be opened for SysAdm™ to "
"have remote access functionality:"
msgstr ""
#: ../../basics.rst:76
msgid "Port 12149 for WebSocket interaction."
msgstr ""
#: ../../basics.rst:77
msgid "Port 12150 for the REST interface."
msgstr ""
#: ../../basics.rst:78
msgid "Port 12151 for the SysAdm™ bridge server."
msgstr ""
#: ../../basics.rst:80
msgid "The user can also designate their own ports for SysAdm™."
msgstr ""
#: ../../basics.rst:85
msgid "Bridge Initialization"
msgstr ""
#: ../../basics.rst:87
msgid ""
"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."
msgstr ""
#: ../../basics.rst:94
msgid ""
"A list of current commands is available by typing :command:`-h` after the "
"utility name (Example: :command:`sysadm-bridge -h`)."
msgstr ""
#: ../../basics.rst:100
msgid "Server and Bridge Initialization"
msgstr ""
#: ../../basics.rst:102
msgid ""
"To initialize the server and bridge, begin with the server. Run "
":command:`sudo sysadm-binary bridge_export_key [optional absolute file "
"path]`. This will export the public SSL key the server uses to authenticate "
"with the bridge."
msgstr ""
#: ../../basics.rst:107
msgid ""
"For both server and client, give SSL key files an easy to remember name and "
"location to simplify the process of finding those files for import to the "
"bridge."
msgstr ""
#: ../../basics.rst:111
msgid ""
"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 <filename> <filepath>`, replacing <filename> and <filepath> "
"with the server key filename and location. Once the server key file is "
"successfully imported, start the bridge (if not already running)."
msgstr ""
#: ../../basics.rst:118
msgid ""
"The bridge can import SSL files regardless of its active state with no "
"negative effects."
msgstr ""
#: ../../basics.rst:121
msgid ""
"Back on the server, run :command:`sudo sysadm-binary bridge_add <nickname> "
"<URL>` 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."
msgstr ""
#: ../../basics.rst:134
msgid "Adding a Client to the Server/Bridge Connection"
msgstr ""
#: ../../basics.rst:136
msgid ""
"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."
msgstr ""
#: ../../basics.rst:140
msgid ""
"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 :guilabel:`Export Public "
"Key` for both the server and bridge keys. This will export both SSL keys in "
"file form, depositing them in either the :file:`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."
msgstr ""
#: ../../basics.rst:150
msgid ""
"Moving to the bridge, as the administrator (or root), run :command:`sysadm-"
"bridge import_ssl_file <nickname> <filepath>` 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."
msgstr ""
#: ../../basics.rst:156
msgid ""
"On the server, run :command:`sudo sysadm-binary import_ssl_key <username> "
"<filepath> [<email>]` to import the client -> server SSL key file. This "
"grants an individual with the specific SSL authorization the same "
"permissions as <user>."
msgstr ""
#: ../../basics.rst:160
msgid ""
"Back in the user client, open the connection manager and choose "
":guilabel:`Bridge Relay` as the connection option. Input the established "
"bridge's URL and click :guilabel:`Connect`. The bridge will now show up in "
"the menu tree with a different icon, and will have a sub-menu of connections"
" within it. Click on the bridged system to will open the standard UI, but "
"note the connection is still being relayed through the bridge."
msgstr ""

Some files were not shown because too many files have changed in this diff Show More