diff --git a/docs/client_handbook/TrueOS Handbook port/trueos_sysadmclient_section.txt b/docs/client_handbook/TrueOS Handbook port/trueos_sysadmclient_section.txt deleted file mode 100644 index fc42714..0000000 --- a/docs/client_handbook/TrueOS Handbook port/trueos_sysadmclient_section.txt +++ /dev/null @@ -1,1317 +0,0 @@ -.. index:: configuration -.. _SysAdm Client: - -SysAdm™ Client -************** - -Beginning with |trueos| 11, most of the system management utilities that -were previously available in the |pcbsd| Control Panel have been -rewritten to use the |sysadm| API. This API is designed to make it easy -to manage any FreeBSD or |trueos| desktop or server system over a secure -connection from any operating system that has the |sysadm| application -installed. |sysadm| is built into |trueos|, but downloadable packages -for other operating systems are available from the -`SysAdm Website `_. - -.. note:: By default, |sysadm| does not allow for remote access to the - system. Please review the |sysadm| server handbook for instructions - on initializing the remote access elements of |sysadm|. - -A number of utilities have been removed from Control Panel as they are -now available in the |sysadm| client: - -**Application Management** - -* :ref:`AppCafe®` - -* :ref:`Update Manager` - -**SysAdm Server Settings** - -* :ref:`Manage SSL Keys` - -**System Management** - -* :ref:`Boot Environment Manager` - -* :ref:`Task Manager` - -* :ref:`User Manager` - -**Utilities** - -* :ref:`Life Preserver` - -The rest of this client guide provides an overview of the |sysadm| -client and all of its functionality, beginning with |appcafe|. - -.. note:: Instructions for using the API in your own scripts can be - found in the `SysAdm™ API Reference Guide `_. - -.. index:: software, configuration, sysadm -.. _AppCafe: - -AppCafe® -======== - -|appcafe| provides a graphical interface for installing and managing -FreeBSD packages, which are pre-built applications that have been tested -for FreeBSD-based operating systems. This interface displays extra -meta-data, such as application screenshots and lists of similar -applications. - -The rest of this section describes how to manage software using |appcafe|. - -.. index:: AppCafe® -.. _Software Management: - -Finding Software ----------------- - -The "Browse" tab, shown in -:numref:`Figure %s: Browse Tab of AppCafe® `, is used to find -available software. - -.. _appcafe1: - -.. figure:: images/appcafe1.png - -This screen contains the following options: - -**Back:** click this button to leave a category or search result and -return to the previous screen. - -**Repository drop-down menu:** use this drop-down menu to select the -repository to search or browse. The selections include: "major" -(applications available for installation), "base" (applications that -are part of the base operating system), and "local" (all installed -applications). - -**Search:** to see if an application is available, enter its name and -click the "binoculars" icon. Alternately, enter a description. For -example, a search for "browser" will display software with "browser" -in the name as well as applications which provide browser -functionality, such as Firefox. - -**Browse Categories:** this drop-down menu lists the available software -categories. If you select a category, it will only display or show -search results from that category. - -**Popular Searches and Popular Categories:** the buttons in these -sections can be used to quickly find applications which are recommended -by other |trueos| users. Click a button to get a curated list of -applications that match the button's description. - -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. - -Click the name of an application to view more information about that -application. In the example shown in -:numref:`Figure %s: Viewing the Details of an Installed Application `, -the user has clicked :guilabel:`Firefox` on a system that has Firefox -installed. - -.. note:: |appcafe| provides a graphical front-end for displaying the - contents of the package database. Since installed applications - provide more information to the package database, some fields will - be empty, depending upon the selected repository. For example, the - package message will only be displayed when the "local" repository - is selected, the package is actually installed, and the package - provides a message during installation. - -.. _appcafe2: - -.. figure:: images/appcafe2.png - -As seen in this example, the information for an application includes -the application's icon, name, and description. Click the application's -name to open the website for the application in the default web -browser. If the application is installed, there will be an -:guilabel:`Uninstall` button. - -Beneath this area are 4 tabs. The first tab on the left contains two -panes. The first (middle) pane displays the package description. The -second (bottom) pane displays the message that appears when the -package is installed. - -An example of the "?" tab is shown in -:numref:`Figure %s: More Application Details ` - -.. _appcafe3: - -.. figure:: images/appcafe3.png - -This tab displays a variety of information: - -* Software version. - -* Email address for the maintainer of the FreeBSD port the package is - built from. - -* The application's architecture. This will indicate the FreeBSD version - and whether or not the application is 32-bit or 64-bit. Note |trueos| - can run both 32 and 64-bit applications. - -* The application's license. - -* The application's installation size. - -* The application's download size. - -If the package includes screenshots of the application, you can click -the next tab, which has an image icon, to view and scroll through the -screenshots. An example is shown in -:numref:`Figure %s: Viewing the Application's Screenshots ` - -.. _appcafe4: - -.. figure:: images/appcafe4.png - -An example of the last tab, which has a list icon, is shown in -:numref:`Figure %s: Viewing the Details of an Installed Application `. - -.. _appcafe5: - -.. figure:: images/appcafe5.png - -This tab contains the following information. Click the right arrow next -to an entry to expand its information and the down arrow to collapse -the information. - -* **Build Options:** shows the values of the make options that the - package was built with. - -* **Dependencies:** lists the dependent packages that this - application requires to be installed. - -* **Required By:** indicates the names of any other packages that - require this software to be installed. - -* **Shared Libraries (Required):** lists the names of the libraries - that this application requires. - -Managing Installed Software ---------------------------- - -To view and manage the applications which are installed on the system, -click the :guilabel:`Installed` tab. An example is seen in -:numref:`Figure %s: Installed Tab of AppCafe® `. - -.. _appcafe6: - -.. figure:: images/appcafe6.png - -This screen offers several actions: - -* **All:** check this box to select all installed applications or - uncheck it to deselect all installed applications. - -* **Uninstall:** click the garbage can icon to uninstall the selected - applications. - -* **Clean:** this operation deletes any orphaned packages for the - selected applications. An orphaned package is one that is not - required by any other applications. It will have a black flag icon - (the same as the :guilabel:`Clean` icon) in its :guilabel:`Status` - column. - -This screen also provides an :guilabel:`Options` drop-down menu which -allows you to select or deselect a number of options: - -* **View All Packages:** by default, the installed tab only shows the - packages you installed. Check this box to also see the packages - included with the operating system. Packages which have a black banner - icon under their :guilabel:`Status` column have dependent packages. - This means if you delete a package with a black banner, you will - also delete their dependent packages so you are not left with orphaned - packages. - -* **View Advanced Options:** if you check this box, two extra icons, a - lock and an unlock icon, will be added to the right of the trash - icon. If you select an application and click the lock icon, a lock - lock icon will be added to its :guilabel:`Status` column. As long as - an application is locked, it will not be updated by - :ref:`Update Manager`. This is useful if you need to remain with a - certain version of an application. In order to upgrade an - application, you will need to first select it and click the unlock - icon. - -* **Auto-clean packages:** if you check this box, the :guilabel:`Clean` - icon will disappear as you no longer need to manually clean orphans. - Instead, whenever you uninstall an application, any orphans will also - automatically uninstall. - -In the example shown in -:numref:`Figure %s: Viewing Applications With All Options Checked `, -the user has checked all available options. In this example, -:guilabel:`aalib` has dependencies (banner icon), :guilabel:`alsa-lib` -has been locked, and :guilabel:`alsa-plugins` is an orphan (flag icon). - -.. _appcafe7: - -.. figure:: images/appcafe7.png - -If you install or uninstall any software, click the :guilabel:`Pending` -tab to view the details of the operation. In the example shown in -:numref:`Figure %s: Viewing the Status of the Operation `, -this system has had a package install and a package locking operation, -and each has a dated entry in the process log. Highlight an entry and -check the :guilabel:`View Process Log` box to review the log for the -operation. - -.. _appcafe8: - -.. figure:: images/appcafe8.png - -.. index:: updates -.. _Update Manager: - -Update Manager -============== - -Update Manager provides a graphical interface for keeping the |trueos| -operating system and its installed applications up-to-date. - -The |trueos| update mechanism provides several safeguards to ensure -updating the operating system or its software is a low-risk operation. -The following steps occur automatically during an update: - -* The update automatically creates a snapshot (copy) of the current - operating system, known as a boot environment (BE), and mounts the - snapshot in the background. All of the updates then occur in the - snapshot. This means you can safely continue to use your system while - it is updating, as no changes are being made to the running version of - the operating system or any of the applications currently in use. - Instead, all changes are being made to the mounted copy. - -.. note:: If the system is getting low on disk space and there is not - enough space to create a new BE, the update will fail with a message - indicating there is not enough space to perform the update. - -* While the update is occurring, and until you reboot after the update, - you will be unable to use |appcafe| to manage software. This is a - safety measure to prevent package conflicts. Also, the system shutdown - and restart buttons will be greyed out until the update is complete - and the system is ready to reboot. Should a power failure occur in the - middle of an update, the system will reboot into the current boot - environment, returning the system to the point before the upgrade - started. Simply restart the update to continue the update process. - -* Once the update is complete, the new boot environment or updated - snapshot is added as the first entry in the boot menu. It is then - activated so the system will boot into it, unless you pause the boot - menu and specify otherwise. A pop-up message will indicate a reboot is - required. You can either finish what you are doing now and reboot into - the upgraded snapshot, or ask the system to remind you again later. - To configure the time of the next warning, click the - :guilabel:`Next Reminder` drop-down menu where you can select 1, 5, - 12, or 24 hours, 30 minutes, or never (for this login session). - Note the system will not apply any more updates, allow you to start - another manual update, or install additional software using |appcafe| - until you reboot. - -* The default ZFS layout used by |trueos| ensures when new 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 decide to roll back to a previous - boot environment, you will not lose data in your home directories, any - installed applications, or downloaded source files or ports. However, - you will return the system to its previous state, before the update - was applied. - -Managing Updates ----------------- - -An example of the :guilabel:`Updates` tab is shown in -:numref:`Figure %s: Managing Updates `. - -.. _update1: - -.. figure:: images/update1.png - -In this example, updates are available for installed packages. If a -security update is available, it will be listed as such. Apply the -available updates by clicking the box next to each entry you want to -update, which activates the :guilabel:`Start Updates` button. Once the -button is pressed, it will change to :guilabel:`Stop Updates` so you can -stop the update if necessary. As the selected updates are applied, the -progress of the updates will be displayed. - -.. warning:: Update Manager will update **all** installed software. If - you have placed a lock on a package using :command:`pkg` or - |appcafe|, Update Manager will fail and will generate a message - indicating the failure is due to a locked package. If an application - is locked and cannot be updated, the software will need to be - manually updated instead using :command:`pkg`. - -Once the update is complete, Update Manager will provide a message -indicating a reboot is required. When ready, save your work and manually -reboot into the new boot environment containing the applied updates. - -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: Switching Branches `, this system is -currently running the 10.2 branch and the upcoming 11.0 branch is -available for selection. - -.. _update3: - -.. figure:: images/update3.png - -The :guilabel:`Settings` tab is shown in -:numref:`Figure %s: Settings Tab `. - -.. _update4: - -.. figure:: images/update4.png - -This tab contains several configurable options: - -* **Max Boot Environments:** |trueos| automatically creates a boot - environment before updating any software, the operating system, or - applying a system update. Once the configured maximum number of boot - environments is reached, |trueos| will automatically prune (delete) - the oldest automatically created boot environment. However, it will - not delete any boot environments created manually using - :ref:`Boot Environment Manager`. The default number of boot - environments is *5*, with an allowable range from *1* to *10*. - -* **Automatically perform updates:** When checked, the automatic - updater automatically keeps your system and packages up-to-date. - You will know an update has completed when the pop-up menu indicates a - reboot is needed to complete the update process. If you uncheck this - box, an update will only occur when you choose. You are not required - to initiate updates manually. |trueos| uses an automated updater that - automatically checks for updates, no more than once per day, 20 - minutes after a reboot and then every 24 hours. - -* **Custom Package Repository:** If you have a custom package - repository, check this box. This will activate the :guilabel:`URL` - field so you can input the URL to the custom repository. - -.. index:: updates -.. _Upgrading from PC-BSD® 10.x to TrueOS®: - -Upgrading from |pcbsd| 10.x to |trueos| ---------------------------------------- - -If you are currently using |pcbsd| 10.x, the option to update to -|trueos| will not appear in the Control Panel version of Update Manager. -This is because a new installation is required in order to migrate to -|trueos|. However, the |trueos| installer allows you to keep all your -existing data and home directories, as it provides the ability to -install |trueos| into a new boot environment. In other words, the new -operating system and updated applications are installed while the ZFS -pool and any existing boot environments are preserved. Since the new -install is in a boot environment, you retain the option to boot back -into your previous |pcbsd| installation. - -.. note:: This option overwrites the contents of :file:`/etc`. If you - have any custom configurations, save them to a backup or your home - directory first. Alternately, use :ref:`Boot Environment Manager` - post-installation to mount your previous |pcbsd| boot environment to - copy over any configuration files you may forget to backup. - -To perform the installation to a new boot environment, start the -TrueOS® installation as described in :ref:`Installing TrueOS®`. In the -:ref:`System Selection Screen` select to install either a desktop or a -server. When you press "Next", the pop-up screen shown in -:numref:`Figure %s: Install to Boot Environment ` will -appear. - -.. _upgrade1: - -.. figure:: images/upgrade1.png - -To upgrade, select the existing pool to install into and press "OK". - -.. warning:: If you instead press "Cancel", the installation will - continue as usual and will reformat the disks, destroying any - existing data. - -If you press "OK" to proceed with an installation into a new boot -environment, the installer will skip the "Disk Selection" screen and -instead show a summary as seen in -:numref:`Figure %s: Start the Install to Boot Environment `. - -.. _upgrade2: - -.. figure:: images/upgrade2.png - -Press "Next" to start the installation. Once the installation is -complete, reboot the system and remove the installation media. The -post-installation screens will run as described in -:ref:`Post Installation Configuration and Installation Troubleshooting` -so that you can configure the new installation. - -.. note:: When you get to the :ref:`Create a User Screen`, recreate the - primary user account using the same name you used on your PC-BSD® - system so that TrueOS® can associate the existing home directory - with that user. Once you have logged in, you can use - :ref:`User Manager` to recreate any other user accounts or to - reassociate any PersonaCrypt accounts. - -.. index:: sysadm, configuration -.. _Manage SSL Keys: - -Manage SSL Keys -=============== - -.. index:: sysadm, boot environments, ZFS -.. _Boot Environment Manager: - -Boot Environment Manager -======================== - -TrueOS® supports a feature of ZFS known as multiple boot environments -(BEs). With multiple boot environments, the process of updating software -becomes a low-risk operation as the updates are applied to a different -boot environment. If needed, you have the option of rebooting into a -backup boot environment. Other examples of using boot environments -include: - -* If you are making software changes, you can take a snapshot of that - boot environment at any stage during the modifications. - -* You can save multiple boot environments on your system and perform - various updates on each of them as needed. You can install, test, and - update different software packages on each. - -* You can mount a boot environment in order to :command:`chroot` into - the mount point and update specific packages on the mounted - environment. - -* You can 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 that 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 src or ports. During - installation, you can add additional mount points, just don't delete - the default ones. - -To ensure that the files that the operating system needs are included -when the system boots, all boot environments on a TrueOS® system include -:file:`/usr`, :file:`/usr/local`, and :file:`/var`. User-specific data -is **not** included in the boot environment. This means that -:file:`/usr/home`, :file:`/usr/jails`, :file:`/var/log`, -:file:`/var/tmp`, and :file:`/var/audit` will not change, regardless of -which boot environment is selected at system boot. - -To view, manage, and create boot environments using the SysAdm™ -graphical client, go to -:menuselection:`System Management --> Boot Environment Manager`. In the -example shown in :numref:`Figure %s: Managing Boot Environments `, -there is an entry named *initial* that represents the original TrueOS® -installation. - -.. _be1: - -.. figure:: images/be1.png - -Each entry contains the following information: - -* **Name:** the name of the boot entry as it will appear in the boot - menu. - -* **Nickname:** a description, which can be different from the "Name". - -* **Active:** the possible values of this field are "R" (active on - reboot), "N" (active now), or "-" (inactive). In this example, the - system booted from "initial" and is set to boot from "initial" on - the next boot. - -* **Space:** the size of the boot environment. - -* **Mountpoint:** indicates whether or not the BE is mounted, and if - so, where. - -* **Date:** the date and time the BE was created. - -From left to right, the buttons on the top bar are used to: - -**Create BE:** creates a new boot environment. You should do this before -making any changes to the system that may impact on your current boot -environment. You will be prompted for a name which can only contain -letters or numbers. Once you click "OK", the system will create the -environment, then add it to the list of boot environments. - -**Clone BE:** creates a copy of the highlighted boot environment. - -**Delete BE:** deletes the highlighted boot environment. You can not -delete the boot environment which is marked as *N* or as -*R* in the "Active" column. - -**Rename BE:** renames the highlighted boot environment. The name is -what appears in the boot menu when the system boots. You cannot rename -the BE you are currently booted into. - -**Mount BE:** mounts the highlighted BE in :file:`/tmp` so that its -contents are browseable. Note that this setting only applies to inactive -BEs. - -**Unmount BE:** unmounts the previously mounted BE. - -**Activate BE:** tells the system to boot into the highlighted boot -environment at next system boot. This will change the "Active" column -to *R*. - -If you wish to boot into another boot environment, press :kbd:`7` at -the :numref:`Figure %s: TrueOS® Boot Menu ` to access the -boot menu selection screen. In the example shown in -:numref:`Figure %s: Boot Environments Menu `, 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 that 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 - -.. index:: sysadm, configuration -.. _Task Manager: - -Task Manager -============ - -Task Manager provides a graphical view of memory use, per-CPU use and -a listing of currently running applications. An example is shown in -:numref:`Figure %s: Task Manager `. - -.. _task1: - -.. figure:: images/task1.png - -The "Running Programs: section provides a graphical front-end to -`top(1) `_. - -The "Kill Selected Process" button can be used to terminate the -selected process. - -.. index:: configuration -.. _User Manager: - -User Manager -============ - -The TrueOS® User Manager utility allows you to easily add, configure, -and delete users and groups. To access this utility in SysAdm™, click -:menuselection:`System Management --> User Manager`. - -In the example shown in -:numref:`Figure %s: Viewing User Accounts in User Manager `, -the system has one user account that was created in the "Create a User -Screen" during installation. - -.. _user1: - -.. figure:: images/user1.png - -The "Standard" view allows you to configure the following: - -* **User Name:** the name the user will use when they log in to the - system. It is case sensitive and can not contain any spaces. - -* **Full Name:** this field provides a description of the account and - can contain spaces. - -* **Password:** this is where you can change the password for the - user. The password is case-sensitive and can contain symbols. If you - want to display the password as you change it, to make sure you are - setting it to the desired value, click the "eye" icon. Click that - icon again to show dots in place of the actual password. - -* **UID:** this value is greyed out as it is assigned by the operating - system and cannot be changed after the user is created. - -* **Home Dir Path:** if you change the user's home directory, input the full path - -* **Shell Path:** if you change the user's default shell, input the - full path to an installed shell. The paths for each installed shell - can be found in :file:`/etc/shells`. - -If you make any changes to a user's "Details", click the "Save" button -to save them. - -:numref:`Figure %s: Creating a New User Account ` demonstrates -how this screen changes when you click the "New User" button. - -.. _user2: - -.. figure:: images/user2.png - -Fields outlined in red are required when creating a user. The "User -Name", "Full Name", and "Password" fields are the same as described in -the "Details" tab. The rest of the available fields are as follows: - -**UID:** by default, the user will be assigned the next available User -ID (UID). If you need to force a specific UID, uncheck the "Auto" box -and either input or select the number to use. Note that you cannot use -an UID that is already in use by another account and those number will -be appear as red. - -**Home Dir Path:** by default, this is set to :file:`/nonexistent` -which is the correct setting for a system account as it prevents -unauthorized logins. If you are creating a user account for login -purposes, input the full path to use for the user's home directory. - -**Shell:** by default, this is set to :file:`/usr/bin/nologin` which -is the correct setting for a system account as it prevents -unauthorized logins. If you are creating a user account for login -purposes, input the full path of an installed shell. The paths for -each installed shell can be found in :file:`/etc/shells`. - -**Adminstrator Access:** check this box if the user requires -`su(1) `_ access. Note -that this setting requires the user to know the password of the *root* -user. - -**Operator Access:** check this box if the user requires -:command:`sudo` access. This allows the user to precede an -administrative command with :command:`sudo` and to be prompted for -their own password. - -Once you have made your selections, press the "Save" button to create -the account. - -If you click the "-" (remove) button for a highlighted user, a pop-up -menu will ask if you are sure that you want to remove the user and a -second pop-up will ask if you would like to also delete the user's -home directory (along with all of their files). If you click "No" to -the second pop-up, the user will still be deleted but their home -directory will remain. Note that the "-" button will be greyed out if -you highlight the user that started SysAdm™. It will also be greyed -out if there is only one user account as you need at least one user to -be able to login to the TrueOS® system. - -If you click the "Advanced View" button, this screen will change to -show all of the accounts on the system, not just the user accounts -that you created. An example is seen in -:numref:`Figure %s: Viewing All Accounts and Their Details `. - -.. _user3: - -.. figure:: images/user3.png - -The accounts that you did not create are known as system accounts and -are needed by the operating system or installed applications. Do **not** -delete any accounts that you did not create yourself as doing so may -cause a previously working application to stop working. "Advanced View" -provides additional information associated with each account, such as -the user ID number, full name (description), home directory, default -shell, and primary group. System accounts usually have a shell of -*nologin* for security reasons, meaning that an attacker can not try to -login to the system using that account name. - -.. index:: users -.. _PersonaCrypt: - -PersonaCrypt ------------- - -TrueOS® provides support for a security feature known as PersonaCrypt. -A PersonaCrypt device is a removable USB media, such as a USB stick, -which has been formatted with ZFS and encrypted with GELI. This device -is used to hold a specific user's home directory, meaning that they -can securely transport and access their personal files on any TrueOS® -or PC-BSD® 10.1.2 or higher system. This can be used, for example, to -securely access one's home directory from a laptop, home computer, and -work computer. The device is protected by an encryption key and a -password which is, and should be, separate from the user's login -password. - -.. note:: When a user is configured to use a PersonaCrypt device, that - user can not login using an unencrypted session on the same system. - In other words, the PersonaCrypt username is reserved for - PersonaCrypt use. If you need to login to both encrypted and - unencrypted sessions on the same system, create two different user - accounts, one for each type of session. - -PersonaCrypt uses GELI's ability to split the key into two parts: one -being your passphrase, and the other being a key stored on disk. -Without both of these parts, the media cannot be decrypted. This means -that if somebody steals the key and manages to get your password, it -is still worthless without the system it was paired with. - -.. warning:: USB devices can and do eventually fail. Always backup any - important files stored on the PersonaCrypt device to another device - or system. - -The "PersonaCrypt" tab can be used to initialize a PersonaCrypt device for any login user, **except** for the currently logged in user. In the -example shown in -:numref:`Figure %s: Initialize PersonaCrypt Device `, a new user, -named *dlavigne*, has been created and the entry for that user has been -clicked. - -.. _user5: - -.. figure:: images/user5.png - -Before a user is configured to use PersonaCrypt on a TrueOS® system, two -buttons are available in the "PersonaCrypt" section of "Advanced Mode". -Note that 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 "Apply" then re-highlight the user to display these -options: - -* **Initialize Device:** used to prepare the USB device that will be - used as the user's home directory. - -* **Import Key:** if the user has already created a PersonaCrypt device - on another TrueOS® system, click this button to import a previously - saved copy of the key associated with the device. Once the key is - 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 "Initialize Device". A pop-up menu will indicate that the current -contents of the device will be wiped and that the device must be larger -than the user's current home directory. - -.. warning:: since the USB stick will hold the user's home directory and - files, ensure that the stick is large enough to meet the anticipated - storage needs of the home directory. Since the stick will be - reformatted during the initialization process, make sure that any - current data on the stick that you need has been copied elsewhere. - Also, the faster the stick, the better the user experience while - logged in. - -Press "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 "Yes" to initialize the device. The User Manager -screen will be greyed out while the device is prepared. Once the -initialization is complete, the User Manager screen will change to -display the device's key options, as seen in -:numref:`Figure %s: PersonaCrypt Key Options `. - -.. _user6: - -.. figure:: images/user6.png - -The following options are now available: - -* **Export Key:** used to create a copy of the encryption key so that it - can be imported for use on another TrueOS® system. - -* **Disable Key (No Data):** used to uninitialize the PersonaCrypt - device on this system. Note that 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. - -Once a user has been initialized for PersonaCrypt on the system, their -user account will no longer be displayed when :ref:`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. - -.. note:: when stealth sessions have been configured, PersonaCrypt users will still be displayed in the login menu, even if - their USB device is not inserted. This is to allow those users the option to instead login using a stealth session. - -In the field with the yellow padlock icon, input the password for the -user account. In the field with the grey USB stick icon, input the -password associated with the PersonaCrypt device. - -.. warning:: To prevent data corruption and freezing the system - **DO NOT** remove the PersonaCrypt device while logged in! Always log - out of your session before physically removing the device. - -.. index:: users -.. _Managing Groups: - -Managing Groups ---------------- - -Click the "Groups" tab to view and manage the groups on the system. -The "Standard" tab, seen in -:numref:`Figure %s: Managing Groups Using User Manager `, -shows the group membership for the *operator* and *wheel* groups: - -.. _user4: - -.. figure:: images/user4.png - -This screen has 2 columns: - -**Members:** indicates if the highlighted group contains any user -accounts. - -**Available:** shows all of the system and user accounts on the system -in alphabetical order. - -To add an account to a group, highlight the group name, then highlight -the account name in the "Available" column. Click the left arrow and -the selected account will appear in the "Members" column. You should -only add user accounts to groups that you create yourself or when an -application's installation instructions indicate that an account needs -to be added to a group. - -.. note:: If you add a user to the *operator* group, they will have - permission to use commands requiring administrative access and will - be prompted for their own password when administrative access is - required. If you add a user to the *wheel* group, they will be - granted access to the :command:`su` command and will be prompted - for the superuser password whenever they use that command. - -To view all of the groups on the system, click "Advanced". - -.. index:: sysadm, life preserver -.. _Life Preserver: - -Life Preserver -============== - -The Life Preserver utility is designed to take full advantage of the -functionality provided by ZFS snapshots. This utility allows you to -schedule snapshots of a ZFS pool and to optionally replicate those -snapshots to another system over an encrypted connection. This design -provides several benefits: - -* A snapshot provides a "point-in-time" image of the ZFS pool. In one - way, this is similar to a full system backup as the snapshot contains - the information for the entire filesystem. However, it has several - advantages over a full backup. Snapshots occur instantaneously, - meaning that the filesystem does not need to be unmounted and you can - continue to use applications on your system as the snapshot is - created. Since snapshots contain the meta-data ZFS uses to access - files, the snapshots themselves are small and subsequent snapshots - only contain the changes that occurred since the last snapshot was - taken. This space efficiency means that you can take snapshots often. - Snapshots also provide a convenient way to access previous versions of - files as you can browse to the point-in-time for the version of the - file that you need. Life Preserver makes it easy to configure when - snapshots are taken and provides a built-in graphical browser for finding and restoring the files within a snapshot. - -* Replication is an efficient way to keep the files on two systems in - sync. With Life Preserver, the snapshots taken on the TrueOS® system - will be synchronized with their versions stored on the specified - backup server. - -* Snapshots are sent to the backup server over an encrypted connection. - -* Having a copy of the snapshots on another system makes it possible to - perform an operating system restore should the TrueOS® system become - unusable or to deploy an identical system to different hardware. - -To manage snapshots and replication using the SysAdm™ graphical client, -go to :menuselection:`Utilities --> Life Preserver`. The rest of this -section describes where to find and how to use the features built into -Life Preserver. - -.. index:: snapshots, life preserver -.. _Snapshots Tab: - -Snapshots Tab -------------- - -:numref:`Figure %s: Snapshot Tab ` shows the "Snapshots" -tab on a system that has not yet been configured. This system has a -"ZFS Pool" named "tank". - -.. _lpreserver1: - -.. figure:: images/lpreserver1.png - -This screen will display any created snapshots and provides buttons to: - -**Create:** used to create a manual snapshot of the specified pool -now. For example, you could create a snapshot before making changes to -an important file, so that you can preserve a copy of the previous -version of the file. Or, you can create a snapshot as you make -modifications to the system configuration. When creating a snapshot, a -pop-up message will prompt you to input a name for the snapshot, -allowing you to choose a name that is useful in helping you remember -why you took the snapshot. An entry will be added to this screen for -the snapshot where the "Name" will be the name you input and the -"Comment" will inidcate the date and time the snapshot was created. - -**Remove:** used to delete a highlighted snapshot. -**This is a permanent change that can not be reversed.** In other -words, the versions of files at that point in time the snapshot was -created will be lost. - -**Revert:** if you highlight a snapshot entry, this button and the -drop-down menu next to it will activate. You can use the drop-down -menu to specify which pool or dataset you would like to revert. -**Be aware that a revert will overwrite the current contents of the selected pool or dataset to the point in time the snapshot was created.** -This means that files changes that occurred after the snapshot was -taken will be lost. - -.. index:: replication, life preserver -.. _Replication Tab: - -Replication Tab ---------------- - -Life Preserver can be configured to replicate snapshots to another -system over an encrypted SSH connection, though the backup itself is -stored in an unencrypted format. This ensures that you have a backup -copy of your snapshots on another system. - -In order to configure replication, the remote system to hold a copy of -the snapshots must first meet the following requirements: - -* The backup server - **must be formatted with the latest version of ZFS,** also known as - ZFS feature flags or ZFSv5000. Operating systems that support this - version of ZFS include TrueOS®, FreeBSD or PC-BSD® 9.2 or higher, - and FreeNAS 9.1.x or higher. - -* That system must have SSH installed and the SSH service must be - running. If the backup server is running TrueOS®, PC-BSD®, FreeNAS® - or FreeBSD, SSH is already installed, but you will need to start the - SSH service. - -* If the backup server is running TrueOS® or PC-BSD®, you will need to - open TCP port 22 (SSH) using :ref:`Firewall Manager`. If the server - is running FreeBSD and a firewall has been configured, add a rule to - open this port in the firewall ruleset. FreeNAS® does not run a - firewall by default. Also, if there is a network firewall between - the TrueOS® system and the backup system, make sure it has a rule to - allow SSH. - -:numref:`Figure %s: Replication Tab ` shows the initial -"Replication" tab on a system that has not yet been configured for -replication. This screen is used to create, view, remove, and -configure the replication schedule. - -.. _lpreserver2: - -.. figure:: images/lpreserver2.png - -To schedule the replication, click the "+" button to display the -"Setup Replication" screen shown in -:numref:`Figure %s: Scheduling a Replication `. - -.. _lpreserver3: - -.. figure:: images/lpreserver3.png - -Input the following information: - -* **Host IP:** the IP address of the remote system to store the - replicated snapshots. - -* **SSH Port:** the port number, if the remote system is running SSH - on a port other than the default of 22. - -* **Dataset:** the name of the ZFS pool and optional dataset on the - remote system. For example, "remotetank" will save the snapshots to - a ZFS pool of that name and "remotetank/mybackups" will save the - snapshots to an existing dataset named "mybackups" on the pool named - "remotetank". - -* **Frequency:** use the drop-down menu to select how often to - initiate the replication. Available choices are "Sync with snapshot" - (at the same time a snapshot is created), "Daily" (when selected, - displays a time drop-down menu so you can select the time of day), - "Hourly", every "30 minutes", every "10 minutes", or "Manual Only" - (only occurs when you click the "Start" button) in this screen. - -* **Username:** the username must already exist on the remote system, - have write access to the specified "Dataset", and have permission to - SSH into that system. - -* **Password:** the password associated with the "Username". - -* **Local DS:** use the drop-down menu to select the pool or dataset - to replicate to the remote system. - -The buttons at the top of the "Setup Replication" screen are used to: - -**+ icon** add a replication schedule. Multiple schedules are -supported, meaning that you can replicate to multiple systems or -replicate different "Local DS" datasets at different times. - -**- icon** remove an already created, and highlighted, replication -schedule. - -**gear icon:** modify the schedule for the highlighted replication. - -**Start:** manually starts a replication to the system specified in -the highlighted replication. - -**Initialize:** deletes the existing replicated snapshots on the -remote system and starts a new replication. This is useful if a -replication gets stuck and will not complete. - -.. index:: configuration, life preserver -.. _Schedules Tab: - -Schedules Tab -------------- - -This tab is used to manage when snapshots of the ZFS pool are created. -Multiple snapshot schedules are supported if the system has multiple -pools. - -.. note:: Snapshots are created on the entire pool as they are needed - when :ref:`Restoring the Operating System`. - -To create a snapshot schedule, click the "camera" icon in the lower -left corner of this tab. This will activate the "Setup Snapshot -Schedule" pane as seen in -:numref:`Figure %s: Scheduling a Snapshot `. - -.. _lpreserver4: - -.. figure:: images/lpreserver4.png - -This pane contains the following options: - -**ZPool:** select the ZFS pool to snapshot. - -**Snapshots to keep:** snapshots are automatically pruned after the -specified number of snapshots to prevent snapshots from eventually -using up all of your disk space. If you would like to have multiple -versions of files to choose from, select the number of snapshots to -keep. Note that auto-pruning only occurs on the snapshots generated by -Life Preserver according to the configured schedule. Auto-pruning will -not delete any snapshots you create manually in the "Snapshots" tab. - -**Frequency:** use the drop-down menu to select how often snapshots -occur. Options include "Daily" (which will allow you to select the time -of day), "Hourly" every "30 Minutes", every "10 Minutes", or every "5 -Minutes". - -Once you have created a snapshot schedule, you can use the "gear" icon -next to the "camera" icon to modify the highlighted schedule or the -"X" icon to delete the highlighted schedule. - -This screen can also be used to manage the ZFS scrub schedule. Scrubs -are recommended as they can provide an early indication of a potential -disk failure. Since scrubs can be scheduled on a per-pool basis, if you -have multiple pools, create a scrub schedule for each pool. - -To schedule when the scrub occurs, click the third icon from the right -which will activate the "Setup Scrub Schedule" screen shown in -:numref:`Figure %s: Scheduling a Scrub `. - -.. _lpreserver5: - -.. figure:: images/lpreserver5.png - -Select the pool from the "ZPool" drop-down menu, then select the -"Frequency". Supported frequencies are "Daily", "Weekly", or -"Monthly". If you select "Daily", you can configure the "Hour". If you -select "Weekly", you can configure the "Day of week" and the "Hour". If -you select "Monthly", you can configure the "Date" and "Hour". Since a -scrub can be disk I/O intensive, it is recommended to pick a time when -the system will not be in heavy use. - -Once you have created a scrub schedule, you can use the "gear" icon -next to the "schedule scrub" icon to modify the highlighted schedule or -the "X" icon to delete the highlighted schedule. - -.. index:: configuration, life preserver -.. _Settings Tab: - -Settings Tab -------------- - -The "Settings" tab is shown in -:numref:`Figure %s: Life Preserver Settings `. - -.. _lpreserver6: - -.. figure:: images/lpreserver6.png - -The following settings are configurable: - -**Disk Usage Warning:** enter a number up to 99 to indicate at which -percentage of disk space Life Preserver will display an alert in the -system tray. This is useful to prevent snapshots from using up all -available disk space. - -**Email:** if you also wish to receive an email when disk usage reaches -the percentage configured in the "Disk Usage Warning", enter an email -address. - -**Email Trigger:** this setting can be set to "All", "Warn", or "Error" -and indicates the type of condition that will trigger an email message. - -**Recursive Management:** - -If you make any changes in this screen, press the "Save Settings" -button to apply them. - -.. index:: backup -.. _Using the lpreserver CLI: - -Using the lpreserver CLI ------------------------- - -The :command:`lpreserver` command line utility can also be used to -manage snapshots and replication. This command needs to be run as the -superuser. To display its usage, type the command without any arguments: - -.. code-block:: none - - lpreserver - Life-Preserver - --------------------------------- - Available commands - Type in help for information and usage about that command - help - This help file or the help for the specified command - cronsnap - Manage scheduled snapshots - cronscrub - Manage scheduled scrubs - snapshot - Manage snapshot tasks - replicate - Manage replication tasks - set - Set lpreserver options - get - Get list of lpreserver options - status - List datasets, along with last snapshot / replication date - -Each command has its own help text that describes its parameters and -provides a usage example. For example, to receive help on how to use -the :command:`lpreserver cronsnap` command, type: - -.. code-block:: none - - lpreserver help cronsnap - Life-Preserver - --------------------------------- - Help cronsnap - Schedule a ZFS snapshot - Usage: - lpreserver cronsnap - Available subcommands: - start - Schedule snapshots for a dataset - stop - Stop scheduled snapshots for a dataset. - list - List scheduled snapshots - exclude - Exclude datasets for scheduled snapshots - rmexclude - Remove datasets from exclude list for scheduled snapshots - listexclude - List excluded datasets for scheduled snapshots - start options: - start - frequency = auto / daily@XX / hourly / 30min / 10min / 5min - ^^ Hour to execute - numToKeep = Number of snapshots to keep total - NOTE: When frequency is set to auto the following will take place: - * Snapshots will be created every 5 minutes and kept for an hour. - * A hourly snapshot will be kept for a day. - * A daily snapshot will be kept for a month. - * A Monthly snapshot will be kept for a year. - * The life-preserver daemon will also keep track of the zpool disk space, - if the capacity falls below 75%, the oldest snapshot will be auto-pruned. - Examples: - lpreserver cronsnap start tank1/usr/home/kris daily@22 10 - Schedule snapshots of dataset tank1/usr/home/kris daily at 22:00. - 10 snapshots will be kept. - stop options: - stop - list options: - list - List all snapshot schedules for a dataset. - If no dataset is given it will list schedules for all datasets. - exclude options: - exclude ... - Exclude one or more datasets from scheduled snapshots. - Examples: - lpreserver cronsnap exclude tank1/usr/home/kris tank1/usr/home/kris/tmp tank1/usr/home/kris/test - Exclude dataset tank1/usr/home/kris/tmp and tank1/usr/home/kris/test from scheduled snapshots - on dataset tank1/usr/home/kris. - rmexclude options: - rmexclude ... - Remove exclude for one or more datasets that was previously excluded from scheduled snapshots. - This removes the datasets from the exclude list. - Examples: - lpreserver cronsnap rmexclude tank1/usr/home/kris tank1/usr/home/kris/tmp tank1/usr/home/kris/test - Dataset tank1/usr/home/kris/tmp and tank1/usr/home/kris/test on dataset tank1/usr/home/kris - are no longer excluded for scheduled snapshots. - listexclude options: - listexclude - List which datasets are excluded from schedule snapshots. - -Table 10.10a shows the command line equivalents to the graphical -options provided by the Life Preserver GUI. - -**Table 10.10a: Command Line and GUI Equivalents** - -+-------------------+-----------------------------------------------+----------------------------------------------------------------------------------------+ -| **Command Line** | **GUI** | **Description** | -+===================+===============================================+========================================================================================+ -| **cronsnap** | "Snapshots" tab | schedule when snapshots occur and how long to keep them; the **stop** option can be | -| | | used to disable snapshot creation | -+-------------------+-----------------------------------------------+----------------------------------------------------------------------------------------+ -| **cronscrub** | "Schedules" tab | schedule a ZFS scrub | -+-------------------+-----------------------------------------------+----------------------------------------------------------------------------------------+ -| **get** | "Settings" tab | list Life Preserver options | -+-------------------+-----------------------------------------------+----------------------------------------------------------------------------------------+ -| **replicate** | "Replication" tab | used to list, add, and remove backup server; read the **help** for this command for | -| | | examples | -+-------------------+-----------------------------------------------+----------------------------------------------------------------------------------------+ -| **set** | "Settings" tab | configures Life Preserver options; read **help** for the list of configurable options | -+-------------------+-----------------------------------------------+----------------------------------------------------------------------------------------+ -| **snapshot** | "Snapshots" tab | create and replicate a new ZFS snapshot; by default, snapshots are recursive, meaning | -| | | that a snapshot is taken of every dataset within a pool | -+-------------------+-----------------------------------------------+----------------------------------------------------------------------------------------+ -| **status** | | lists the last snapshot name and replication status | -+-------------------+-----------------------------------------------+----------------------------------------------------------------------------------------+ - -.. _Restoring the Operating System: - -Restoring the Operating System ------------------------------- - -If you have replicated the system's snapshots to a remote backup -server, you can use a TrueOS® installation media to perform an -operating system restore or to clone another system. Start the -installation as usual until you get to the screen shown in -:numref:`Figure %s: Selecting to Restore/Clone From Backup `. - -.. _restore1: - -.. figure:: images/restore1.png - -Before you can perform a restore, the network interface must be -configured. Click the "network connectivity" icon (second from the -left) in order to determine if the network connection was -automatically detected. If it was not, refer to the instructions in -:ref:`Network Manager` and make sure that networking is working -before continuing. - -Once you are ready, click "Restore from Life-Preserver backup" and the -"Next" button. This will start the Restore Wizard. In the screen shown -in -:numref:`Figure %s: Input the Information for a SSH Restore `, -input the IP address of the backup server and the name of the user -account used to replicate the snapshots. If the server is listening on -a non-standard SSH port, change the "SSH port" number. - -.. _restore2: - -.. figure:: images/restore2.png - -Click "Next" and the wizard will provide a summary of your selections. -If correct, click "Finish"; otherwise, click "Back" to correct them. - -Once you click "Finish", -Once the connection to the backup server succeeds, you will be able to select which host to restore. In the example shown in :numref:`Figure %s: Select the Host to Restore `, -only one host has been backed up to the replication server. - -.. _restore4: - -.. figure:: images/restore4.png - -After making your selection, click "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 "Finish" and the installer will proceed to the :ref:`Disk Selection Screen`. At -this point, you can click the "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 "Next" to perform the restore. \ No newline at end of file diff --git a/docs/client_handbook/images/install1b.png b/docs/client_handbook/images/install1b.png new file mode 100644 index 0000000..0a4be1f Binary files /dev/null and b/docs/client_handbook/images/install1b.png differ diff --git a/docs/client_handbook/images/user5.png b/docs/client_handbook/images/user5.png new file mode 100644 index 0000000..594ebcc Binary files /dev/null and b/docs/client_handbook/images/user5.png differ diff --git a/docs/client_handbook/sysadmclient.rst b/docs/client_handbook/sysadmclient.rst index b9f7851..949eeee 100644 --- a/docs/client_handbook/sysadmclient.rst +++ b/docs/client_handbook/sysadmclient.rst @@ -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 `, -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 `, 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 `. @@ -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 `, 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 `. @@ -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 `. .. 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 `, 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 ` to access the boot -menu selection screen. In the example shown in -:numref:`Figure %s `, 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 ` to access the boot menu selection +screen. In the example shown in :numref:`Figure %s `, 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) `_. @@ -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 `, 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 `. +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: -.. 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 `, 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 `. .. 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 List which datasets are excluded from schedule snapshots. -:numref:`Table %s ` shows the command line equivalents to the +:numref:`Table %s ` 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 `, 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 `_. 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. \ No newline at end of file