Add i18n stuff for sysadm handbooks

This commit is contained in:
Kris Moore
2016-09-16 13:42:13 -04:00
parent 2de60fc3df
commit 2380a15a3d
159 changed files with 30610 additions and 87 deletions

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

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

Binary file not shown.

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

Binary file not shown.

File diff suppressed because it is too large Load Diff

Binary file not shown.

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

Binary file not shown.

File diff suppressed because it is too large Load Diff

Binary file not shown.

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

Binary file not shown.

File diff suppressed because it is too large Load Diff

Binary file not shown.

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

Binary file not shown.

File diff suppressed because it is too large Load Diff

Binary file not shown.

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

Binary file not shown.

File diff suppressed because it is too large Load Diff

Binary file not shown.

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

Binary file not shown.

File diff suppressed because it is too large Load Diff

Binary file not shown.

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

Binary file not shown.

File diff suppressed because it is too large Load Diff

Binary file not shown.

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

Binary file not shown.

File diff suppressed because it is too large Load Diff

Binary file not shown.

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

File diff suppressed because it is too large Load Diff

Binary file not shown.

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

Binary file not shown.

File diff suppressed because it is too large Load Diff

Binary file not shown.

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

Binary file not shown.

File diff suppressed because it is too large Load Diff

Binary file not shown.

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

File diff suppressed because it is too large Load Diff

Binary file not shown.

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

File diff suppressed because it is too large Load Diff

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

Binary file not shown.

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

Binary file not shown.

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

Binary file not shown.

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

Binary file not shown.

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

Binary file not shown.

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

Binary file not shown.

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

Binary file not shown.

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

Binary file not shown.

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

Binary file not shown.

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

Binary file not shown.

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

Binary file not shown.

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

Binary file not shown.

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

Binary file not shown.

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

Binary file not shown.

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

Binary file not shown.

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

Binary file not shown.

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

Binary file not shown.

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

Binary file not shown.

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

Binary file not shown.

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

Binary file not shown.

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

Binary file not shown.

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

Binary file not shown.

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

Binary file not shown.

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