Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sodaliterocks/sodalite
🪨 A Pantheon experience for rpm-ostree
https://github.com/sodaliterocks/sodalite
elementary fedora fedora-silverblue os ostree pantheon rpm-ostree silverblue
Last synced: about 1 month ago
JSON representation
🪨 A Pantheon experience for rpm-ostree
- Host: GitHub
- URL: https://github.com/sodaliterocks/sodalite
- Owner: sodaliterocks
- License: mit
- Created: 2021-12-28T07:39:32.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-23T22:11:00.000Z (5 months ago)
- Last Synced: 2024-05-21T19:16:25.382Z (4 months ago)
- Topics: elementary, fedora, fedora-silverblue, os, ostree, pantheon, rpm-ostree, silverblue
- Language: Shell
- Homepage: https://sodalite.rocks
- Size: 5.36 MB
- Stars: 193
- Watchers: 6
- Forks: 6
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome_atomic - Sodalite: A Pantheon Experience for Silverblue
README
Sodalite
Sodalite is an immutable desktop OS built with rpm-ostree and on-top of Fedora — similar to Fedora Silverblue — making use of the Pantheon desktop, sticking closely to the ethos and workflow perpetrated by elementary.
---
Hmm, it's been X days since the last commit; is this still active?
Yes.
Despite a very active commit history, Sodalite is fairly self-sustaining these days — mostly thanks to the awesome people at Fyra Labs — and thus the repository will go months without any activity. This does not mean the project is abandoned, especially since it's developer uses it as their main OS. Regardless of repository activity, updates are built twice every week from the repository: logs are available at Actions.
Psst! We're on Telegram too. While you're free to use Discussions, the majority of the discussion relating to this project will happen over on Telegram.
---
## 🎉 Installing
> As rpm-ostree is an ever-evolving technology, and ISO installs are currently a low priority, **ISOs are currently not available**. An existing rpm-ostree-based OS, such as [Fedora Silverblue](https://silverblue.fedoraproject.org/), is required: this OS will be used to "rebase" to Sodalite.
1. Install an rpm-ostree-based version of Fedora, such as [Fedora Silverblue](https://silverblue.fedoraproject.org/), or use an already-existing install
2. Fire up a terminal and issue these commands:
- `sudo ostree remote add --if-not-exists sodalite https://ostree.sodalite.rocks --no-gpg-verify`
- `sudo ostree pull sodalite:sodalite/current/x86_64/desktop`*
- `sudo rpm-ostree rebase sodalite:sodalite/current/x86_64/desktop`
3. Stick the kettle on and make yourself a cuppa. It'll take a while
4. Reboot when prompted. Use it, enjoy it, make something cool with it, (try to) break it — [submit a ticket if you do](https://github.com/sodaliterocks/sodalite/issues/new)!
_* There are multiple branches available; see [Branches](#branches)_.
### Branches
Several branches (or images) of Sodalite co-exist and are developed side-by-side; these are distinguished by their ref — like any other rpm-ostree distro — where `sodalite///`:
#### Current
|**``**|**``**|**``**|Release|Base|Status|
|-|-|-|-|-|-|
|`current`|`x86_64`|`desktop`|**6 Kutai** |[Fedora 39](https://docs.fedoraproject.org/en-US/releases/f39/)|[](https://github.com/sodaliterocks/sodalite/actions/workflows/update__sodalite.current.x86_64.desktop.yml)|
#### Long
|**``**|**``**|**``**|Release|Base|Status|
|-|-|-|-|-|-|
|`long-6`|`x86_64`|`desktop`|**6 Kutai** (Long)|[Fedora 39](https://docs.fedoraproject.org/en-US/releases/f39/)|[](https://github.com/sodaliterocks/sodalite/actions/workflows/update__sodalite.long-6.x86_64.desktop.yml)|
> Unlike **Current** (`current`), these branches do not update to the current major release: **updates will stop the same day as the base Fedora version**. Only use these if necessary (i.e. problematic drivers requiring certain versions, critical systems, etc.)
#### Next
|**``**|**``**|**``**|Release|Base|Status|
|-|-|-|-|-|-|
|`next`|`x86_64`|`desktop`|**6 Kutai** (Next) |[Fedora 39](https://docs.fedoraproject.org/en-US/releases/f39/)|[](https://github.com/sodaliterocks/sodalite/actions/workflows/update__sodalite.next.x86_64.desktop.yml)|
|`next`|`x86_64`|`desktop-gnome`|**7.0rc1 GNOME** (Next) |[Fedora 40](https://docs.fedoraproject.org/en-US/releases/f40/)|[](https://github.com/sodaliterocks/sodalite/actions/workflows/update__sodalite.next.x86_64.desktop-gnome.yml)|
> Early versions of upcoming releases. Unstable. Here be dragons. Abandon all hope. You know the drill.
>
> This may sometimes be at the same version as **Current** (`current`), but be aware you'll be bumped to an upcoming release without warning if/when released to this branch.
### Versioning
_(Todo)_
## 🔄 Updating
Performing a system update can be done by either:
* Running `sudo rpm-ostree upgrade` in a shell
* Opening **Software**, selecting **Updates** from the headerbar, and pressing **Update All**
- As Software runs in the background and periodically checks for updates, you may also receive a notification of a new update; clicking on this opens the appropriate page
- An update for the OS may take a while to appear in Software (which will appear as "Operating System Updates"), so the above method is preferred
Reboot after either method has finished. You can verify the version installed by opening **System Settings** and navigating to **System ➔ Operating System**: the version proceeds the word "Sodalite"
If something breaks, you can rollback by running `sudo rpm-ostree rollback` at a terminal. Remember to also [create a new issue](https://github.com/sodaliterocks/sodalite/issues/new) if appropriate!
#### Update Schedule
Updates are built on the build server commencing **4:00 GMT/±0** **(22:00 CST/-6)** every **Wednesday** and **Saturday**.
#### "Long-term" Branches
If you chose to use a "long-term" branch (see Branches above), you will need to rebase whenever the Sodalite version reaches end-of-life. This can be done with `sudo rpm-ostree rebase sodalite:sodalite///`, where `` is the version you're wanting to rebase to and other values are your current values.
It's vital you carry out this process as updates stop the day the base version reaches end-of-life (at the same time as the base Fedora Linux version) and you will be left without updates to vital system components.
---
## 🏗️ Building
### 1. Prerequisites
#### Software
##### Containerized (with `--container`/`-c`)
_Running in a container is the preferred way of building Sodalite_
* Linux
* [Podman](https://podman.io/)
- To use Docker instead, pass `--ex-use-docker`. **Running in Docker is entirely untested and experimental!**
* Bash
* [Git LFS](https://git-lfs.com/)
- As well as including pretty wallpapers, the LFS also includes vital binaries that Sodalite needs to work properly, so don't miss installing this!
- Unsure if you have LFS support? Tpe `git lfs`: a help output prints if installed
##### OS-level
_If you don't have Podman, or are having issues with running in a container, you can try running on the host itself_
* [Fedora Linux](https://getfedora.org/) (or other Fedora-based/compatible distros)
* [rpm-ostree](https://coreos.github.io/rpm-ostree/)
- On most Fedora-based distros, this can be installed with `dnf install rpm-ostree`
* Bash
* [Git LFS](https://git-lfs.com/)
- As well as including pretty wallpapers, the LFS also includes vital binaries that Sodalite needs to work properly, so don't miss installing this!
- Unsure if you have LFS support? Tpe `git lfs`: a help output prints if installed
#### Environment
* Permission to `sudo`
- Do not run `sudo ./build.sh`: the script will ask for permission when it needs it
- Whether or not you run containerized, **you must have access to `sudo`**
* >10GiB disk space
- The repository itself (including submodules) takes up ~300MiB
- Initial builds will take up ~4GiB, with subsequent builds adding to this
* Unlimited Internet
- The build process caches **a lot** of Fedora packages (around 2.5GiB), so think carefully about doing this on mobile broadband or any other service that imposes a small data allowance on you
* An rpm-ostree-based distro, such as such as [Fedora Silverblue](https://silverblue.fedoraproject.org/) — on either a virtual machine, another physical machine, or your current install (careful!) — to test builds on
* A cuppa _(optional)_ — this can take a while
### 2. Getting
```sh
git clone https://github.com/sodaliterocks/sodalite.git
cd sodalite
git submodule sync
git submodule update --init --recursive
```
#### Future Pulls
When updating in the future, don't forget to update submodules with:
```sh
git submodule update --recursive
```
**Do not** use `git submodule foreach git pull`: this blindly updates all submodules to their latest version, not the commit this parent repo has checked out. This is important for some submodules that are checked out at specific tags/commits (such as `./lib/sodaliterocks.firefox`).
The `./lib/workstation-ostree-config_f*` submodules — serving as a basis for Sodalite for its various different Fedora-based versions — are removed every so often so make sure you delete them accordingly. For example, when Fedora 36 reaches EoL, `./lib/workstation-ostree-config_f36` will be removed shortly afterwards. You can use `git clean -i` to do the work for you.
#### LFS
An LFS submodule is located at `./lfs`. It's important to note this is not hosted on GitHub, but [Zio Git](https://git.zio.sh) — a server we control — as GitHub's LFS allowances are tight ([only 1GiB bandwidth and storage](https://docs.github.com/en/repositories/working-with-files/managing-large-files/about-storage-and-bandwidth-usage)).
Any issues regarding the LFS should be submitted to [sodaliterocks/sodalite on GitHub](https://github.com/sodaliterocks/sodalite). Currently, as Zio Git does not allow for arbitrary sign-ups, PRs cannot be directly submitted.
#### Usage of GitHub
Unless the world collectively favours GitLab, or anything else, Sodalite will stay on GitHub as it makes everyone's lives easier. Microsoft is just another company; they're not going to hurt you.
### 3. Building
```sh
./build.sh [-t ] [-w ]
```
_See `build.sh --help` for more options._
This will usually take 10-15 minutes. Remember when I told you to grab a cuppa? Or maybe a cold one?
##### Arguments
* `` _(optional)_ Edition/variant of Sodalite (defaults to `custom`)
- This is any of the `sodalite-.yaml` files listed in `./src/treefiles/`. Either use `sodalite-` or just `` as the argument. Currently, there is:
- `desktop`: Standard Pantheon desktop
- `desktop-gnome`: Alternate GNOME desktop, intended for possible future versions
- `custom`: See below point
- `sodalite-custom.yaml` is a good place to employ your own changes instead of modifying any of the other treefiles
* `` _(optional)_ Directory for build output (defaults to `./build`)
#### Additional Notes
##### Building in a Container
If you have [Podman](https://podman.io/), you can build Sodalite entirely in a container: just use `-c`/`--container`. This is in fact how builds are done on the release server! However, this will add an extra few minutes for the build to complete as the Fedora container needs to install packages first.
##### NTFS/FAT partitions
Build failures are inevitable on drives formatted as NTFS, FAT, or anything other filesystems that do not support Unix-like permissions, as `build.sh` sets permissions on various objects.
###### WSL2
On WSL2, do not build to any `/mnt/` directories as these will be formatted as NTFS or FAT. Instead, run the build somewhere else on the Linux distro itself (like `$HOME` or `/usr/local/src`).
##### Not using `build.sh`
Most rpm-ostree distros can be built just be simply doing `rpm-ostree compose`, but `build.sh` provided with Sodalite does some extra steps which are required for the post-build script (which **will** fail without these being ran). It is therefore not recommended to do it this way: any issues building the distro this way will be closed and marked as invalid.
#### Cleaning Up
Build contents is located at `./build/` (or whatever you set `` to), which can be deleted to start afresh. Specifically this holds the following files/directories (of which can be individually deleted instead):
* `./build/repo/` — OSTree repository for Sodalite
* `./build/cache/` — Cache for Fedora packages
Unless stopped manually, `build.sh` will clean itself up whenever it exits (on both success and failure). It will correct permissions (to your user) for the `./build/` directory, as well as removing the following files/directories:
* `./src/sysroot/common/usr/lib/sodalite-buildinfo`
* `/var/tmp/rpm-ostree.*/`
- This can get large quickly; watch out if you're not letting `build.sh` exit
### 4. Using
_(todo)_
---
## 🤝 Acknowledgements
### Individuals
* [Jorge O. Castro](https://github.com/castrojo), for including Sodalite in [awesome-immutable](https://github.com/castrojo/awesome-immutable)
* [Timothée Ravier](https://tim.siosm.fr), for their extensive guidance to the community concerning Fedora Silverblue
* The amazing photographers/artists of the included wallpapers — [Adrien Olichon](https://unsplash.com/@adrienolichon), [Ashwini Chaudhary](https://unsplash.com/@suicide_chewbacca), [Austin Neill](https://unsplash.com/@arstyy), [Cody Fitzgerald](https://unsplash.com/@cfitz), [David Becker](https://unsplash.com/@beckerworks), [Dustin Humes](https://unsplash.com/@dustinhumes_photography), [Eugene Golovesov](https://unsplash.com/@eugene_golovesov), [Jack B.](https://unsplash.com/@nervum), [Jeremy Gerritsen](https://unsplash.com/@jeremygerritsen), [Karsten Würth](https://unsplash.com/@karsten_wuerth), [Marek Piwnicki](https://unsplash.com/@marekpiwnicki), [Max Okhrimenko](https://unsplash.com/@maxokhrimenko), [Nathan Dumlao](https://unsplash.com/@nate_dumlao), [Piermanuele Sberni](https://unsplash.com/@piermanuele_sberni), [Phil Botha](https://unsplash.com/@philbotha), [Ryan Stone](https://unsplash.com/@rstone_design), [Rodion Kutsaiev](https://unsplash.com/@frostroomhead), [Smaran Alva](https://unsplash.com/@smal), [Takashi Miyazaki](https://unsplash.com/@miyatankun), [Willian Daigneault](https://unsplash.com/@williamdaigneault), and [Zara Walker](https://unsplash.com/@mojoblogs)
#### Past Individuals
_These fine folks' work is no longer included in, or relevant to, Sodalite, but they're still worth a shout-out!_
* [Fabio "decathorpe" Valentini](https://decathorpe.com/), for maintaining elementary/Pantheon packages on Fedora
* Due to various packaging issues with Pantheon on Fedora's official repos (see [#44](https://github.com/sodaliterocks/sodalite/issues/44), and [writing (about) code ➔ elementary-stable](https://decathorpe.com/fedora-elementary-stable-status.html)), these packages were dropped entirely (including the addtional ~~[elementary-staging](https://copr.fedorainfracloud.org/coprs/decathorpe/elementary-staging/)~~ and ~~[elementary-nightly](https://copr.fedorainfracloud.org/coprs/decathorpe/elementary-nightly/)~~ Copr repos, dropped in Feb '23). Despite this, decathorpe's contributions are essentially what sparked Sodalite in the first place.
* ["Topfi"](https://github.com/ACertainTopfi), for their various contributions
### Teams & Organizations
* [elementary](https://elementary.io/team), for building lovely stuff
* [Fyra Labs](https://fyralabs.com), for maintaining [Terra](https://terra.fyralabs.com/)
* Due to various packaging issues with Pantheon on Fedora's official repos (see [#44](https://github.com/sodaliterocks/sodalite/issues/44)), Sodalite was almost doomed after f36+ reached EoL. However, Terra maintains builds of Pantheon and effectively keeps the lights on here!
* The contributors to [workstation-ostree-config](https://pagure.io/workstation-ostree-config), for a solid ground to work from
### Miscellaneous
* The [Sodalite mineral](https://en.wikipedia.org/wiki/Sodalite), for the name. [It's a mineral, not a rock, Jesus](https://www.youtube.com/watch?v=r1yYJBzf1VQ)!
* The [Omicron variant of SARS-CoV-2](https://en.wikipedia.org/wiki/SARS-CoV-2_Omicron_variant), for giving [Ducky](https://github.com/electricduck) the initial free time to make this thing
## 👀 See Also
* **[📄 Code of Conduct](CODE_OF_CONDUCT.md)** — Contributor Covenant CoC
* **[📄 Contributing](CONTRIBUTING.md)**
* **[📄 License](LICENSE)** — MIT, © 2023 Sodalite contributors
### Related
* **[🔗 Fedora Docs ➔ Fedora Silverblue User Guide](https://docs.fedoraproject.org/en-US/fedora-silverblue/)**
---