EverestLinux/everest-web
EverestLinux/everest-web
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

add documentation

Browse Source
This commit is contained in:
Liam Waldron 2023-04-04 13:36:31 -04:00
parent 16f20459d4
commit 6fae26a9fa
11 changed files with 418 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
about.html
View File

@ -12,6 +12,7 @@
<a href="install.html">Install</a>
<a href="https://git.everestlinux.org/EverestLinux/glacier-pkgs">Packages</a>
<a href="download.html">Downloads</a>
<a href="docs/home.html">Docs</a>
<a href="https://git.everestlinux.org/EverestLinux/wiki">Wiki</a>
<a href="errata.html">Errata</a>
<a href="https://git.everestlinux.org">Git</a>

33
css/everest.css
View File

@ -214,3 +214,36 @@ footer {
font-size: 10px;
padding: 20px;
}
#myInput {
width: 50%;
font-size: 16px;
padding: 12px 20px 12px 20px;
border: 2px solid #4a86e8ff;
border-radius: 2px;
margin-bottom: 12px;
}
#myUL {
width: 50%;
list-style-type: none;
padding: 0;
margin: 0;
}
#myUL li a {
border-left-width: 2px;
border-left-style: solid;
border-left-color: #4a86e8ff;
margin-top: -1px;
background-color: #2C2C2C;
padding: 12px;
text-decoration: none;
font-size: 18px;
color: #e6e6e6;
display: block;
}
#myUL li a:hover:not(.header) {
background-color: #1E1E1E;
}

96
docs/general-recommendations.html Normal file
View File

