alex/nixos
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: refresh README

Browse Source
This commit is contained in:
Alex
2026-07-27 15:24:01 +02:00
parent 0f51bf1abb
commit a9c1ef7272
1 changed files with 35 additions and 76 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+35 -76
View File
@@ -1,93 +1,52 @@
# nixos
# NixOS configuration
Nix flake configuration for NixOS hosts with host-specific modules and Home Manager integration. The declared targets are `dev-vm`, `alex-laptop`, and `alex-desktop`; the flake pins NixOS and Home Manager release 25.05.
## Prerequisites
## Getting started
- NixOS with `nixos-rebuild` available.
- A local hostname that exactly matches one of the declared flake configuration names when using `rebuild.sh`.
- Hardware configuration and storage settings appropriate to the machine being configured.
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
The shared system module enables the `nix-command` and `flakes` experimental features. It also enables services and system settings, so evaluating or switching this configuration is not equivalent to applying a user-only dotfile setup.
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
## Hosts and configuration
## Add your files
- `dev-vm` — VirtualBox guest-oriented configuration.
- `alex-laptop` — laptop-specific modules, hardware configuration, power behaviour, and Home Manager user configuration.
- `alex-desktop` — desktop-specific hardware, graphics, boot, storage, and user configuration.
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
- [ ] [Add files using the command line](https://docs.gitlab.com/topics/git/add_files/#add-files-to-a-git-repository) or push an existing Git repository with the following command:
Host modules contain machine-specific hardware and storage references. Do not copy them to another machine without reviewing and replacing the applicable hardware configuration and boot/storage settings. Keep any secrets or host-specific values outside documentation and review the checked-in configuration before use.
```
cd existing_repo
git remote add origin https://gitlab.com/blankinator/nixos.git
git branch -M main
git push -uf origin main
## Apply a configuration
> **Warning: system-wide operation.** `switch` builds and activates a NixOS system configuration with root privileges. It can change boot, storage, services, users, networking, and desktop behaviour on the current machine.
The supplied helper is:
```sh
./rebuild.sh
```
## Integrate with your tools
It executes:
- [ ] [Set up project integrations](https://gitlab.com/blankinator/nixos/-/settings/integrations)
```sh
sudo nixos-rebuild switch --flake .#$(hostname)
```
## Collaborate with your team
Run it from the repository root only after confirming that `hostname` selects the intended declared host. No repository-provided bootstrap, hardware-installation, rollback, test, or `flake check` workflow is defined; use only procedures appropriate to the target system and retain a known-good boot generation before switching.
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
- [ ] [Set auto-merge](https://docs.gitlab.com/user/project/merge_requests/auto_merge/)
## Validation status
## Test and Deploy
No test suite or flake `checks` definitions were found. Nix was unavailable during the documentation audit, so the flake was not evaluated or built.
Use the built-in continuous integration in GitLab.
There are known static configuration gaps that must be resolved before relying on all targets: `dev-vm` refers to paths that are absent from the repository (`./common.nix` at the flake root and `modules/sway.nix`/`modules/dev.nix` relative to its host module), and the laptop module refers to an absent `thermald-conf.xml`. These findings are static and have not been confirmed by Nix evaluation.
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/)
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
## Repository layout
***
# Editing this README
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
## Suggestions for a good README
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
## Name
Choose a self-explaining name for your project.
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
## License
For open source projects, say how it is licensed.
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
- `flake.nix` and `flake.lock` — flake inputs and named NixOS configurations.
- `rebuild.sh` — hostname-based `nixos-rebuild switch` helper.
- `system/` — shared system configuration and modules.
- `hosts/` — host-specific NixOS, hardware, and user modules.
- `hardware/` — hardware-related modules.
- `user/` — shared Home Manager configuration.