Skip to content

Commit

Permalink
Update aegis-tui docs
Browse files Browse the repository at this point in the history
  • Loading branch information
D3vil0p3r committed Jan 26, 2024
1 parent 4d9ccd3 commit 921ce6f
Show file tree
Hide file tree
Showing 31 changed files with 95 additions and 76 deletions.
1 change: 1 addition & 0 deletions astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ export default defineConfig({
label: 'Configuration',
items: [
// Each item here is one entry in the navigation menu.
{ label: 'Aegis Installer TUI', link: '/en/configuration/aegis-tui' },
{ label: 'Calamares Installer', link: '/en/configuration/calamares' },
{ label: 'Kernel', link: '/en/configuration/kernel' },
{ label: 'Shell', link: '/en/configuration/shell' },
Expand Down
Binary file added src/assets/images/aegis-tui-browser.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/images/aegis-tui-desktop.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/images/aegis-tui-dm.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/images/aegis-tui-finish.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/images/aegis-tui-hostname.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/images/aegis-tui-install-confirm.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/images/aegis-tui-install-cores.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/images/aegis-tui-install-jobs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/images/aegis-tui-install-keep.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/images/aegis-tui-keymap.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/images/aegis-tui-locale.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/images/aegis-tui-misc.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/images/aegis-tui-partitioning-mode.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/images/aegis-tui-password-root.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/images/aegis-tui-password-verify.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/images/aegis-tui-password.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/images/aegis-tui-shell.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/images/aegis-tui-summary.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/images/aegis-tui-terminal.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/images/aegis-tui-theme.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/images/aegis-tui-timezone.png
Binary file added src/assets/images/aegis-tui-username.png
Binary file added src/assets/images/aegis-tui.png
154 changes: 78 additions & 76 deletions src/content/docs/en/configuration/aegis-tui.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,123 +23,125 @@ Open the terminal and run:
```
aegis-tui
```
![Aegis TUI](@assets/images/aegis-tui.png)

#### Language
Availability: Easy and Advanced Installation.
#### Timezone

1. Select the language
![System Language](@assets/images/calamares-welcome-offline.png)
1. Select the timezone
![System Timezone](@assets/images/aegis-tui-timezone.png)

#### Kernel
Availability: Advanced Installation.
#### Keymap

2. Select your favourite kernel
![System Kernel](@assets/images/calamares-kernel.png)
2. Select the keymap
![System Keymap](@assets/images/calamares-kernel.png)

:::note
The Easy Installation will implement **Linux Zen kernel** by default.
:::

#### Environment
Availability: Advanced Installation.
#### Locale

3. Select your favourite environment
![System Environment](@assets/images/calamares-environment.png)
3. Select the locale
![System Locale](@assets/images/aegis-tui-locale.png)

:::note
The Easy Installation will install **GNOME environment** by default.
:::

#### Theme
Availability: Advanced Installation.
#### Users

4. Select your favourite theme
![System Theme](@assets/images/calamares-theme.png)
4. Set your user account
![User Account](@assets/images/aegis-tui-username.png)

:::note
The Easy Installation will install **Blue Eyes theme** by default.
:::
Set your password
![User Password](@assets/images/aegis-tui-password.png)
![User Verify Password](@assets/images/aegis-tui-password-verify.png)

#### Login Manager
Availability: Advanced Installation.
Choose if the inserted password should be the same for the root account too
![User Same Root Password](@assets/images/aegis-tui-password-root-same.png)

5. Select your favourite display manager for login
![System Login](@assets/images/calamares-login.png)

:::note
The Easy Installation will install **GNOME Display Manager** by default.
:::
If choose **No**, set a password for the root account
![Root Password](@assets/images/aegis-tui-password-root.png)
![Root Verify Password](@assets/images/aegis-tui-password-root-verify.png)

#### Shell
Availability: Advanced Installation.

6. Select your favourite shell
![System Shell](@assets/images/calamares-shell.png)
5. Select your favourite shell
![System Shell](@assets/images/aegis-tui-shell.png)

:::note
The Easy Installation will install **Bash** by default.
:::
#### Hostname

#### Terminal
Availability: Advanced Installation.
6. Set the hostname
![System Hostname](@assets/images/aegis-tui-hostname.png)

7. Select your favourite terminal
![System Terminal](@assets/images/calamares-terminal.png)
#### Partitioning

:::note
The Easy Installation will install **GNOME Terminal** by default.
:::
7. Select your partition according to the installation type you are going to. Check the **Installation** chapter related to your setup and follow there the partition scheme to implement:
* [Installing as single boot](/en/installation/install-single-boot/#partitioning)
* [Viirtual Machine scenario](/en/installation/install-single-boot/#partitioning)
* [Installing as dual boot with Linux or Windows](/en/installation/install-dual-boot/#partitioning)

#### Browser
Availability: Advanced Installation.
#### Desktop

8. Select your favourite browser
![System Browser](@assets/images/calamares-browser.png)
8. Select your favourite theme
![System Desktop](@assets/images/athena-tui-desktop.png)

:::note
The Easy Installation will install **Firefox ESR** by default.
:::
#### Theme

#### Utilities
Availability: Advanced Installation.
9. Select your favourite theme
![System Theme](@assets/images/athena-tui-theme.png)

9. Select your favourite utilities
![System Utilities](@assets/images/calamares-utilities.png)
#### Login Manager

#### Location
Availability: Easy and Advanced Installation.
10. Select your favourite display manager for login
![System Login](@assets/images/athena-tui-dm.png)

10. Select your location and timezone
![System Location and Timezone](@assets/images/calamares-location.png)
#### Browser

#### Keyboard
Availability: Easy and Advanced Installation.
11. Select your favourite browser
![System Browser](@assets/images/athena-tui-browser.png)

11. Select your keyboard layout
![System Keyboard](@assets/images/calamares-keyboard.png)
#### Terminal

#### Users
Availability: Easy and Advanced Installation.
12. Select your favourite terminal
![System Terminal](@assets/images/athena-tui-terminal.png)

12. Set your user account
![System Keyboard](@assets/images/calamares-users.png)
#### Miscellaneous Settings

#### Partition
Availability: Easy and Advanced Installation.
13. Select your favourite settings by using **Space** key button and confirm by **Enter**
![System Settings](@assets/images/athena-tui-misc.png)

13. Select your partition according to the installation type you are going to. Check the **Installation** chapter related to your setup and follow there the partition scheme to implement:
* [Installing as single boot](/en/installation/install-single-boot/#partitioning)
* [Installing as dual boot with Linux or Windows](/en/installation/install-dual-boot/#partitioning)

For virtual machine scenarios, just select **Erase disk**
![VM Erase Disk](@assets/images/calamares-vm-erase.png)
:::note
Currently these settings are still not implemented, so their choice are uneffective.
:::

14. Review the **Summary** and run the installation.
![Install Summary](@assets/images/athena-tui-summary.png)

15. Select the install parameters for the installation process
![Install Set Cores](@assets/images/athena-tui-install-cores.png)
![Install Set Jobs](@assets/images/athena-tui-install-jobs.png)

During the installation, you can click on **Toggle log** button for reading in real time the installation logs. In case the installation gets some issues, Calamares provides to you a link to https://termbin.com where the logs are temporary saved in order to be accessed by the Athena OS team for troubleshooting.
Select if the installation should continue even if the building process of a software can fail
![Install Keep Going](@assets/images/athena-tui-install-keep.png)

Finally, if you are ready to install, proceed
![Install Confirm](@assets/images/athena-tui-install-confirm.png)

During the installation, installation logs are saved in `/tmp/aegis.log`. In case the installation gets some issues, run:
```
cat /tmp/aegis.log | nc termbin.com 9999
```
to get a link to https://termbin.com where the logs are temporary saved. Communicate this link to Athena OS Team for troubleshooting.

15. If no errors have been raised during the installation phase, you are ready to use Athena OS!

![Installation Finished](@assets/images/calamares-finish.png)
![Installation Finished](@assets/images/aegis-tui-finish.png)

:::note
At the end of a successful installation in an EFI system, you could get a message like:
```
⚠ Mount point '/boot' which backs the random seed file is world accessible, which is a security hole! ⚠
⚠ Random seed file '/boot/loader/.#bootctlrandom-seedc5706ea22f8895b0' is world accessible, which is a security hole! ⚠
Random seed file /boot/loader/random-seed successfully written (32 bytes).
```
It is related to all Linux systems, but it should be mitigated by using encrypted partitions. To get more details about this warning, refer to [this resource](https://discourse.nixos.org/t/security-warning-when-installing-nixos-23-11/37636).
:::
<ImageComponent />
16 changes: 16 additions & 0 deletions src/content/docs/en/installation/install-single-boot.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,22 @@ Once you land on the Live Environment, follow the [Calamares Installer](/en/conf

## Partitioning

### Aegis TUI
If you are using Aegis TUI, on **Partitioning**, select **Auto**:
![Aegis TUI Partitioning Auto](@assets/images/aegis-tui-partitioning-mode.png)

Choose if you want to install a Swap partition or not
![Aegis TUI Partitioning Auto Swap](@assets/images/aegis-tui-partitioning-auto-swap.png)

and select the desired swap size
![Aegis TUI Partitioning Auto Swap Size](@assets/images/aegis-tui-partitioning-auto-swap-size.png)

Finally, confirm the partitioning setting you chose
![Aegis TUI Partitioning Auto Confirm](@assets/images/aegis-tui-partitioning-auto-confirm.png)

Then, continue to follow the [Aegis TUI guide](/en/configuration/aegis-tui/#partitioning)

### Calamares
On **Partitions** section, select **Erase disk**. You can choose your favourite **File System** between:
* [BTRFS](https://wiki.archlinux.org/title/btrfs)
* [Ext4](https://wiki.archlinux.org/title/ext4)
Expand Down

0 comments on commit 921ce6f

Please sign in to comment.