@ -0,0 +1,96 @@
<!DOCTYPE html>
<html>
<head>
<title>Everest Linux - Docs</title>
<link type="text/css" rel="stylesheet" href="../css/everest.css"/>
</head>
<body>
<!-- Navbar -->
<div class="sidenav">
<a href="../index.html">Home</a>
<a href="../about.html">About</a>
<a href="../install.html">Install</a>
<a href="https://git.everestlinux.org/EverestLinux/glacier-pkgs">Packages</a>
<a href="../download.html">Downloads</a>
<a href="home.html">Docs</a>
<a href="https://git.everestlinux.org/EverestLinux/wiki">Wiki</a>
<a href="../errata.html">Errata</a>
<a href="https://git.everestlinux.org">Git</a>
</div>
<!-- Rest of page -->
<div class="main">
<button onclick="window.location.href='home.html';">
Back to home
</button>
<h2>General Recommendations</h2>
<p>This page will explain how to expand an Everest system from barebones to more usable.</p>
<h2>1 - Administration</h2>
<p><strong>1.1 </strong>Users</p>
<p>A base system leaves only the root account. Using this account for daily use is extremely unsafe. It is highly recommended to create an unprivileged user.</p>
<p>This can be done with the 'adduser' command. See 'man adduser' for more info.</p>
<p><strong>1.2 </strong>Services</p>
<p>Learn how to use your system's init system. 'esv' should be relatively straightforward, while 'systemd' may require more practice.</p>
<p>To enable services on systems using 'esv':</p>
<code>(root)# esv start service</code>
<p>On 'systemd':</p>
<code>(root)# systemctl enable --now service</code>
<p>With no service manager:</p>
<code>(root)# /etc/init.d/service_name {start,stop,restart}</code>
<p></p>
<h2>2 - Package Management</h2>
<p><strong>2.1 </strong>Basics</p>
<p>Everest uses 'glacier' as its package manager. It downloads a PKGBUILD-like script and sources it. It then runs the according functions.</p>
<p>Glacier functions a lot like Gentoo's 'portage', and while 'glacier' is not as feature-rich, it should satisfy the needs of most users.</p>
<p><strong>2.2 </strong>Repositories</p>
<p>The 'GREPO' variable, defined in '/etc/glacier.conf', is where Glacier will download packages to. This is tied into your system profile, and should not be changed.</p>
<p>There are 8 subcategories:</p>
<ol>
<li>world - system software</li>
<li>galaxy - copyleft-licensed software</li>
<li>universe - permissive-licensed software</li>
<li>multiverse - proprietary (binary-redistributable or EULA) software</li>
<li>Testing counterparts</li>
</ol>
<p>In addition to the subcategory system, whitelisted licenses can be changed in '/etc/glacier.conf'.</p>
<h2>3 - Boot process</h2>
<p><strong>3.1 </strong>Microcode</p>
<p>All users of AMD and Intel CPUs should install their corresponding microcode update package.</p>
<code>(root)# gpkg -f world/{amd,intel}-ucode</code>
<p><strong>3.2 </strong>Secure boot</p>
<p>Everest does not officially support UEFI secure boot at the moment. While you can always attempt to implement it yourself, there will most likely be pitfalls.</p>
<p>For most users, disabling secure boot altogether is recommended.</p>
<p><strong>3.3 </strong>Rescue partition</p>
<p>By default, an Everest system image ships with a directory called '/rescue'. These files can be copied over to a separate partition for quick system repair.</p>
<h2>4 - Interface</h2>
<p><strong>4.1 </strong>Display server</p>
<p>Xorg is the de-facto standard display server in the Linux world, and allows the user to run graphical applications, such as a desktop environment, window manager, and other programs.</p>
<p>Wayland is an alternative to Xorg, but is not compatible with everything.</p>
<p>Configuring Xorg is an absolute headache, while Wayland is relatively smooth. Weigh the benefits of both and decide what works better for you.</p>
<p>Everest doesn't actually ship Xorg, it ships Xenocara, OpenBSD's build framework for Xorg. The two should be 100% compatible.</p>
<p><strong>4.2 </strong>Drivers</p>
<p>AMD graphics drivers are included in distribution kernels, and can be included in custom kernels when configuring. Nouveau, the open source implementation of Nvidia's graphics drivers can be included as well.</p>
<p>While these defaults may be adequate for running a headless machine, or just general web browsing, some users may want more performance out of their GPU.</p>
<p>Install mesa, which provides an open source implementation of OpenGL, Vulkan, and other APIs:</p>
<code>(root)# gpkg -f world/mesa</code>
<p>Install AMD drivers:</p>
<code>(root)# gpkg -f world/mesa</code>
<p>Install Nvidia drivers on a system running a distribution kernel:</p>
<code>(root)# gpkg -f world/nvidia</code>
<p>Or, install Nvidia drivers on a system running a custom kernel:</p>
<code>(root)# gpkg -f world/nvidia-dkms</code>
<p><strong>4.3 </strong>Desktop environments</p>
<p>Desktop environments provide a complete graphical interface, like what's found in most Linux distributions. Users who want something that will work out of the box will most likely opt for a desktop environment.</p>
<p>Some popular choices include GNOME, KDE Plasma, and Xfce.</p>
<p><strong>4.4 </strong>Standalone window managers</p>
<p>A window manager is a single program with one task - manage window position, size, etc. Users who want a lightweight, keyboard oriented workflow, and are fine with extensive customization will most likely opt for a window manager.</p>
<p>Some popular choices include i3, sway, bspwm, openbox, awesome, and dwm.</p>
</div>
<footer>
<p>Page last updated 4/04/23 @ 13:34</p>
<p>Page licensed under GNU Free Documentation License 1.3 or later</p>
<p>--------------------</p>
<p>Copyright (C) 2021-2023 Everest Linux</p>
<p>Linux (R) is a registered trademark of Linus Torvalds.</p>
<p>Everest Linux is provided AS IS, WITHOUT WARRANTY.</p>
</footer>

55
docs/home.html Normal file
View File

