trueos / sysadm-docs

Handbook and API docs for SysAdm

FreeBSD Source:

This is the top level of the FreeBSD source directory. This file was last revised on: $FreeBSD$

FreeBSD is an operating system used to power modern servers, desktops, and embedded platforms. A large community has continually developed it for more than thirty years. Its advanced networking, security, and storage features have made FreeBSD the platform of choice for many of the busiest web sites and most pervasive embedded networking and storage devices.

For copyright information, please see the file COPYRIGHT in this directory. Additional copyright information also exists for some sources in this tree - please see the specific source directories for more information.

The Makefile in this directory supports a number of targets for building components (or all) of the FreeBSD source tree. See build(7), config(8), https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/makeworld.html, and https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/kernelconfig.html for more information, including setting make(1) variables.

Source Roadmap:

bin		System/user commands.

cddl		Various commands and libraries under the Common Development
		and Distribution License.

contrib		Packages contributed by 3rd parties.

crypto		Cryptography stuff (see crypto/README).

etc		Template files for /etc.

gnu		Various commands and libraries under the GNU Public License.
		Please see gnu/COPYING* for more information.

include		System include files.

kerberos5	Kerberos5 (Heimdal) package.

lib		System libraries.

libexec		System daemons.

release		Release building Makefile & associated tools.

rescue		Build system for statically linked /rescue utilities.

sbin		System commands.

secure		Cryptographic libraries and commands.

share		Shared resources.

stand		Boot loader sources.

sys		Kernel sources.

sys/<arch>/conf Kernel configuration files. GENERIC is the configuration
		used in release builds. NOTES contains documentation of
		all possible entries.

tests		Regression tests which can be run by Kyua.  See tests/README
		for additional information.

tools		Utilities for regression testing and miscellaneous tasks.

usr.bin		User commands.

usr.sbin	System administration commands.

For information on synchronizing your source tree with one or more of the FreeBSD Project's development branches, please see:

https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/current-stable.html

sysadm-docs's Issues

sysadm.us certificate issue

Update API reference guide:

trueos/sysadm@34b3882

Port over and implement experimental pdf generation

Bring over experimental pdf work from trueos/trueos-docs, get it functional, then set up an automated process to make the pdf available on the sysadm.us website.

Document new system management page: Devices

(client handbook) When added to UNSTABLE, test and document new System Management -> Devices page

Unable to build sysadm on freebsd 10.3 or 11

I tried to find a way to contact you for issues, but cannot find any, so I'll try here since I tried to follow the installation guide on https://sysadm.us/handbook/server/basics.html#building-sysadm
on Freebsd 10.3 release as well on Freebsd 11 Release.

Both bails out on qmake, this is from freebsd 10.3:

/usr/local/lib/qt5/bin/qmake -recursive
/usr/local/lib/qt5/bin/qmake: Command not found.

Is this supposed to run on FreeBSD?
on www.sysadm.us you can read

SysAdm™ is a FreeBSD-based service which provides a stable API for administrating FreeBSD and TrueOS systems.

I'm a little bit confused, so much basic information is missing on the web page and in the documentation, also there is no issue tracker except for the documentation here?

Thanks

Update Client book Section 4: Managing remote connections

Update procedure to access the window.

Update index entries

Alter the .. index:: lines in sysadmclient.rst to be more informative/useful.

[Recurring] Check and update screenshots

Compare screenshots in the Client and Server handbooks against what is currently available with the latest TrueOS STABLE and update as necessary.

SysAdm Client Handbook Typo

From @tigerfbsd on July 14, 2017 22:47

I believe in section 11.2 (Replication) of the SysAdm Client Handbook the text beside the "+" icon says "Sdd". I believe this probably should be "Add".

Copied from original issue: trueos/trueos-docs#42

Document new System Control page:

(client handbook) When added to UNSTABLE, test and document new System Management -> System Controls page.

Add doc change instructions to README

Add link from TrueOS Handbook to Client book

Section 5: Boot Environment Manager should be linked or referenced in the TrueOS handbook, as it contains all the instructions for creating and switching boot environments.

Images 5.2 and 5.3 and related text may need to be migrated to the TrueOS handbook (investigate).

Review sysadmclient.rst for cross-platform information

As the SysAdm Client handbook was taken from the TrueOS and Lumina handbooks, reviewing the material for anything that may need to be returned or linked in those handbooks would be useful.