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-11-10 09:57:08 -05:00
parent c0c7655781 57065bf14f
commit a6cda869bb
183 changed files with 36537 additions and 1780 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."

5
docs/api_reference/classes/index.rst
View File

@@ -1,6 +1,7 @@
=========
.. _classes:
Classes
=========
=======
.. toctree::
:glob:

18
docs/api_reference/conf.py
View File

@@ -27,6 +27,10 @@ import sys, os
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinxcontrib.httpdomain']
# -- Options for automatic Figure numbering
numfig = True
numfig_secnum_depth = (2)
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@ -88,13 +92,13 @@ pygments_style = 'sphinx'
#Option to add text substitutions to all .rst files being built.
rst_prolog = """
.. |freenas| replace:: FreeNAS"""u'\u00AE'"""
.. |truenas| replace:: TrueNAS"""u'\u00AE'"""
.. |pcbsd| replace:: PC-BSD"""u'\u00AE'"""
.. |trueos| replace:: TrueOS"""u'\u00AE'"""
.. |appcafe| replace:: AppCafe"""u'\u00AE'"""
.. |lumina| replace:: Lumina"""u'\u00AE'"""
.. |sysadm| replace:: SysAdm"""u'\u2122'"""
.. |freenas| replace:: FreeNAS\ :sup:`"""u'\u00AE'"""`
.. |truenas| replace:: TrueNAS\ :sup:`"""u'\u00AE'"""`
.. |pcbsd| replace:: PC-BSD\ :sup:`"""u'\u00AE'"""`
.. |trueos| replace:: TrueOS\ :sup:`"""u'\u00AE'"""`
.. |appcafe| replace:: AppCafe\ :sup:`"""u'\u00AE'"""`
.. |lumina| replace:: Lumina\ :sup:`"""u'\u00AE'"""`
.. |sysadm| replace:: SysAdm\ :sup:`"""u'\u2122'"""`
"""
# -- Option to change :menuselection: arrow -----------------------------

113
docs/api_reference/events.rst
View File