@ -0,0 +1,55 @@
<!DOCTYPE html>
<html>
<head>
<title>Everest Linux - Docs</title>
<link type="text/css" rel="stylesheet" href="../css/everest.css"/>
</head>
<body>
<!-- Navbar -->
<div class="sidenav">
<a href="../index.html">Home</a>
<a href="../about.html">About</a>
<a href="../install.html">Install</a>
<a href="https://git.everestlinux.org/EverestLinux/glacier-pkgs">Packages</a>
<a href="../download.html">Downloads</a>
<a href="home.html">Docs</a>
<a href="https://git.everestlinux.org/EverestLinux/wiki">Wiki</a>
<a href="../errata.html">Errata</a>
<a href="https://git.everestlinux.org">Git</a>
</div>
<!-- Rest of page -->
<div class="main">
<h2>Docs</h2>
<p>Welcome to the Everest Linux documentation homepage.</p>
<script>
function myFunction() {
var input, filter, ul, li, a, i, txtValue;
input = document.getElementById('myInput');
filter = input.value.toUpperCase();
ul = document.getElementById("myUL");
li = ul.getElementsByTagName('li');
for (i = 0; i < li.length; i++) {
a = li[i].getElementsByTagName("a")[0];
txtValue = a.textContent || a.innerText;
if (txtValue.toUpperCase().indexOf(filter) > -1) {
li[i].style.display = "";
} else {
li[i].style.display = "none";
}
}
}
</script>
<input type="text" id="myInput" onKeyup="myFunction()" placeholder="Search...">
<ul id="myUL">
<li><a href="general-recommendations.html">General Recommendations</a></li>
<li><a href="intro-to-glacier.html">Introduction to Glacier</a></li>
<li><a href="musl-or-glibc.hmtl">musl or glibc?</a></li>
</ul>
</div>
<footer>
<p>Copyright (C) 2021-2023 Everest Linux</p>
<p>Linux (R) is a registered trademark of Linus Torvalds.</p>
<p>Everest Linux is provided AS IS, WITHOUT WARRANTY.</p>
</footer>

194
docs/intro-to-glacier.html Normal file
View File

