From 51fea5910a1d0837ebab48d2f32edb79d35b5849 Mon Sep 17 00:00:00 2001 From: "A. Wilcox" Date: Sat, 15 Dec 2018 23:02:24 -0600 Subject: Admin: Give every section a readable, user-friendly ID --- src/admin/10_help.xml | 6 +++--- src/admin/11_quickref.xml | 6 +++--- src/admin/1_intro.xml | 8 +++---- src/admin/3_packages.xml | 6 +++--- src/admin/4_services.xml | 5 ++--- src/admin/5_networking.xml | 48 +++++++++++++++++++++--------------------- src/admin/6_security.xml | 8 +++---- src/admin/7_config.xml | 52 +++++++++++++++++++++++----------------------- src/admin/8_fslayout.xml | 14 ++++++------- src/admin/9_standards.xml | 2 +- 10 files changed, 77 insertions(+), 78 deletions(-) diff --git a/src/admin/10_help.xml b/src/admin/10_help.xml index 5cb0021..2fb8559 100644 --- a/src/admin/10_help.xml +++ b/src/admin/10_help.xml @@ -2,7 +2,7 @@ If You Need Help If you experience an issue that you cannot solve by reading the Adélie Linux documentation, there are a large variety of avenues available to you to ask the community for help. -
+
Mailing Lists The Adélie Linux mailing lists are a great way to obtain answers to any number of issues. Helpful members of the community, along with most of the Adélie Linux development team, are always monitoring the mailing lists and are ready to help you with your issue. There are three main mailing lists that would be of interest to systems administrators: @@ -26,13 +26,13 @@
-
+
Community Chat The Adélie Linux community has a dedicated online chat system for asking quick questions about using the Adélie Linux system. We welcome all of our users to our chat, and we look forward to seeing you! Please note that detailed or complex issues may be referred to the mailing lists. The chat system uses the Internet Relay Chat (IRC) protocol; to join the chat, you will need to use an IRC client. Three popular clients are packaged in the Adélie Linux system: Konversation (the KDE IRC client), Quassel (a popular Qt IRC client), and WeeChat (a terminal-based IRC client). To join our chat, connect to the Interlinked IRC network at irc.interlinked.me (TLS port 6697), and then join the #Adelie-Support channel.
-
+
Other avenues of support If you have found an issue with a package (a segmentation fault, crash, or hang/freeze), you may file an issue at the Adélie Linux issue tracker. The Adélie Linux sub on Reddit is sometimes used for asking for help, but it is highly recommended to use the mailing lists instead. diff --git a/src/admin/11_quickref.xml b/src/admin/11_quickref.xml index eab36e9..d9e2448 100644 --- a/src/admin/11_quickref.xml +++ b/src/admin/11_quickref.xml @@ -2,7 +2,7 @@ Quick References In this chapter, we will lay out common tasks and how to perform them using Adélie Linux. -
+
Package management Package management command quick-reference @@ -38,7 +38,7 @@
-
+
Service management Service management command quick-reference @@ -82,7 +82,7 @@
-
+
Networking Networking command quick-reference diff --git a/src/admin/1_intro.xml b/src/admin/1_intro.xml index 0322c32..743c04a 100644 --- a/src/admin/1_intro.xml +++ b/src/admin/1_intro.xml @@ -2,7 +2,7 @@ Introduction Welcome to the Adélie Linux 1.0 Administrator's Handbook. You'll learn a lot about how to administrate your Adélie Linux computer. We'll get started by looking at how Adélie Linux compares to other popular operating environments. We will also review some of the software used that will feature in the chapters ahead. -
+
Comparison of Adélie with other environments Adélie Linux is a Linux distribution focused on security, speed, reliability, and correctness. Since it is based on the Linux kernel, it shares some common traits with other Linux distributions. However, it has many unique facets as well. One of the defining differences of Adélie Linux is the commitment to run on many different hardware platforms. The first comparison we will review is the hardware platforms that various environments support. @@ -306,7 +306,7 @@
-
+
What sets Adélie apart The Adélie Linux operating environment has many features that stand out from other environments.
@@ -328,9 +328,9 @@ Adélie Linux supports many different hardware platforms, allowing you to truly use your hardware your way. All Adélie Linux packages are tested on all tier 1 architectures before being released. From your PowerPC/POWER workstation, to your dusty old Intel x86 notebook, to your ARM 64 tablet, you can ensure you are getting the most from your computers by using Adélie Linux on them.
-
+
Familiarising yourself with Adélie - Now it's time to go over a brief run-down of the day-to-day administration of an Adélie system. These will be covered with more depth in later chapters. + Now let's brief go over some of the essentials of day-to-day administration of an Adélie Linux system. These will be covered with more depth in later chapters.
The shell environment The shell environment, also called a terminal or console, is an interface where you type commands in to a command processor (the shell), and view the results of the command on your screen. Windows users may know this environment as a "Command Prompt". The shell environment is an essential part of administrating any Linux system. Adélie Linux is designed to make the shell environment easy to use while still providing you the ability to view and edit nearly every detail about your system. diff --git a/src/admin/3_packages.xml b/src/admin/3_packages.xml index e7e70bb..58ca9a1 100644 --- a/src/admin/3_packages.xml +++ b/src/admin/3_packages.xml @@ -2,7 +2,7 @@ Package Management In this chapter, we will discuss package management in the Adélie Linux operating environment, including the APK package manager. -
+
Introduction We'll start off by learning what a package is, and about the package manager used by Adélie Linux.
@@ -17,7 +17,7 @@ APK refers the entire set of packages you have chosen to install on your computer as a "world". When you install a package, you are adding it to the "world". When you uninstall a package, you are removing it from the "world". The world file exists at /etc/apk/world and is a text file with each package you have chosen to install on a single line.
-
+
Installing and uninstalling packages When you want to install a package on your Adélie Linux system, you may use the command apk add PACKAGE, where PACKAGE is the name of the package you want to install. You may install multiple packages at the same time by separating them with spaces. For example, apk add firefox thunderbird will install the Firefox web browser and Thunderbird email client. To uninstall a package on your Adélie Linux system, you may use the command apk del PACKAGE, where PACKAGE is the name of the package you want to uninstall. As with package installation, you may uninstall multiple packages at the same time by separating them with spaces. @@ -29,7 +29,7 @@ World updated, but the following packages are not removed due to: This indicates that the fts package was removed from your "world" file (if it was listed there), but it is still required by the dracut package that is currently installed on your computer.
-
+
Ensuring package integrity The APK package manager can help you ensure continuing system integrity, and can also help you correct some issues as they arise. Every file installed on your computer by APK has a cryptographic signature and checksum. You may use the command apk audit to audit your entire system for integrity, or apk audit PATH to audit a specific file or directory on your system. Note that PATH must be an absolute path; it must be the entire path beginning with a /. For example, the command apk audit /usr/bin/vim is valid; the command apk audit vim, even if it is run from inside the /usr/bin directory, is not. The typical output of an apk audit run will look something like the following: diff --git a/src/admin/4_services.xml b/src/admin/4_services.xml index 7be2602..85b9414 100644 --- a/src/admin/4_services.xml +++ b/src/admin/4_services.xml @@ -27,12 +27,11 @@ To view the status of all services on your system, you may use the command rc-status. If any services are listed under "Dynamic Runlevel: manual", these are services that have been started but do not belong to any runlevel. That means they have been started without being enabled first, and will not automatically start on next system boot.
-
+
Scheduling a process to run later Not Yet WrittenThis section has not yet been written. - You may wish to run a command at a specific time. Therefore, we should describe at here some day.
-
+
Scheduling a process to run periodically Not Yet WrittenThis section has not yet been written.
diff --git a/src/admin/5_networking.xml b/src/admin/5_networking.xml index a195c3c..1febe4b 100644 --- a/src/admin/5_networking.xml +++ b/src/admin/5_networking.xml @@ -2,7 +2,7 @@ Networking In this chapter, we will discuss how to configure your Adélie Linux system for networking. Wired, wireless, and VPN connections using both static and dynamic IP addressing will be covered. In addition, advanced topics including interface bondage and KVM configuration will also be discussed. -
+
Introduction The Adélie Linux system uses netifrc as its network configuration and management system. The netifrc system uses a declarative configuration syntax in a single file, /etc/conf.d/net, for ease of administration. All main system network configuration is declared in this file. Some additional configuration may be required for wireless or VPN connections; notably, wireless connections require WPA Supplicant to be configured using either wpa_gui (on computers that use X11), or in the /etc/wpa_supplicant/wpa_supplicant.conf file. The default configuration for the Adélie Linux system uses the traditional Linux interface names (such as "eth0", "eth1", and "wlan0"). If you prefer the new "predictable" interface names (such as "enP2p36s15f0" or "wlp9s0"), refer to . @@ -17,7 +17,7 @@ Before we begin configuring the network, we will list the network adaptors available on your computer. This will ensure that the adaptor or adaptors were detected successfully by the kernel. To do this, ensure the iproute2 package is installed, and run the command ip link as root.
-
+
Wired connections For the purposes of this handbook, a wired connection is a connection to a network that utilises Ethernet. While the Adélie Linux system supports ATM, CAN bus, IEEE 1394, and Token Ring networking, these connection types are exceedingly rare and out of the scope of this handbook.
@@ -42,42 +42,42 @@ nameserver 84.200.69.80
-
+
Wireless connections -
+
WPA-based authentication - + Not Yet WrittenThis section has not yet been written.
-
+
RADIUS (certificate-based) authentication - + Not Yet WrittenThis section has not yet been written.
-
+
Configuring for multiple access points - + Not Yet WrittenThis section has not yet been written.
-
+
VPN connections -
+
OpenVPN - + Not Yet WrittenThis section has not yet been written.
-
+
StrongSwan - + Not Yet WrittenThis section has not yet been written.
-
+
Virtual machine networking -
+
Networking guests with each other only - + Not Yet WrittenThis section has not yet been written.
-
+
Sharing a host network with guests The Adélie Linux system can be configured to provide bridged networking to a QEMU virtual machine or KVM guest using TAP networking. You will need the iproute2 package installed. First, we will need to add a bridge to netifrc. A bridge allows multiple network adaptors to combine multiple network segments into a single aggregate. For our purposes, we will be combining the physical network adaptor on the host with the virtual network adaptors on each guest. The bridge will have your physical network adaptor as its first member. This way, no network reconfiguration will be required when you start or stop virtual machines. You will need to move the configuration for your physical network adaptor to the bridge, so that all members of the bridge may share that connection. In the following example, the interface eth0 is the physical adaptor and the bridge is set to use a static IPv6 address, which will then be used by the physical adaptor as well. @@ -122,25 +122,25 @@ ip tuntap del name $1 This will start a machine with network access and a MAC address of 02:00:00:00:00:01.
-
+
Advanced topics
Advanced: Using "predictable" network interface names - + Not Yet WrittenThis section has not yet been written.
Advanced: Multiple interfaces Note that by default, all interfaces must be active before the rest of the system will consider the network to be active. This will cause network services to delay start-up until all interfaces are active. If this is not desired, you may set rc_depend_strict to NO in /etc/rc.conf.
-
+
Advanced: Interface bondage - + Not Yet WrittenThis section has not yet been written.
-
+
Advanced: 802.1X authentication - + Not Yet WrittenThis section has not yet been written.
Advanced: Customising dynamic addressing diff --git a/src/admin/6_security.xml b/src/admin/6_security.xml index 18c16bd..f0226ee 100644 --- a/src/admin/6_security.xml +++ b/src/admin/6_security.xml @@ -2,12 +2,12 @@ Security In this chapter, we will review best practices for keeping your Adélie Linux systems secure. -
+
Introduction to computer security - No one book can teach you everything about computer security. Computer security is not simply an item on a list that must be done once and then it is "completed". Computers are very powerful tools, and just as they can be used to teach, create, and produce, they can also be used for more nefarious purposes. By taking a proactive approach to computer security, and treating it as a process, you will be much more successful in keeping the security, confidentiality, and integrity of your data intact. + No one book can teach you everything about computer security. Computer security is not simply an item on a list that must be done once and then it is "completed". Computers are very powerful tools, and just as they can be used to teach, create, and produce, they can also be used for more nefarious purposes. By taking a proactive approach to computer security, and treating it as a process, you will be much more successful in keeping the security, confidentiality, and integrity of your data intact. You first need to identify your threat model; that is, what advisaries are you attempting to keep out? A sophisticated nation-state requires a much different security plan than a random hacker. The suggestions in this handbook are a starting point to help you develop an actionable plan to keep your computer secure. They are by no means exhaustive. Remember to always keep learning; knowledge is power.
-
+
APK Only use repositories and mirrors with HTTPS. @@ -15,7 +15,7 @@ Ensure any custom or third-party repositories have high-grade signature keys and that you trust the developers.
-
+
Services If a service is only being used in your internal network, make sure it is configured to only accept connections from that network. This reduces the chance that an external attacker from the Internet can connect to it. diff --git a/src/admin/7_config.xml b/src/admin/7_config.xml index 7bedb96..deaaad1 100644 --- a/src/admin/7_config.xml +++ b/src/admin/7_config.xml @@ -2,7 +2,7 @@ System Configuration In this chapter, we will overview the main configuration files present in the Adélie Linux system. -
+
Introduction This chapter will cover the main configuration files that are commonly referenced in the daily administration of Adélie Linux systems. This list is not exhaustive, and is not a list of every configuration file in the Adélie Linux system. Some configuration files are only present when a specific system option (such as audio, graphics, or networking) is installed. Each section in this chapter has the following subsections: @@ -12,7 +12,7 @@ either Detailed Information for information on configuration files specific to the Adélie Linux system, or External References for either manual pages or online links to more information about configuration files from packages.
-
+
<filename>/etc/abuild.conf</filename>: Package build configuration
Purpose @@ -43,7 +43,7 @@ If a repository is invalid, does not have a recognised signing key, or does not exist, it will not be considered by APK. Depending on the parameters passed to APK and the operation being performed, this may be a warning or a fatal error.
-
+
<filename>/etc/asound.conf</filename>: System audio configuration
Purpose @@ -58,7 +58,7 @@ For more information on configuring system audio hardware, refer to the official documentation at the ALSA Project Web site on the Internet.
-
+
<filename>/etc/bash/bashrc</filename>: Bash shell startup configuration
Purpose @@ -73,7 +73,7 @@ For more information, refer to the bash(1) manpage. If this manpage is not present on your system, it may be installed via the bash-doc package.
-
+
<filename>/etc/conf.d/alsa</filename>: Mixer level configuration
Purpose @@ -88,7 +88,7 @@ For more information, refer to the comments in the /etc/conf.d/alsa file.
-
+
<filename>/etc/conf.d/bootmisc</filename>: Boot behaviour configuration
Purpose @@ -137,7 +137,7 @@
-
+
<filename>/etc/conf.d/devfs</filename>: <filename class="directory">/dev</filename> configuration
Purpose @@ -152,7 +152,7 @@ The skip_mount_dev variable may be set to YES to prevent the system from automatically attempting to mount /dev during system initialisation. The default setting of the skip_mount_dev variable is NO.
-
+
<filename>/etc/conf.d/dmesg</filename>: <literal>dmesg</literal> configuration
Purpose @@ -167,7 +167,7 @@ The dmesg_level controls the "console level", or the severity required for a message to be printed to the system console. The default value is 1, which corresponds to the emerg log level. This prevents all messages from being written to the console except kernel panics.
-
+
<filename>/etc/conf.d/fsck</filename>: Startup file system check configuration
Purpose @@ -264,7 +264,7 @@
--> -
+
<filename>/etc/conf.d/modules</filename>: Kernel module configuration
Purpose @@ -281,7 +281,7 @@ For each module specified, an additional variable, module_MODNAME_args, is defined, where MODNAME is the name of the module. The module_MODNAME_args variable controls the arguments passed to the module. Refer to the documentation for each module for a list of arguments it supports.
-
+
<filename>/etc/conf.d/net</filename>: Network configuration
Purpose @@ -296,7 +296,7 @@ Refer to for information on configuring networks using the Adélie Linux system.
-
+
<filename>/etc/conf.d/urandom</filename>: Random number configuration
Purpose @@ -311,7 +311,7 @@ The /etc/conf.d/urandom file defines a single configuration variable, urandom_seed, which specifies the path in which to save the random number seed when the system is shut down. The default is /var/lib/misc/random-seed. This variable must point to a path that is on the root filesystem; if /var is a separate filesystem, you must configure this variable to use a different path.
-
+
<filename>/etc/default/console-setup</filename>: Virtual terminal configuration
Purpose @@ -326,7 +326,7 @@ For more information, consult the official manual page for console-setup(5). This manual page is available in the console-setup-doc package. If your computer has an Internet connection, you may also read it on the Web.
-
+
<filename>/etc/default/keyboard</filename>: Console keyboard configuration
Purpose @@ -346,7 +346,7 @@ For more information, consult the official manual page for keyboard(5). This manual page is available in the console-setup-doc package. If your computer has an Internet connection, you may also read it on the Web.
-
+
<filename class="directory">/etc/dracut.conf.d/</filename>: Early system initialisation configuration
Purpose @@ -361,7 +361,7 @@ For more information, consult the dracut.conf(5) manual page. This manual page is available in the dracut-doc package.
-
+
<filename>/etc/fstab</filename>: Filesystem mount point configuration
Purpose @@ -382,7 +382,7 @@ For more information, consult the fstab(5) manual page. This manual page is available in the util-linux-doc package.
-
+
<filename>/etc/hostname</filename>: Host name configuration
Purpose @@ -397,7 +397,7 @@ The /etc/hostname is read during system initialisation. The system host name is set to the contents of this file. If the /etc/hostname file is missing or corrupt, the system will retain the kernel's default host name — with the default Adélie Linux kernel, this is "adelie".
-
+
<filename>/etc/inputrc</filename>: Bash shell keyboard configuration
Purpose @@ -412,7 +412,7 @@ There are a few comments in the /etc/inputrc file. Since the GNU readline library is not packaged for the Adélie Linux system, it is not possible to read the manual page.
-
+
<filename>/etc/issue</filename>: System identification configuration
Purpose @@ -427,7 +427,7 @@ For more information, refer to the Issue Files section of the agetty(8) manual page. The agetty(8) manual page is available in the util-linux-doc package.
- -
+
<filename>/etc/localtime</filename>: Time zone configuration
Purpose @@ -457,7 +457,7 @@ The tzdata package provides a number of time zone files in the /usr/share/zoneinfo directory. When configuring the system time zone, you should make a symbolic link from your time zone to /etc/localtime. Alternatively, if you are using a split /usr (not common), you may copy the file directly. For example, to set the system time zone to American Central Time, you would run ln -s /usr/share/zoneinfo/America/Chicago /etc/localtime; or, if you are using a split /usr (not common), you would run cp /usr/share/zoneinfo/America/Chicago /etc/localtime. For a full list of time zones available, run find /usr/share/zoneinfo.
-
+
<filename>/etc/login.defs</filename>: Login configuration
Purpose @@ -472,7 +472,7 @@ For more information, refer to the login.defs(5) manual page. The login.defs(5) manual page is available in the shadow-doc package.
-
+
<filename>/etc/motd</filename>: Login message configuration
Purpose @@ -487,7 +487,7 @@ The entire contents of the /etc/motd file are displayed to a user when they log in to the system. No command substitution or escape sequences are recognised; the file is entirely plain text. The default login message provides pointers on where to find the documentation for the Adélie Linux system.
-
+
<filename class="directory">/etc/profile.d/</filename>: Shell startup configuration
Purpose @@ -502,7 +502,7 @@ The /etc/profile script is sourced by most shells during interactive logins. This script enumerates all shell scripts present in /etc/profile.d and sources them. Adding an executable shell script to /etc/profile.d allows you to set environment variables or add shell functions for interactive use. Note that most shells will not source these files during non-interactive logins.
-
+
<filename>/etc/rc.conf</filename>: Service manager configuration
Purpose @@ -597,7 +597,7 @@
-
+
<filename>/etc/resolv.conf</filename>: Network name resolution configuration
Purpose diff --git a/src/admin/8_fslayout.xml b/src/admin/8_fslayout.xml index 3aac814..e34b78c 100644 --- a/src/admin/8_fslayout.xml +++ b/src/admin/8_fslayout.xml @@ -2,13 +2,13 @@ File System Layout In this chapter, we will review directories and files common to all Adélie Linux systems. Adélie Linux is based on the Filesystem Hierarchy Standard (FHS) 3.0 specification; directories and files specified in FHS are not covered here. -
+
<filename class="directory">/etc</filename>: Host-specific system configuration -
+
Purpose As in FHS, the /etc hierarchy contains configuration files specific to a single host.
-
+
Requirements The following directories, or symbolic links to directories, must be present in /etc: @@ -47,7 +47,7 @@
-
+
Specific Options The following files, or symbolic links to files, must be present in /etc, if the corresponding subsystem is installed: @@ -76,13 +76,13 @@
-
+
<filename class="directory">/etc/apk</filename>: Configuration files for the package manager -
+
Purpose /etc/apk is used for configuring the Adélie Linux package manager, as described in .
-
+
Requirements The following directories, or symbolic links to directories, must be present in /etc/apk: diff --git a/src/admin/9_standards.xml b/src/admin/9_standards.xml index 746f490..7b2b3a8 100644 --- a/src/admin/9_standards.xml +++ b/src/admin/9_standards.xml @@ -2,7 +2,7 @@ Standards Conformance In this chapter, we will review the standards with which the Adélie Linux operating environment is certified to be conformant. -
+
Filesystem Hierarchy Standard 3.0 The Adélie Linux operating environment is believed to be fully compliant with the Filesystem Hierarchy Standard, version 3.0. If you find an issue that may cause non-conformance while using Adélie Linux, please file an issue at the Adélie Linux Issue Tracker.
-- cgit v1.2.3-60-g2f50