@@ -10,28 +10,32 @@ updates about system status and other types of system notifications.
which was not designed for asynchronous events. For this
reason, only Websocket examples are used in this section.
Every events request contains several parameters:
Every events request contains several parameters, seen here in
:numref:`Table %s <eventpar>`.
+---------------+-----------+--------------------------------------+
| **Parameter** | **Value** | **Description** |
| | | |
+===============+===========+======================================+
| id | | Any unique value for the request, |
| | | including a hash, checksum, or uuid. |
+---------------+-----------+--------------------------------------+
| name | | Supported values are "subscribe" or |
| | | "unsubscribe". |
+---------------+-----------+--------------------------------------+
| namespace | events | |
| | | |
+---------------+-----------+--------------------------------------+
| args | | Values vary by type of class. |
| | | |
+---------------+-----------+--------------------------------------+
.. _eventpar:
.. table:: Event Request Parameters
+---------------+-----------+--------------------------------------+
| **Parameter** | **Value** | **Description** |
| | | |
+===============+===========+======================================+
| id | | Any unique value for the request, |
| | | including a hash, checksum, or uuid. |
+---------------+-----------+--------------------------------------+
| name | | Supported values are "subscribe" or |
| | | "unsubscribe". |
+---------------+-----------+--------------------------------------+
| namespace | events | |
| | | |
+---------------+-----------+--------------------------------------+
| args | | Values vary by type of class. |
| | | |
+---------------+-----------+--------------------------------------+
Subsystems can also be tracked using the events namespace. Currently,
there are three trackable subsystems: Dispatcher, Life Preserver, and
System State. Use the template to subscribe to various subsystem event
System State. Use this template to subscribe to various subsystem event
notifications:
**Websocket Request**
@@ -46,8 +50,8 @@ notifications:
}
Once subscribed, events will be received as they are produced. To
unsubscribe from events, repeat the request, using "unsubscribe" for the
"name".
unsubscribe from events, repeat the request, using
:command:`"unsubscribe"` for the :command:`"name"`.
Here is an example reply from the Life Preserver subsystem:
@@ -69,11 +73,11 @@ Here is an example reply from the Life Preserver subsystem:
Dispatcher
----------
The Dispatcher subsystem is used by SysAdm™ to process external commands
and return specific information from the utility. This is managed on the
server as a separate process, and will not interrupt primary server
tasks. To subscribe to the Dispatcher subsystem for event updates, use
the following:
The Dispatcher subsystem is used by |sysadm| to process external
commands and return specific information from the utility. This is
managed on the server as a separate process, and will not interrupt
primary server tasks. Subscribe to the Dispatcher subsystem for event
updates with this request:
**Websocket Request**
@@ -86,12 +90,16 @@ the following:
"args" : ["dispatcher"]
}
The Dispatcher event log will display three different states: "pending",
"running", and "finished". Depending upon the current state, the log can
The Dispatcher event log will display three different states: *pending*,
*running*, and *finished*. Depending upon the current state, the log can
change in some minor but noteworthy ways. The following sample logs will
reflect the differences between these states:
**Dispatcher Response: "Pending" state**
.. note:: The variable **event_system** will only appear when one of
the three available systems initiates the request and response.
Additional elements tied to these systems will also appear.
**Dispatcher Response: Pending**
.. code-block:: json
@@ -101,12 +109,11 @@ reflect the differences between these states:
"id" : "none",
"args" : {
"state" : "pending",
"cmd_list" : ["<command 1>", "<command 2>"],
"process_id" : "<random>"
}
}
**Dispatcher Response: "Running" state**
**Dispatcher Response: Running**
.. code-block:: json
@@ -115,18 +122,22 @@ reflect the differences between these states:
"name" : "dispatcher",
"id" : "none",
"args" : {
"event_system" : "<sysadm with /pkg, /update, or /iohyve]>",
"state" : "running",
"cmd_list" : ["<command 1>", "<command 2>"],
"process_id" : "<random>",
"time_started" : "<ISO 8601 time date string>",
"current_cmd" : "<command 2>",
"<command1>" : "<log after running command1>",
"<command2>" : "<log for command2>",
"return_codes/<command1>" : "<integer return code>"
"process_details" : {
"state" : "running",
"process_id" : "<random id>",
"time_started" : "<ISO 8601 time date string>",
"cmd_list" : ["<command 1>", "<command 2>"],
"<command1>" : "<log after running command1>",
"return_codes/<command1>" : "<integer return code>",
"current_cmd" : "<command 2>",
}
}
}
**Dispatcher Response: "Finished" state**
**Dispatcher Response: Finished**
.. code-block:: json
@@ -135,12 +146,20 @@ reflect the differences between these states:
"name" : "dispatcher",
"id" : "none",
"args" : {
"event_system" : "<sysadm with /pkg, /update, or /iohyve]>",
"state" : "finished",
"time_finished" : "<ISO 8601 time date string>",
"cmd_list" : ["<command 1>", "<command 2>"],
"return_codes/<command 1>" : "<code 1>",
"return_codes/<command 2>" : "<code 2>",
"process_id" : "<random>"
"process_id" : "<random>",
"process_details" : {
"state" : "finished",
"process_id" : "<random id>",
"time_started" : "<ISO 8601 time date string>",
"time_finished" : "<ISO 8601 time date string>",
"cmd_list" : ["<command 1>", "<command 2>"],
"<command1>" : "<log after running command1>",
"<command2>" : "<log after running command2>",
"return_codes/<command1>" : "<integer return code>",
"return_codes/<command2>" : "<integer return code>"
}
}
}
@@ -166,13 +185,12 @@ generalized sample:
}
For specific details on these special types of events please refer to
the Classes section of this User Guide.
the :ref:`classes` section of this guide.
Life Preserver
--------------
To subscribe to the Life Preserver subsystem for event updates, use the
following:
Subscribe to the Life Preserver subsystem for event updates with this:
**Websocket Request**
@@ -203,8 +221,7 @@ following:
System State
------------
To subscribe to the System State subsystem for event updates, use the
following:
Subscribe to the System State subsystem for event updates with this:
**Websocket Request**
@@ -220,7 +237,7 @@ following:
**Websocket Event Message**
This message will appear if the host name has changed and a priority
error has occurred.
error has occurred:
.. code-block:: json

0
docs/api_reference/connection.rst → docs/api_reference/getstarted.rst
View File