@ -0,0 +1,194 @@
<!DOCTYPE html>
<html>
<head>
<title>Everest Linux - Docs</title>
<link type="text/css" rel="stylesheet" href="../css/everest.css"/>
</head>
<body>
<!-- Navbar -->
<div class="sidenav">
<a href="../index.html">Home</a>
<a href="../about.html">About</a>
<a href="../install.html">Install</a>
<a href="https://git.everestlinux.org/EverestLinux/glacier-pkgs">Packages</a>
<a href="../download.html">Downloads</a>
<a href="home.html">Docs</a>
<a href="https://git.everestlinux.org/EverestLinux/wiki">Wiki</a>
<a href="../errata.html">Errata</a>
<a href="https://git.everestlinux.org">Git</a>
</div>
<!-- Rest of page -->
<div class="main">
<button onclick="window.location.href='home.html';">
Back to home
</button>
<h2>Introduction</h2>
<p>Glacier is the package management system for Glacier. All users should be familiar with how it works.</p>
<h2>Terminology</h2>
<p>In this case, the word 'merge' and 'install' mean the same thing.</p>
<p>A package index is a list of all installed packages on any given Everest system.</p>
<p>The local index is managed by all users on the system, and is located in /usr/glacier/index.</p>
<p>The global index is managed by Git, and is located in /glacier/index.</p>
<p>A system profile describes your base system, including C library, architecture, SELinux support, multilib support, etc.</p>
<h2>Included programs</h2>
<p><strong>3.1 </strong>gpkg</p>
<p>'gpkg' is the program most users will be interacting with. It handles the downloading, installation, and logging of packages.</p>
<p><strong>3.2 </strong>syspkg</p>
<p>'syspkg' is like 'gpkg', except it operates on the system index, rather than the local index. End users should not use this unless instructed to.</p>
<p><strong>3.3 </strong>glist</p>
<p>'glist' lists all installed packages, allowing the user to filter by name.
<p><strong>3.4 </strong>gquery</p>
<p>'gquery' queries information on a package.</p>
<p><strong>3.5 </strong>glacier-mkprofile</p>
<p>'glacier-mkprofile' makes changes to the system-wide profile. Users should not interact with this unless needed.</p>
<h2>Merging packages</h2>
<p><strong>4.1 </strong>Using gpkg</p>
<p>To merge a package from a repository:</p>
<code>(root)# gpkg -f repo/pkg</code>
<p>For instance, to install 'vim' in the 'world' repository:</p>
<code>(root)# gpkg -f world/vim</code>
<p><strong>4.2 </strong>Using syspkg</p>
<p>Using 'syspkg' is not recommended for end users because all changes to the global package index will be overwritten when pulling a new update.</p>
<p>If you understand these risks, and wish to use 'syspkg' anyways, you are acknowledging that things may break.</p>
<p>To merge a package from a repository:</p>
<code>(root)# syspkg -f repo/pkg</code>
<h2>Updating packages</h2>
<p><strong>5.1 </strong>Introduction</p>
<p>When merging a package into any index, the package file is retained in said index. This provides most information needed to keep track of the package, however, when updating, an updated package file will need to be downloaded. Old package files will be retained as 'pkgname.old'.</p>
<p><strong>5.2 </strong>Using gpkg</p>
<p>To update a package:</p>
<code>(root)# gpkg -u repo/pkg</code>
<p><strong>5.3 </strong>Using syspkg</p>
<p>As mentioned above, 'syspkg' is intended for system development, and NOT for end users.</p>
<p>However, 'syspkg -u' has some use cases for end users. These include:</p>
<ul>
<li>Updating a system program WITHOUT pulling a new release from Git</li>
<li>Fixing urgent security vulnerabilities</li>
</ul>
<p>To update a package:</p>
<code>(root)# syspkg -u repo/pkg</code>
<h2>Removing packages</h2>
<p><strong>6.1 </strong>Introduction</p>
<p>When removing a package, the package info file is moved from the appropriate index to /tmp, and saved as 'pkgname.rm'. This means it will be wiped after the next reboot.</p>
<p><strong>6.2 </strong>Using gpkg</p>
<p>To remove a package:</p>
<code>(root)# gpkg -x pkg</code>
<p>Note that no repository name was provided. It is not required, as no files will be downloaded during the removal process.</p>
<p>If a package is a dependency for another, you will be shown the following error:</p>
<code>[x] Could not remove (package_name): is a dependency for (package_name)</code>
<p><strong>6.3 </strong>Using syspkg</p>
<warnhead><strong>WARNING:</strong></warnhead>
<div class="warning">
<p>Removing packages that shipped with the system images WILL cause catastrophic damage. You have been warned.</p>
</div>
<p>If you wish to proceed anyways, you can remove a package with:</p>
<code>(root)# syspkg -x pkg</code>
<h2>Advanced usage</h2>
<p><strong>7.1 </strong>Patching packages</p>
<p>Patching packages is the act of editing a package file to change compile options, optimizations, etc. It is very useful if used correctly.</p>
<p>The officially tested and verified method for patching is as follows:</p>
<ul>
<li>Download the package file with 'gpkg -d'</li>
<li>Edit the package file with a text editor of your choice</li>
<li>Install the locally modified package with 'gpkg -fl pkg'</li>
</ul>
<p><strong>7.2 </strong>Custom package repository</p>
<p>If Glacier's standard package repository is not sufficient, you can use a custom one.</p>
<warnhead><strong>WARNING:</strong></warnhead>
<div class="warning">
<p>Ensure the repository you wish to migrate to supports your system profile. For example, if your profile is 'x86-musl', the new repository should offer packages compatible with 'x86-musl'.</p>
<p>Errors will occur if this is not taken into account.</p>
</div>
<p>To use a custom repository once, to merge a package:</p>
<code>(root)# GREPO=http://some-repo.org gpkg -f repo/pkg</code>
<p>To make the changes persistent, change the 'GREPO' variable in '/etc/glacier.conf':</p>
<fhead><strong>FILE:</strong> /etc/glacier.conf</fhead>
<div class="file">
<p>GREPO="https://some-repo.org</p>
</div>
<p><strong>7.3 </strong>Compile flags</p>
<p>When an operation is performed on a package, 'gpkg' invokes the system's C compiler, which can take flags for compilation.</p>
<p>'MAKEFLAGS', 'CFLAGS', 'CXXFLAGS', and 'LDFLAGS' can be set in '/etc/make.conf'.</p>
<p>It is highly recommended to keep '-static' in 'CFLAGS' and 'LDFLAGS'.</p>
<p><strong>7.4 </strong>Using syspkg</p>
<p>'syspkg' is intended for development use and not for end users. That being said, 'syspkg' can be used for fixing security vulnerabilities without pulling in a new release from git.</p>
<p>Note that all changes to the global package index ('/glacier/index') will be overwritten during an update, where the user invokes 'git pull' on '/'.</p>
<p><strong>7.5 </strong>Whitelisting licenses</p>
<p>Certain license types can be whitelisted or blacklisted. This is useful for controlling which software is installed on your system.</p>
<h2>Querying packages</h2>
<p><strong>8.1 </strong>Introduction</p>
<p>Glacier packages, in ther simplest form, are text files, containing instructions on how the package is built, who made it, what it's called, and what files it includes.</p>
<p><strong>8.2 </strong>Querying files</p>
<p>All files belonging to a package can be listed with:</p>
<code>(user)$ gquery -f pkg</code>
<p><strong>8.3 </strong>Querying info</p>
<p>Package info can be listed with:</p>
<code>(user)$ gquery -i pkg</code>
<h2>Writing packages</h2>
<p><strong>9.1 </strong>Introduction</p>
<p>As mentioned before, Glacier packages are simply text files. This makes them very easy to write and maintain.</p>
<p>If you have previous experience writing PKGBUILDs for the AUR, writing Glacier packages should feel very similar.</p>
<p>In this page, 'nano' will be used as an example.</p>
<p><strong>9.2 </strong>Metadata</p>
<p>Package files start with metadata, which tells Glacier who made the package, what its called, as well as other information.</p>
<p>Double check that all of this information is correct before submitting a package.</p>
<fhead><strong>FILE:</strong> $(pwd)/nano</fhead>
<div class="file">
<p>PACKAGE_NAME="nano"</p>
<p>PACKAGE_VER="7.2"</p>
<p>PACKAGE_DESC="The GNU nano text editor"</p>
<p>MAINTAINER="liamwaldron@everestlinux.org"</p>
<p>LICENSE="GPL v3"</p>
<p>ARCH="x86"</p>
<p>INCLUDED_FILES=("/usr/bin/nano" "/usr/bin/rnano")</p>
</div>
<p>Hopefully, most of these options are self explanatory.</p>
<p>For INCLUDED_FILES, ensure you DON'T include documentation (manpages, etc).</p>
<p><strong>9.3 </strong>Integrity information</p>
<fhead><strong>FILE:</strong> $(pwd)/nano</fhead>
<div class="file">
<p>SHA256SUMS="86f3442768bd2873cec693f83cdf80b4b444ad3cc14760b74361474fc87a4526"</p>
</div>
<p>All packages must include their checksums. When merging a package, 'gpkg' will check the provided checksum against the actual checksum of the package, and if they don't match, the operation will be cancelled.</p>
<p>To get the checksum of a package:</p>
<code>(user)$ sha256sum package</code>
<p><strong>9.4 </strong>Dependency information</p>
<fhead><strong>FILE:</strong> $(pwd)/nano</fhead>
<div class="file">
<p>DEPENDS=("")</p>
<p>CONFLICTS=("")</p>
</div>
<p>Dependency information is extremely important. It allows 'gpkg' to install any dependencies. It also warns the user when a package conflicts with another.</p>
<p>This should be fairly easy to figure out. Most projects will have this listed in their README. If you're the developer, you'll probably already know the dependencies your package requires.</p>
<p><strong>9.5 </strong>Source information</p>
<fhead><strong>FILE:</strong> $(pwd)/nano</fhead>
<div class="file">
<p>PACKAGE_SRC="https://nano-editor.org/dist/v7/nano-7.2.tar.xz</p>
<p>SOURCES=("nano-7.2.tar.xz" "nano-7.2"</p>
</div>
<p>PACKAGE_SRC shows Glacier where the sources for the program can be downloaded from.</p>
<p>SOURCES shows Glacier what PACKAGE_SRC downloads.</p>
<p><strong>9.6 </strong>Functions</p>
<fhead><strong>FILE:</strong> $(pwd)/nano</fhead>
<div class="file">
<p>getsource() {}</p>
<p>buildpkg() {}</p>
<p>installpkg() {}</p>
<p>installpkg_system() {}</p>
<p>removepkg() {}</p>
<p>removepkg_system() {}</p>
<p>updatepkg() {}</p>
<p>updatepkg_system() {}</p>
</div>
<p>Inside of the brackets, enter the commands that are needed to perform each function.</p>
<p>Anything prefixed with "system" refers to the use of 'syspkg'.</p>
</div>
<footer>
<p>Page last updated 4/04/23 @ 13:19</p>
<p>Page licensed under GNU Free Documentation License 1.3 or later</p>
<p>--------------------</p>
<p>Copyright (C) 2021-2023 Everest Linux</p>
<p>Linux (R) is a registered trademark of Linus Torvalds.</p>
<p>Everest Linux is provided AS IS, WITHOUT WARRANTY.</p>
</footer>

34
docs/template.html Normal file
View File

@ -0,0 +1,34 @@
<!DOCTYPE html>
<html>
<head>
<title>Everest Linux - Docs</title>
<link type="text/css" rel="stylesheet" href="../css/everest.css"/>
</head>
<body>
<!-- Navbar -->
<div class="sidenav">
<a href="../index.html">Home</a>
<a href="../about.html">About</a>
<a href="../install.html">Install</a>
<a href="https://git.everestlinux.org/EverestLinux/glacier-pkgs">Packages</a>
<a href="../download.html">Downloads</a>
<a href="home.html">Docs</a>
<a href="https://git.everestlinux.org/EverestLinux/wiki">Wiki</a>
<a href="../errata.html">Errata</a>
<a href="https://git.everestlinux.org">Git</a>
</div>
<!-- Rest of page -->
<div class="main">
<button onclick="window.location.href='home.html';">
Back to home
</button>
</div>
<footer>
<p>Page last updated MM/DD/YY @ HH:MM</p>
<p>Page licensed under GNU Free Documentation License 1.3 or later</p>
<p>--------------------</p>
<p>Copyright (C) 2021-2023 Everest Linux</p>
<p>Linux (R) is a registered trademark of Linus Torvalds.</p>
<p>Everest Linux is provided AS IS, WITHOUT WARRANTY.</p>
</footer>

1
download.html
View File

@ -12,6 +12,7 @@
<a href="install.html">Install</a>
<a href="https://git.everestlinux.org/EverestLinux/glacier-pkgs">Packages</a>
<a href="download.html">Downloads</a>
<a href="docs/home.html">Docs</a>
<a href="https://git.everestlinux.org/EverestLinux/wiki">Wiki</a>
<a href="errata.html">Errata</a>
<a href="https://git.everestlinux.org">Git</a>

1
errata.html
View File

@ -12,6 +12,7 @@
<a href="install.html">Install</a>
<a href="https://git.everestlinux.org/EverestLinux/glacier-pkgs">Packages</a>
<a href="download.html">Downloads</a>
<a href="docs/home.html">Docs</a>
<a href="https://git.everestlinux.org/EverestLinux/wiki">Wiki</a>
<a href="errata.html">Errata</a>
<a href="https://git.everestlinux.org">Git</a>

1
index.html
View File

@ -12,6 +12,7 @@
<a href="install.html">Install</a>
<a href="https://git.everestlinux.org/EverestLinux/glacier-pkgs">Packages</a>
<a href="download.html">Downloads</a>
<a href="docs/home.html">Docs</a>
<a href="https://git.everestlinux.org/EverestLinux/wiki">Wiki</a>
<a href="errata.html">Errata</a>
<a href="https://git.everestlinux.org">Git</a>

1
install.html
View File

@ -12,6 +12,7 @@
<a href="install.html">Install</a>
<a href="https://git.everestlinux.org/EverestLinux/glacier-pkgs">Packages</a>
<a href="download.html">Downloads</a>
<a href="docs/home.html">Docs</a>
<a href="https://git.everestlinux.org/EverestLinux/wiki">Wiki</a>
<a href="errata.html">Errata</a>
<a href="https://git.everestlinux.org">Git</a>

1
template.html
View File

@ -12,6 +12,7 @@
<a href="install.html">Install</a>
<a href="https://git.everestlinux.org/EverestLinux/glacier-pkgs">Packages</a>
<a href="download.html">Downloads</a>
<a href="docs/home.html">Docs</a>
<a href="https://git.everestlinux.org/EverestLinux/wiki">Wiki</a>
<a href="errata.html">Errata</a>
<a href="https://git.everestlinux.org">Git</a>