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

Update Client Handbook:

Browse Source 
- Port over sysadm.rst from trueos-docs; maintain parity
- Add new images to fix build errors
- Remove obsolete directory "TrueOS Handbook port"
This commit is contained in:
Mrt134
2016-10-11 15:19:30 -04:00
parent e2ae246e15
commit 691d901856
4 changed files with 89 additions and 1438 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

File diff suppressed because it is too large Load Diff

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

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 2.6 KiB

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

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 28 KiB

210
docs/client_handbook/sysadmclient.rst
View File

@@ -80,7 +80,7 @@ available software.
.. figure:: images/appcafe1.png
Browse Tab of AppCafe®
: Browse Tab of AppCafe®
This screen contains the following options:
@@ -112,12 +112,11 @@ Displayed applications will be listed in alphabetical order.
Applications which are already installed and which are not required by
other applications have a trashcan icon which can be clicked to
uninstall that application. Applications which are not installed have a
down arrow icon which can be clicked to install that application.
down arrow icon which can be clicked to install that application.
Click the name of an application to view more information about that
application. In the example shown in
:numref:`Figure %s <appcafe2>`,
the user has clicked :guilabel:`Firefox` on a system that has Firefox
Click the name of an application to view more information about the
application. In the example shown in :numref:`Figure %s <appcafe2>`, the
user has clicked :guilabel:`Firefox` on a system that has Firefox
installed.
.. note:: |appcafe| provides a graphical front-end for displaying the
@@ -132,7 +131,7 @@ installed.
.. figure:: images/appcafe2.png
AppCafe®: Viewing the Details of an Installed Application
:AppCafe® - Viewing the Details of an Installed Application
As seen in this example, the information for an application includes
the application's icon, name, and description. Click the application's
@@ -152,7 +151,7 @@ An example of the "?" tab is shown in
.. figure:: images/appcafe3.png
AppCafe®: More Application Details
: AppCafe® - More Application Details
This tab displays a variety of information:
@@ -180,7 +179,7 @@ screenshots. An example is shown in
.. figure:: images/appcafe4.png
AppCafe®: Viewing the Application's Screenshots
: AppCafe® - Viewing the Application's Screenshots
An example of the last tab, which has a list icon, is shown in
:numref:`Figure %s <appcafe5>`.
@@ -189,7 +188,7 @@ An example of the last tab, which has a list icon, is shown in
.. figure:: images/appcafe5.png
AppCafe®: Viewing the Details of an Installed Application
: AppCafe® - Viewing the Details of an Installed Application
This tab contains the following information. Click the right arrow next
to an entry to expand its information and the down arrow to collapse
@@ -218,7 +217,7 @@ click the :guilabel:`Installed` tab. An example is seen in
.. figure:: images/appcafe6.png
AppCafe®: Installed Tab
: AppCafe® - Installed Tab
This screen offers several actions:
@@ -270,7 +269,7 @@ has been locked, and :guilabel:`alsa-plugins` is an orphan (flag icon).
.. figure:: images/appcafe7.png
AppCafe®: Viewing Applications With All Options Checked
: AppCafe® - Viewing Applications With All Options Checked
If you install or uninstall any software, click the :guilabel:`Pending`
tab to view the details of the operation. In the example shown in
@@ -284,7 +283,7 @@ operation.
.. figure:: images/appcafe8.png
AppCafe®: Viewing the Status of the Operation
: AppCafe® - Viewing the Status of the Operation
.. index:: updates
.. _Update Manager:
@@ -352,7 +351,7 @@ An example of the :guilabel:`Updates` tab is shown in
.. figure:: images/update1.png
Managing Updates
: Managing Updates
In this example, updates are available for installed packages. If a
security update is available, it will be listed as such. Apply the
@@ -377,19 +376,6 @@ The :guilabel:`Latest Check` field indicates the date and time the
system last checked for updates. To manually check for updates, click
:guilabel:`Check for Updates`.
The :guilabel:`Branches` tab of Update Manager provides a listing of
available branches. In the example shown in
:numref:`Figure %s <update3>`, this system is currently running the 10.2
branch and the upcoming 11.0 branch is available for selection.
.. TODO update3.png needs to be added to images file.
.. _update3:
.. figure:: images/update3.png
Switching Branches
The :guilabel:`Settings` tab is shown in
:numref:`Figure %s <update4>`.
@@ -397,7 +383,7 @@ The :guilabel:`Settings` tab is shown in
.. figure:: images/update4.png
Settings Tab
: Settings Tab
This tab contains several configurable options:
@@ -464,7 +450,7 @@ to view the pop-up screen shown in :numref:`Figure %s <upgrade1a>`.
.. figure:: images/upgrade1a.png
Install to Boot Environment
: Install to Boot Environment
To upgrade, select the existing pool to install into and press
:guilabel:`OK`.
@@ -482,7 +468,7 @@ and instead show a summary, seen in
.. figure:: images/upgrade2.png
Start the Install to Boot Environment
: Start the Install to Boot Environment
Press :guilabel:`Next` to start the installation. Once the installation
is complete, reboot the system and remove the installation media. The
@@ -530,16 +516,15 @@ boot environment. Other examples of using boot environments include:
* Move a boot environment to another machine, physical or virtual, in
order to check hardware support.
.. note:: For boot environments to work properly,
**do not delete the default ZFS mount points during installation.**
The default ZFS layout ensures when boot environments are created,
the :file:`/usr/local/`, :file:`/usr/home/`,
:file:`/usr/ports/`, :file:`/usr/src/` and :file:`/var/` directories
remain untouched. This way, if you rollback to a previous boot
environment, you will not lose data in your home directories, any
installed applications, or downloaded source files or ports. During
installation, you can add additional mount points, just don't delete
the default ones.
.. note:: For boot environments to work properly, **do not** delete the
default ZFS mount points during installation. The default ZFS layout
ensures when boot environments are created, the :file:`/usr/local/`,
:file:`/usr/home/`, :file:`/usr/ports/`, :file:`/usr/src/` and
:file:`/var/` directories remain untouched. This way, if you rollback
to a previous boot environment, you will not lose data in your home
directories, any installed applications, or downloaded source files
or ports. During installation, you can add additional mount points,
just don't delete the default ones.
To ensure the files the operating system needs are included when the
system boots, all boot environments on a |trueos| system include
@@ -559,7 +544,7 @@ example shown in :numref:`Figure %s <be1>`, there is an entry named
.. figure:: images/be1.png
Managing Boot Environments
: Managing Boot Environments
Each entry contains the same information:
@@ -609,32 +594,30 @@ are browseable. Note this setting only applies to inactive BEs.
environment next system boot. This will change the :guilabel:`Active`
column to *R*.
.. TODO Add/update screenshot install1b - copy/paste commented note to
correct place in text.
.. _install1b
.. _install1b(1):
.. figure:: images/install1b.png
.. figure:: images/install1b.png
TrueOS® Boot Menu
: TrueOS® Boot Menu
To boot into another boot environment, press :kbd:`7` at the
:numref:`Figure %s: TrueOS® Boot Menu <install1b>` to access the boot
menu selection screen. In the example shown in
:numref:`Figure %s <be2>`, two boot environments are available in the
"Boot Environments" section: the entry named "initial" represents the
initial installation and the entry named "mybootenvironment" was
manually created using Boot Environment Manager. The upper section of
this menu indicates the "initial" boot environment is set to active, or
the one the system has been configured to boot into unless another BE is
manually selected in this menu. Use the arrow keys to highlight the boot
environment you would like to boot into, and press :kbd:`Enter` to
continue booting into the selected boot environment.
:numref:`Figure %s <install1b(1)>` to access the boot menu selection
screen. In the example shown in :numref:`Figure %s <be2>`, two boot
environments are available in :guilabel:`Boot Environments`:
:guilabel:`initial` represents the initial installation and
:guilabel:`mybootenvironment` was manually created using Boot
Environment Manager. The upper section of this menu indicates the
"initial" boot environment is set to active, or the one the system has
been configured to boot into unless another BE is manually selected in
this menu. Use the arrow keys to highlight the boot environment you
would like to boot into, and press :kbd:`Enter` to continue booting into
the selected boot environment.
.. _be2:
.. figure:: images/be2.png
Boot Environments Menu
: Boot Environments Menu
.. index:: sysadm, configuration
.. _Firewall Manager:
@@ -650,7 +633,7 @@ is active and using port 5353 is open, with the firewall started.
.. figure:: images/firewall1.png
|sysadm| Firewall Manager
: |sysadm| Firewall Manager
The top row of the interface has options to configure the firewall.
:guilabel:`Start` turns on the firewall, :guilabel:`Restart` will turn
@@ -705,7 +688,7 @@ several options to configure these services.
.. figure:: images/service1.png
SysAdm™ Service Manager
: SysAdm™ Service Manager
Services are listed in a chart with four columns:
@@ -749,7 +732,7 @@ a listing of currently running applications. An example is shown in
.. figure:: images/task1.png
SysAdm™ Task Manager
: SysAdm™ Task Manager
The "Running Programs:" section provides a graphical front-end to
`top(1) <https://www.freebsd.org/cgi/man.cgi?query=top>`_.
@@ -775,7 +758,7 @@ installation.
.. figure:: images/user1.png
Viewing User Accounts in User Manager
: Viewing User Accounts in User Manager
The :guilabel:`Standard` view allows you to configure the following:
@@ -811,7 +794,7 @@ clicking :guilabel:`New User`.
.. figure:: images/user2.png
Creating a New User Account
: Creating a New User Account
Fields outlined in red are required when creating a user. The
:guilabel:`User Name`, :guilabel:`Full Name`, and :guilabel:`Password`
@@ -864,7 +847,7 @@ system, not just the user accounts you created. An example is seen in
.. figure:: images/user3.png
Viewing All Accounts and Their Details
: Viewing All Accounts and Their Details
The accounts you did not create are known as system accounts and are
needed by the operating system or installed applications. Do **not**
@@ -914,19 +897,17 @@ logged in user. In the example shown in
:numref:`Figure %s <user5>`, a new user, named *dlavigne*, has been
created and the entry for the user has been clicked.
.. TODO Add user5.png to images folder.
.. _user5:
.. figure:: images/user5.png
Initialize PersonaCrypt Device
: Initialize PersonaCrypt Device
Before a user is configured to use PersonaCrypt on a |trueos| system,
two buttons are available in the "PersonaCrypt" section of "Advanced
Mode". Note this section is hidden if the currently logged in user is
selected. Also, if you have just created a user and do not see these
options, click :guilabel:`Apply` then re-highlight the user to display
options, click :guilabel:`Save` then re-highlight the user to display
these options:
* **Initialize Device:** Used to prepare the USB device which will be
@@ -938,9 +919,7 @@ these options:
imported, the user can now login to this computer using PersonaCrypt.
To prepare a PersonaCrypt device for this user, insert a USB stick and
click :guilabel:`Initialize Device`. A pop-up menu will indicate the
current contents of the device will be wiped and the device must be
larger than the user's current home directory.
click :guilabel:`Initialize Device`.
.. warning:: Since the USB stick will hold the user's home directory and
files, ensure the stick is large enough to meet the anticipated
@@ -949,40 +928,41 @@ larger than the user's current home directory.
data on the stick you need has been copied elsewhere. Also, the
faster the stick, the better the user experience while logged in.
Press :guilabel:`OK` in the pop-up menu. This will prompt you to input
and confirm the password to associate with the device. Another message
will ask if you are ready. Click :guilabel:`Yes` to initialize the
device. The User Manager screen will be greyed out while the device is
prepared. Once the initialization is complete, the User Manager screen
will change to display the device's key options, as seen in
:numref:`Figure %s <user6>`.
Type a password to associate with the device. Click :guilabel:`Save` to
initialize the device. The User Manager may take a moment to prepare the
device. Once initialization is complete, the User Manager screen
will change to allow removal of PersonaCrypt.
.. TODO Add user6.png to images folder.
.. Leave this commented as the current development may use some of these
options from the old personacrypt initializer.
display the device's key options, as seen in
:numref:`Figure %s <user6>`.
.. _user6:
.. _user6:
.. figure:: images/user6.png
.. figure:: images/user6.png
PersonaCrypt Key Options
Several options are now available:
Several options are now available:
* **Export Key:** Used to create a copy of the encryption key so it can
be imported for use on another |trueos| system.
* **Export Key:** Used to create a copy of the encryption key so it can
be imported for use on another |trueos| system.
* **Disable Key (No Data):** Used to uninitialize the PersonaCrypt
device on this system. Note the device can still be used to login to
other |trueos| systems.
* **Disable Key (No Data):** Used to uninitialize the PersonaCrypt
device on this system. Note the device can still be used to login to
other |trueos| systems.
* **Disable Key (Import Data):** In addition to uninitializing the
PersonaCrypt device on this system, copy the contents of the user's
home directory to this system.
* **Disable Key (Import Data):** In addition to uninitializing the
PersonaCrypt device on this system, copy the contents of the user's
home directory to this system.
Once a user has been initialized for PersonaCrypt on the system, their
user account will no longer be displayed when logging in, **unless**
their PersonaCrypt device is inserted. Once the USB device is inserted,
the login screen will add an extra field, as seen in the example shown
in Figure 4.8b.
in :ref:`login5`.
.. note:: When stealth sessions have been configured, PersonaCrypt
users will still be displayed in the login menu, even if their USB
@@ -1008,11 +988,11 @@ system. The :guilabel:`Standard` tab, seen in
:numref:`Figure %s <user4>`, shows the group membership for the
*operator* and *wheel* groups:
.. _user4:
.. _user4:
.. figure:: images/user4.png
Managing Groups Using User Manager
: Managing Groups Using User Manager
This screen has 2 columns:
@@ -1095,7 +1075,7 @@ a system not yet configured. This system has a "ZFS Pool" named "tank".
.. figure:: images/lpreserver1.png
Snapshot Tab
: Snapshot Tab
This screen will display any created snapshots and provides buttons to:
@@ -1169,7 +1149,7 @@ configure the replication schedule.
.. figure:: images/lpreserver2.png
Replication Tab
: Replication Tab
To schedule the replication, click :guilabel:`+` to display the
"Setup Replication" screen shown in
@@ -1179,7 +1159,7 @@ To schedule the replication, click :guilabel:`+` to display the
.. figure:: images/lpreserver3.png
Scheduling a Replication
: Scheduling a Replication
Input the following information:
@@ -1253,7 +1233,7 @@ Schedule" pane as seen in :numref:`Figure %s <lpreserver4>`.
.. figure:: images/lpreserver4.png
Scheduling a Snapshot
: Scheduling a Snapshot
This pane contains several options:
@@ -1293,7 +1273,7 @@ which will activate the "Setup Scrub Schedule" screen shown in
.. figure:: images/lpreserver5.png
Scheduling a Scrub
: Scheduling a Scrub
Select the pool from the :guilabel:`Storage Pool` drop-down menu, then
select the :guilabel:`Frequency`. Supported frequencies are "Daily",
@@ -1320,7 +1300,7 @@ The :guilabel:`Settings` tab is shown in
.. figure:: images/lpreserver6.png
Life Preserver Settings
: Life Preserver Settings
Many settings are configurable:
@@ -1427,10 +1407,10 @@ the :command:`lpreserver cronsnap` command, type:
listexclude <dataset>
List which datasets are excluded from schedule snapshots.
:numref:`Table %s <table_1>` shows the command line equivalents to the
:numref:`Table %s <cmdgui>` shows the command line equivalents to the
graphical options provided by the Life Preserver GUI.
.. _table_1:
.. _cmdgui:
.. table:: Command Line and GUI Equivalents
@@ -1480,7 +1460,7 @@ installation as usual until you get to the screen shown in
.. figure:: images/restore1.png
Selecting to Restore/Clone From Backup
: Selecting to Restore/Clone From Backup
Before you can perform a restore, the network interface must be
configured. Click :guilabel:`Network Connectivity` (second icon from the
@@ -1502,33 +1482,21 @@ a non-standard SSH port, change the "SSH port" number.
.. figure:: images/restore2.png
Input the Information for a SSH Restore
: Input the Information for a SSH Restore
Click :guilabel:`Next` and the wizard will provide a summary of your
selections. If correct, click :guilabel:`Finish`; otherwise, click
:guilabel:`Back` to correct them.
Once the connection to the backup server succeeds, you will be able to
select which host to restore. In the example shown in
:numref:`Figure %s <restore4>`, only one host has been backed up to the
replication server.
.. TODO Add restore4.png to images folder.
.. _restore4:
.. figure:: images/restore4.png
Select the Host to Restore
After making your selection, click :guilabel:`Next`. The restore wizard
will provide a summary of which host it will restore from, the name of
the user account associated with the replication, and the hostname of
the target system. Click :guilabel:`Finish` and the installer will
proceed to the
select which host to restore. After making your selection, click
:guilabel:`Next`. The restore wizard will provide a summary of which
host it will restore from, the name of the user account associated with
the replication, and the hostname of the target system. Click
:guilabel:`Finish` and the installer will proceed to the
`Disk Selection Screen <https://www.trueos.org/handbook/install.html#disk-selection-screen>`_.
At this point, you can click the :guilabel:`Customize` button to
customize the disk options. However, in the screen shown in Figure 3.3h,
the ZFS datasets will be greyed out as they will be recreated from the
backup during the restore. Once you are finished with any
customizations, click :guilabel:`Next` to perform the restore.
customizations, click :guilabel:`Next` to perform the restore.