2
docs/api_reference/index.rst
View File

@@ -5,7 +5,7 @@ SysAdm™ API Reference Guide
:numbered:
:maxdepth: 4
connection
getstarted
events
classes/index

40
docs/api_reference/themes/trueos_style/static/css/trueos_style.css
View File

@@ -1957,7 +1957,7 @@ input[type="checkbox"][disabled] {
.wy-table th,
.rst-content table.docutils th,
.rst-content table.field-list th {
font-size: 90%;
font-size: 100%;
margin: 0;
overflow: visible;
padding: 8px 16px;
@@ -2026,21 +2026,21 @@ input[type="checkbox"][disabled] {
.wy-table-odd td,
.wy-table-striped tr:nth-child(odd) td,
.rst-content table.docutils:not(.field-list) tr:nth-child(odd) td {
background-color: #f3f6f6;
background-color: #e1e1d0;
}
.wy-table-odd td,
.wy-table-striped tr:nth-child(odd):hover td,
.rst-content table.docutils:not(.field-list) tr:nth-child(odd):hover td {
background-color: #f2d8bb
background-color: #85adad
}
.wy-table-even td,
.wy-table-striped tr:nth-child(even):hover td,
.rst-content table.docutils:not(.field-list) tr:nth-child(even):hover td {
background-color: #f2d8bb
background-color: #85adad
}
.wy-table tr,
.rst-content table.docutils th:hover{
background-color: #f2d8bb
background-color: #85adad
}
.wy-table-backed {
background-color: #f3f6f6
@@ -2091,16 +2091,16 @@ input[type="checkbox"][disabled] {
white-space: inherit
}
a {
color: #2c3fbd;
color: #0707ff;
text-decoration: none;
cursor: pointer
}
a:hover {
color: #4653a3;
color: #0707ff;
text-decoration: underline
}
a:visited {
color: #c73030
color: #8b0000
}
html {
height: 100%;
@@ -2181,7 +2181,7 @@ legend {
p {
line-height: 26px;
margin: 0;
font-size: 16px;
font-size: 100%;
margin-bottom: 24px
}
h1 {
@@ -2214,7 +2214,7 @@ hr {
code,
.rst-content tt,
.rst-content code {
white-space: nowrap;
/*white-space: nowrap;
max-width: 100%;
background: #fff;
border: solid 1px #e1e4e5;
@@ -2222,7 +2222,7 @@ code,
padding: 0 5px;
font-family: Consolas, "Andale Mono WT", "Andale Mono", "Lucida Console", "Lucida Sans Typewriter", "DejaVu Sans Mono", "Bitstream Vera Sans Mono", "Liberation Mono", "Nimbus Mono L", Monaco, "Courier New", Courier, monospace;
color: #E74C3C;
overflow-x: auto
overflow-x: auto*/
}
code.code-large,
.rst-content tt.code-large {
@@ -2363,8 +2363,8 @@ div[class^='highlight'] pre {
white-space: pre;
margin: 0;
padding: 10px 10px;
font-family: Consolas, "Andale Mono WT", "Andale Mono", "Lucida Console", "Lucida Sans Typewriter", "DejaVu Sans Mono", "Bitstream Vera Sans Mono", "Liberation Mono", "Nimbus Mono L", Monaco, "Courier New", Courier, monospace;
font-size: 12px;
font-family: 'Inconsolata', monospace;
font-size: 100%;
line-height: 1.5;
display: block;
overflow: auto;
@@ -2869,7 +2869,6 @@ filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#730000', end
}
.wy-side-nav-search input[type=text] {
width: 90%;
border-radius: 50px;
padding: 6px 12px;
border-color: #2472a4
}
@@ -3699,7 +3698,7 @@ code.menuselection,
background-color: #e6ede9; /* saturate from ecf0f3 to be more visible/blue on screen. */
display: inline;
font-family:'Inconsolata', monospace;
font-size: 95%;
font-size: 100%;
padding-right: 1px;
padding-left: 1px;
padding-top: 1px;
@@ -3724,7 +3723,12 @@ code.menuselection, .menuselection {
background-color: #e8ede6;
color: inherit;
border: hidden;
font-size: 98%
font-size: 100%
}
code.samp, .samp {
font-family: 'Inconsolata', monospace;
font-weight: bold;
font-size: 100%;
}
code.command, .command {
font-family:'Inconsolata', monospace;
@@ -3808,9 +3812,9 @@ th.spiffy_span {
}
.docutils th,
.spiffy_table th {
background-color: #bbeaf2;
background-color: #6699cc;
font-weight: 700;
text-align: center;
text-align: left;
border-color: darkgray;
border-style: solid;
border-width: 1px 1px 2px;

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

1317
docs/client_handbook/TrueOS Handbook port/trueos_sysadmclient_section.txt
View File

File diff suppressed because it is too large Load Diff

40
docs/client_handbook/_static/trueos_style/static/css/trueos_style.css
View File

@@ -1957,7 +1957,7 @@ input[type="checkbox"][disabled] {
.wy-table th,
.rst-content table.docutils th,
.rst-content table.field-list th {
font-size: 90%;
font-size: 100%;
margin: 0;
overflow: visible;
padding: 8px 16px;
@@ -2026,21 +2026,21 @@ input[type="checkbox"][disabled] {
.wy-table-odd td,
.wy-table-striped tr:nth-child(odd) td,
.rst-content table.docutils:not(.field-list) tr:nth-child(odd) td {
background-color: #f3f6f6;
background-color: #e1e1d0;
}
.wy-table-odd td,
.wy-table-striped tr:nth-child(odd):hover td,
.rst-content table.docutils:not(.field-list) tr:nth-child(odd):hover td {
background-color: #f2d8bb
background-color: #85adad
}
.wy-table-even td,
.wy-table-striped tr:nth-child(even):hover td,
.rst-content table.docutils:not(.field-list) tr:nth-child(even):hover td {
background-color: #f2d8bb
background-color: #85adad
}
.wy-table tr,
.rst-content table.docutils th:hover{
background-color: #f2d8bb
background-color: #85adad
}
.wy-table-backed {
background-color: #f3f6f6
@@ -2091,16 +2091,16 @@ input[type="checkbox"][disabled] {
white-space: inherit
}
a {
color: #2c3fbd;
color: #0707ff;
text-decoration: none;
cursor: pointer
}
a:hover {
color: #4653a3;
color: #0707ff;
text-decoration: underline
}
a:visited {
color: #c73030
color: #8b0000
}
html {
height: 100%;
@@ -2181,7 +2181,7 @@ legend {
p {
line-height: 26px;
margin: 0;
font-size: 16px;
font-size: 100%;
margin-bottom: 24px
}
h1 {
@@ -2214,7 +2214,7 @@ hr {
code,
.rst-content tt,
.rst-content code {
white-space: nowrap;
/*white-space: nowrap;
max-width: 100%;
background: #fff;
border: solid 1px #e1e4e5;
@@ -2222,7 +2222,7 @@ code,
padding: 0 5px;
font-family: Consolas, "Andale Mono WT", "Andale Mono", "Lucida Console", "Lucida Sans Typewriter", "DejaVu Sans Mono", "Bitstream Vera Sans Mono", "Liberation Mono", "Nimbus Mono L", Monaco, "Courier New", Courier, monospace;
color: #E74C3C;
overflow-x: auto
overflow-x: auto*/
}
code.code-large,
.rst-content tt.code-large {
@@ -2363,8 +2363,8 @@ div[class^='highlight'] pre {
white-space: pre;
margin: 0;
padding: 10px 10px;
font-family: Consolas, "Andale Mono WT", "Andale Mono", "Lucida Console", "Lucida Sans Typewriter", "DejaVu Sans Mono", "Bitstream Vera Sans Mono", "Liberation Mono", "Nimbus Mono L", Monaco, "Courier New", Courier, monospace;
font-size: 12px;
font-family: 'Inconsolata', monospace;
font-size: 100%;
line-height: 1.5;
display: block;
overflow: auto;
@@ -2869,7 +2869,6 @@ filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#730000', end
}
.wy-side-nav-search input[type=text] {
width: 90%;
border-radius: 50px;
padding: 6px 12px;
border-color: #2472a4
}
@@ -3699,7 +3698,7 @@ code.menuselection,
background-color: #e6ede9; /* saturate from ecf0f3 to be more visible/blue on screen. */
display: inline;
font-family:'Inconsolata', monospace;
font-size: 95%;
font-size: 100%;
padding-right: 1px;
padding-left: 1px;
padding-top: 1px;
@@ -3724,7 +3723,12 @@ code.menuselection, .menuselection {
background-color: #e8ede6;
color: inherit;
border: hidden;
font-size: 98%
font-size: 100%
}
code.samp, .samp {
font-family: 'Inconsolata', monospace;
font-weight: bold;
font-size: 100%;
}
code.command, .command {
font-family:'Inconsolata', monospace;
@@ -3808,9 +3812,9 @@ th.spiffy_span {
}
.docutils th,
.spiffy_table th {
background-color: #bbeaf2;
background-color: #6699cc;
font-weight: 700;
text-align: center;
text-align: left;
border-color: darkgray;
border-style: solid;
border-width: 1px 1px 2px;

14
docs/client_handbook/conf.py
View File

@@ -122,13 +122,13 @@ todo_include_todos = True
#Option to add text substitutions to all .rst files being built.
rst_prolog = """
.. |freenas| replace:: FreeNAS"""u'\u00AE'"""
.. |truenas| replace:: TrueNAS"""u'\u00AE'"""
.. |pcbsd| replace:: PC-BSD"""u'\u00AE'"""
.. |trueos| replace:: TrueOS"""u'\u00AE'"""
.. |appcafe| replace:: AppCafe"""u'\u00AE'"""
.. |lumina| replace:: Lumina"""u'\u00AE'"""
.. |sysadm| replace:: SysAdm"""u'\u2122'"""
.. |freenas| replace:: FreeNAS\ :sup:`"""u'\u00AE'"""`
.. |truenas| replace:: TrueNAS\ :sup:`"""u'\u00AE'"""`
.. |pcbsd| replace:: PC-BSD\ :sup:`"""u'\u00AE'"""`
.. |trueos| replace:: TrueOS\ :sup:`"""u'\u00AE'"""`
.. |appcafe| replace:: AppCafe\ :sup:`"""u'\u00AE'"""`
.. |lumina| replace:: Lumina\ :sup:`"""u'\u00AE'"""`
.. |sysadm| replace:: SysAdm\ :sup:`"""u'\u2122'"""`
"""
# -- Option to change :menuselection: arrow -----------------------------

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

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 26 KiB

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

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 2.6 KiB

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

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 438 KiB

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/images/upgrade1a.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 28 KiB

BIN
docs/client_handbook/images/user5.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.

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

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

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

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

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

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

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

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

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

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

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

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

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

File diff suppressed because it is too large Load Diff

569
docs/client_handbook/sysadmclient.rst
View File

File diff suppressed because it is too large Load Diff

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

14
docs/server_handbook/conf.py
View File

@@ -88,13 +88,13 @@ pygments_style = 'sphinx'
#Option to add text substitutions to all .rst files being built.
rst_prolog = """
.. |freenas| replace:: FreeNAS"""u'\u00AE'"""
.. |truenas| replace:: TrueNAS"""u'\u00AE'"""
.. |pcbsd| replace:: PC-BSD"""u'\u00AE'"""
.. |trueos| replace:: TrueOS"""u'\u00AE'"""
.. |appcafe| replace:: AppCafe"""u'\u00AE'"""
.. |lumina| replace:: Lumina"""u'\u00AE'"""
.. |sysadm| replace:: SysAdm"""u'\u2122'"""
.. |freenas| replace:: FreeNAS\ :sup:`"""u'\u00AE'"""`
.. |truenas| replace:: TrueNAS\ :sup:`"""u'\u00AE'"""`
.. |pcbsd| replace:: PC-BSD\ :sup:`"""u'\u00AE'"""`
.. |trueos| replace:: TrueOS\ :sup:`"""u'\u00AE'"""`
.. |appcafe| replace:: AppCafe\ :sup:`"""u'\u00AE'"""`
.. |lumina| replace:: Lumina\ :sup:`"""u'\u00AE'"""`
.. |sysadm| replace:: SysAdm\ :sup:`"""u'\u2122'"""`
"""
# -- Option to change :menuselection: arrow -----------------------------

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 ""

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