Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 32 additions & 31 deletions docs/packaging/appstream-metainfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ There are a few scenarios that Packagers might encounter:
| 1 | An application already provides appstream metainfo | Nothing to do |
| 2 | An application contains appstream metainfo in the source package but we do not install it | Install the appstream metainfo to `/usr/share/metainfo`. _Example_: [here](https://github.com/getsolus/packages/commit/0a726a53454e7c8a6b0e66de69d59bcc66f0fc19) |
| 3 | An application doesn't contain appstream metainfo in the source package but it exists on Flathub | Borrow and tweak the appstream metainfo from the Flathub repo. Encourage upstream project to add it to their source. _Example_: [here](https://github.com/getsolus/packages/commit/da2f65b93f412da43d1db9edbcb08bb90517a0eb) |
| 4 | An application doesn't provide appstream metainfo and it doesn't exist on flathub | See [here](#writing-appstream-metainfo). _Example_: [here](https://github.com/getsolus/packages/commit/414219d8b2ceeabe85178d3a467f81b9131016f4) |
| 5 | Appstream metainfo is provided but composition of it is failing | See [here](#testing-appstream-metainfo). _Example_: [here](https://github.com/getsolus/packages/commit/583b7c742caf50e2f66a70e9b62e9b91566c03f5). |
| 4 | An application doesn't provide appstream metainfo and it doesn't exist on flathub | See [here](#writing-appstream-metainfo). _Example_: [here](https://github.com/getsolus/packages/commit/414219d8b2ceeabe85178d3a467f81b9131016f4) |
| 5 | Appstream metainfo is provided but composition of it is failing | See [here](#testing-appstream-metainfo). _Example_: [here](https://github.com/getsolus/packages/commit/583b7c742caf50e2f66a70e9b62e9b91566c03f5). |

AppStream metainfo is to be installed in the `/usr/share/metainfo/` directory. It must be placed in the package which should be installed in order to get the software described by the respective metadata. This means that you might need to move the _.metainfo.xml or _.appdata.xml to the right (sub)package.

Expand All @@ -55,15 +55,14 @@ In case your AppStream metainfo is describing a desktop application (you can tel

- Run a report against the extracted install directory.


For general testing, the following command should be sufficient:

```bash
appstreamcli compose install/ --hints-dir=hints --verbose
```

For more advanced testing, such as media generation, e.g. to test font screenshots get auto-generated, run:

```bash
appstreamcli compose install/ --hints-dir=hints --media-dir=media --media-baseurl=localhost:8000 --verbose
```
Expand All @@ -80,7 +79,7 @@ The `appstreamcli compose` tool will normally give good hints about failures but

- A `.desktop` file cannot be matched to the metainfo file.
- By default, the `.desktop` file name must match the `<id>` provided in `.xml` file in `/usr/share/metainfo/`. For example, the if you have `<id>org.foobar.my_package</id>` the `.desktop` file should be called `org.foobar.my_package.desktop`. However, there is an exception to this if the metainfo provides a launchable tag. For example, if the metainfo contains `<launchable type="desktop-id">my_package.desktop</launchable>` then the `.desktop` file can be just called `my_package.desktop`. For more information view the upstream documentation [here](https://www.freedesktop.org/software/appstream/docs/sect-Metadata-Application.html#spec-appdata-introduction).
- No metainfo file is provided.
- No metainfo file is provided.
- No appstream metainfo was found in `/usr/share/metainfo/`.
- Appstream metainfo may exist in `/usr/share/appdata/` but that path is now obsolete and is no longer read from.
- No icon found.
Expand Down Expand Up @@ -111,19 +110,20 @@ It is not necessary to pass all pedantic warnings, but all errors must be rectif
To generate a catalog with appstream generator, a `asgen-config.json` file must be provided.

Here is a example configuration file for running against local repositories.

```json
{
"ProjectName": "Solus",
"ArchiveRoot": "/var/lib/solbuild",
"MediaBaseUrl": "http://localhost:8000/export/media",
"HtmlBaseUrl": "http://localhost:8000/export/html",
"Backend": "solus",
"Suites": {
"local": {
"sections": ["main"],
"architectures": ["x86_64"]
}
"ProjectName": "Solus",
"ArchiveRoot": "/var/lib/solbuild",
"MediaBaseUrl": "http://localhost:8000/export/media",
"HtmlBaseUrl": "http://localhost:8000/export/html",
"Backend": "solus",
"Suites": {
"local": {
"sections": ["main"],
"architectures": ["x86_64"]
}
}
}
```

Expand All @@ -134,25 +134,26 @@ To generate the catalog run `appstream-generator run local --verbose`. Depending
To view the HTML report, you can start a http server with `python3 -m http.server 8000`, enter `http://localhost:8000/` in your web browser, then navigate to `export/html/`.

It can also be ran against a remote repository, here is a sample configuration.

```json
{
"ProjectName": "Solus",
"ArchiveRoot": "https://fastly.getsol.us/repo",
"MediaBaseUrl": "https://appstream.getsol.us/media",
"HtmlBaseUrl": "https://appstream.getsol.us",
"Backend": "solus",
"Suites": {
"gwendraeth": {
"sections": ["main"],
"architectures": ["x86_64"]
},
"gwendraeth-updates": {
"sections": ["main"],
"architectures": ["x86_64"],
"dataPriority": 10,
"baseSuite": "gwendraeth"
}
"ProjectName": "Solus",
"ArchiveRoot": "https://fastly.getsol.us/repo",
"MediaBaseUrl": "https://appstream.getsol.us/media",
"HtmlBaseUrl": "https://appstream.getsol.us",
"Backend": "solus",
"Suites": {
"gwendraeth": {
"sections": ["main"],
"architectures": ["x86_64"]
},
"gwendraeth-updates": {
"sections": ["main"],
"architectures": ["x86_64"],
"dataPriority": 10,
"baseSuite": "gwendraeth"
}
}
}
```

Expand Down
1 change: 1 addition & 0 deletions docs/packaging/monitoring.yaml.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ To add a `monitoring.yaml` file to an existing package you can use the following
`go-task add-monitoring` will automatically fill all the fields if a match is found on [release-monitoring.org](https://release-monitoring.org) and [cpe-guesser.cve-search.org](https://cpe-guesser.cve-search.org).

:::

```bash
go-task add-monitoring
```
Expand Down
4 changes: 2 additions & 2 deletions docs/user/quick-start/boot-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ To make the boot menu appear automatically with a five-second timeout:

## Add kernel parameters

You can add kernel parameters by creating configuration files that `clr-boot-manager` uses when updating kernels.
You can add kernel parameters by creating configuration files that `clr-boot-manager` uses when updating kernels.

To add kernel parameters, do the following:

Expand All @@ -50,7 +50,7 @@ To add kernel parameters, do the following:
echo 'nomodeset' | sudo tee /etc/kernel/cmdline.d/40_nomodeset.conf
```

1. If you want to add multiple parameters, put them on one line with spaces between them in the configuration file.
1. If you want to add multiple parameters, put them on one line with spaces between them in the configuration file.

For example:

Expand Down
14 changes: 7 additions & 7 deletions docs/user/quick-start/kernel-management/add-new-kernels.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@ To install and switch to a different kernel branch, follow these steps:
- Current kernel

```
sudo eopkg install linux-current
```
sudo eopkg install linux-current
```

- LTS kernel
```
sudo eopkg install linux-lts
```

```
sudo eopkg install linux-lts
```

1. Install the necessary kernel modules of the kernel branch you want to try.

Expand Down Expand Up @@ -52,7 +52,7 @@ To install and switch to a different kernel branch, follow these steps:
:::warning Important

On systems with UEFI installations, the boot menu doesn't appear by default.

To display the boot menu, press the <kbd>Space bar</kbd> key repeatedly as your computer starts.

:::
Expand Down
11 changes: 6 additions & 5 deletions docs/user/quick-start/kernel-management/remove-old-kernels.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Remove old kernels
summary: Manage and remove old kernels to free up space on the boot partition.
---

You might need to remove old kernels for various reasons:

- The boot partition is too small for multiple kernel versions
Expand All @@ -25,11 +26,11 @@ To remove old kernels, do the following:
```

This command displays the version of the currently running kernel. For example:

```
6.6.8-290.current
```

Make note of this version.

1. Mount the boot partition.
Expand Down Expand Up @@ -64,9 +65,9 @@ To remove old kernels, do the following:
1. Remove the kernels you don't need.

:::danger Warning

Never remove the kernel your system is using. This is the version you noted in step 1.

:::

```bash
Expand All @@ -83,4 +84,4 @@ To remove old kernels, do the following:

```bash
df -h
```
```
4 changes: 2 additions & 2 deletions docs/user/software/desktops/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Desktop environments
summary: Quick guides on switching between or installing additional desktop environments on Solus
---

Solus offers multiple [desktop environments](https://getsol.us/solus/experiences/): From the feature-rich and modern Budgie to the traditional Xfce experience.
Solus offers multiple [desktop environments](https://getsol.us/solus/experiences/): From the feature-rich and modern Budgie to the traditional Xfce experience.

For the best experience, use the Solus ISO of your preferred desktop environment. You can install additional desktop environments later if you want to experiment with different options.

Expand Down Expand Up @@ -48,4 +48,4 @@ sudo eopkg install -c desktop.xfce

Solus MATE is deprecated. For a fast and lightweight desktop experience, use Solus Xfce.

:::
:::
4 changes: 2 additions & 2 deletions docs/user/software/gaming/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ summary: Learn about the gaming possibilities on Solus, including Linux, Windows

# Gaming

You can play a wide variety of games on Solus:
You can play a wide variety of games on Solus:

- Native Linux Games: Run games developed specifically for the Linux platform.
- Windows Games: Play many Windows games using compatibility layers like Steam (Proton) and Lutris.
Expand All @@ -19,4 +19,4 @@ Many games, particularly those run through Steam (Proton) or Lutris, work well o

Gaming platforms like Lutris, RetroArch, and Steam are available in the package repository. You can also find many open-source games there, such as Freeciv, OpenTTD, Red Eclipse, and Warzone 2100.

Alternatively, you can also install games and applications from FlatHub.
Alternatively, you can also install games and applications from FlatHub.
12 changes: 6 additions & 6 deletions docs/user/software/gaming/steam.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ summary: Install and configure Steam on Solus

# Steam

- To install `steam`, use the Software Center or execute the following command:
- To install `steam`, use the Software Center or execute the following command:

```bash
sudo eopkg install steam
```
```bash
sudo eopkg install steam
```

Steam is also available on Flathub.
Steam is also available on Flathub.

## Running steam games with Nvidia graphics cards

Expand All @@ -20,7 +20,7 @@ If your system has an Nvidia graphics card, install the 32-bit version of the dr
1. Open **Hardware Drivers** (DoFlicky).
2. Select **Also install 32-bit driver**:

![DoFlicky UI](./do-flicky-32-bits.png)
![DoFlicky UI](./do-flicky-32-bits.png)

3. Select the driver of your Nvidia graphics card.
4. Click **Install**.
2 changes: 1 addition & 1 deletion docs/user/software/window-managers/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,4 @@ Labwc is a Wayland-only stacking window manager. To install Labwc on Solus:
sudo eopkg install labwc
```

2. Configure Labwc. For more information, see the [Labwc wiki](https://labwc.github.io/).
2. Configure Labwc. For more information, see the [Labwc wiki](https://labwc.github.io/).
45 changes: 23 additions & 22 deletions docs/user/troubleshooting/boot-rescue/emergency-shell-startup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,35 +24,36 @@ For this procedure, you need:

1. Shut down your system.
1. Boot from a Solus live USB.
1. Mount the partitions of your Solus system.
1. Mount the partitions of your Solus system.

<details>
<BootAndChroot />
</details>
<details>
<BootAndChroot />
</details>

1. Prevent the system from trying to mount unavailable devices.
1. Prevent the system from trying to mount unavailable devices.

<details>
1. Edit `/etc/fstab` using `nano`:
```bash
nano /etc/fstab
```
2. Find all the unavailable devices.
3. Add the `noauto` option to the line corresponding to the unavailable device.
<details>
1. Edit `/etc/fstab` using `nano`:
```bash
nano /etc/fstab
```
2. Find all the unavailable devices.
3. Add the `noauto` option to the line corresponding to the unavailable device.

For example:
For example:

```bash
UUID=XXXXXX /mnt/mydisk exfat noauto,uid=1000,gid=1000,umask=0022 0 0
```
4. Save the file and restart your system.
```bash
UUID=XXXXXX /mnt/mydisk exfat noauto,uid=1000,gid=1000,umask=0022 0 0
```

</details>
4. Save the file and restart your system.

1. Unmount all the Solus partitions.
<details>
<UnmountAll />
</details>
</details>

1. Unmount all the Solus partitions.
<details>
<UnmountAll />
</details>

## What to do next

Expand Down
2 changes: 1 addition & 1 deletion docs/user/troubleshooting/boot-rescue/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ Identify your issue by selecting the scenario that matches your situation:
- [Solus does not appear in the startup menu](./solus-not-in-boot-menu.md)
- [I see an emergency shell or error message during startup](./emergency-shell-startup.mdx)
- [My system won't boot after an update](./system-not-working-after-update.mdx)
- [I changed hardware and now my system won't boot](./system-not-working-hardware-change.mdx)
- [I changed hardware and now my system won't boot](./system-not-working-hardware-change.mdx)
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ To recover your system, you need to mount the Solus root (`/`) partition and all
cryptsetup luksOpen /dev/sdb2 decrypted
```

1. Mount the Solus root partition:
5. Mount the Solus root partition:

- If your drive's type is _lvm_
```bash
Expand All @@ -111,19 +111,19 @@ To recover your system, you need to mount the Solus root (`/`) partition and all
fdisk -o Device,Size,Type -l /dev/sdX
```
- If you have an NVMe drive:

```bash
fdisk -o Device,Size,Type -l /dev/nvme0nX
```

The system displays something similar to this:

```bash
Device Size Type
/dev/sda1 512M EFI System
/dev/sda2 111.3G Linux filesystem
```

In this case, the EFI system partition is `/dev/sda1`

1. Mount the EFI system partition:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
umount -R /target
```
3. If your drive is encrypted:
1. Deactivate your logical volumes and volume groups:
```bash
lvchange -a n /dev/SolusSystem/Swap
lvchange -a n /dev/SolusSystem/Root
vgchange -a n SolusSystem
```
2. Close the LUKS partition:
```bash
cryptsetup luksClose decrypted
```
1. Deactivate your logical volumes and volume groups:
```bash
lvchange -a n /dev/SolusSystem/Swap
lvchange -a n /dev/SolusSystem/Root
vgchange -a n SolusSystem
```
2. Close the LUKS partition:
```bash
cryptsetup luksClose decrypted
```
Loading
Loading