foodogsquared/nixos-config
1
0
Fork 0
mirror of https://github.com/foo-dogsquared/nixos-config.git synced 2025-01-30 22:57:55 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
3e56aea47d
nixos-config/README.adoc

185 lines
8.3 KiB
Plaintext
Raw Normal View History

Update the modules
2020-08-06 15:35:49 +00:00
= foo-dogsquared's NixOS config
Update config and format the files
2021-11-30 01:03:05 +00:00
:toc:
Update the modules
2020-08-06 15:35:49 +00:00
Rewrite as a flake I revisited NixOS this week and I've rewritten my NixOS config from scratch. I must say I really like Nix flakes. For whatever reason it just clicked and I understood more programming with Nix despite my previous experience which is not good. Could be just the fact I had a break for a long time from completely using Nix (I still used it on non-NixOS distros). Eh... I still took some things from the original inspiration of this configuration so there's that.
2021-11-25 11:55:30 +00:00
This is my NixOS config as a link:https://www.tweag.io/blog/2020-05-25-flakes/[Nix flake].
Update the modules
2020-08-06 15:35:49 +00:00
Update documentation
2021-12-21 06:29:27 +00:00
I finally have some time trying to grok flakes and redo my NixOS config from scratch after leaving it for some time (because I have work and have to quickly set things up without me trying to debug how NixOS works).
Rewrite as a flake I revisited NixOS this week and I've rewritten my NixOS config from scratch. I must say I really like Nix flakes. For whatever reason it just clicked and I understood more programming with Nix despite my previous experience which is not good. Could be just the fact I had a break for a long time from completely using Nix (I still used it on non-NixOS distros). Eh... I still took some things from the original inspiration of this configuration so there's that.
2021-11-25 11:55:30 +00:00
Here is the result.
Update the modules
2020-08-06 15:35:49 +00:00
Rewrite as a flake I revisited NixOS this week and I've rewritten my NixOS config from scratch. I must say I really like Nix flakes. For whatever reason it just clicked and I understood more programming with Nix despite my previous experience which is not good. Could be just the fact I had a break for a long time from completely using Nix (I still used it on non-NixOS distros). Eh... I still took some things from the original inspiration of this configuration so there's that.
2021-11-25 11:55:30 +00:00
== Installation
Update the modules
2020-08-06 15:35:49 +00:00
Update documentation
2021-12-21 06:29:27 +00:00
Since this uses Nix flakes, you should have Nix v2.4 and above installed.
Rewrite as a flake I revisited NixOS this week and I've rewritten my NixOS config from scratch. I must say I really like Nix flakes. For whatever reason it just clicked and I understood more programming with Nix despite my previous experience which is not good. Could be just the fact I had a break for a long time from completely using Nix (I still used it on non-NixOS distros). Eh... I still took some things from the original inspiration of this configuration so there's that.
2021-11-25 11:55:30 +00:00
This primarily uses Nix flakes so you can have a preview of what's available in my config.
Update the modules
2020-08-06 15:35:49 +00:00
[source, shell]
----
Rewrite as a flake I revisited NixOS this week and I've rewritten my NixOS config from scratch. I must say I really like Nix flakes. For whatever reason it just clicked and I understood more programming with Nix despite my previous experience which is not good. Could be just the fact I had a break for a long time from completely using Nix (I still used it on non-NixOS distros). Eh... I still took some things from the original inspiration of this configuration so there's that.
2021-11-25 11:55:30 +00:00
nix flake show github:foo-dogsquared/nixos-config
Go back to using stable channels and add unstable channel as a separate channel NixOS 20.09 is just around the corner anyways so the packages will be updated soonish.
2020-08-19 18:35:23 +00:00
----
Update user-specific config Oh no, now I'm content with creating my own framework instead of using something like digga or flake-utils.
2021-11-29 05:30:57 +00:00
It should export my NixOS configurations of my different hosts (of only one so far excluding VMs and VPSs ;p) among other things.
To install it, run the `nixos-install --flake github:foo-dogsquared/nixos-config#ni`.
(Please see the respective appropriate host README for more information.)
Update the Nix config A bunch of minor updates here, a bunch of minor changes there. All of the Nix changes is here for all the world to see.
2020-10-06 22:56:04 +00:00
Update documentation
2021-12-26 10:43:23 +00:00
TIP: If you found some error regarding something in restricted mode, you can run the installation with `--impure` flag (i.e., `nixos-install --impure --flake github:foo-dogsquared/nixos-config#ni`).
== What's in my flake?
You can see the full details with `nix flake show`.
As a helpful summary, here's what my flake should contain sorting from the most interesting and helpful outputs to the most boring and unnecessary.
* `packages` contains link:./pkgs[my custom packages].
It supports the default list of systems as defined from link:https://github.com/numtide/flake-utils[`flake-utils`].
* `devShells` from link:./shells/[my custom environments].
Similar to `homeManagerConfigurations`, you can easily use it outside of NixOS.
* `nixosConfigurations` which is where you can install my various NixOS configurations directly (e.g., `nixos-install --flake MY_FLAKE_URL#HOST`).
This mainly uses the link:./hosts/[hosts configuration].
* `homeManagerConfigurations` contains my various link:https://github.com/nix-community/home-manager[home-manager] configurations from link:./users/home-manager/[`./users/home-manager/`].
The neat thing about it is you can easily install it in a non-NixOS Linux distro.
* `nixosModules` are composed from NixOS modules defined in link:./modules/nixos[`./modules/nixos`].
It can be used as additional modules for your own NixOS config in case you want to use mine for whatever reason.
footnote:[I don't know why did I put it there but eh...]
* `homeManagerModules` are where my link:./modules/home-manager[custom home-manager modules] to be exported.
footnote:[This is more useful than my NixOS modules.]
* `lib` is defined from link:./lib/[my custom library].
It's another unnecessary export but it's there.
Make the setup hardware-independent One of the bigger changes is to make the setup hardware-independent which is nice for easier (re-)installations. Finally about time it happens. Another big thing is the update of the README, now with some self-reminding pitch why choose NixOS (or something similar like GuixSD) which could be nice for other people too, provided they've come across my NixOS config. I made the module docstrings a bit more consistent (though still useless, to be honest). I've also updated config for Visual Studio Code.
2020-09-01 15:10:44 +00:00
Update package set and documentation
2021-11-29 10:27:56 +00:00
== Project structure
My NixOS config should look like the following:
[source, tree]
----
nixos-config
├── hosts/
├── lib/
├── modules/
├── pkgs/
Add secret files in the public Was initially afraid of how age is secure for the publicly showing secret files (even if encrypted). We'll start with something simple for now.
2021-12-11 05:20:55 +00:00
├── secrets/
Create development shells Only with the basics for now. I've yet to explore more complex use cases such as the following repos: - https://github.com/GTrunSec/Coding-Dev-Env-With-NixFlake - https://github.com/LavaDesu/flakes This seems nifty feature especially when doing some project spelunking or something.
2021-12-13 07:32:58 +00:00
├── shells/
Update package set and documentation
2021-11-29 10:27:56 +00:00
├── users/
├── flake.lock
├── flake.nix
└── README.adoc
----
* link:./hosts/[`./hosts/`] contain machine-specific configuration.
This usually configures like the hardware setup, timezone, and users.
Host configurations are also exported in the flakes in `outputs.nixosConfigurations`.
Update flakes and documentations
2021-12-06 09:57:54 +00:00
* link:./modules/[`./modules/`] contain my custom modules including NixOS and home-manager modules.
Update package set and documentation
2021-11-29 10:27:56 +00:00
For more information, see the link:./modules/README.adoc[related documentation].
* link:./pkgs/[`./pkgs/`] contains my custom packages.
Revert restructuring
2021-12-06 10:12:00 +00:00
It is exported in the flakes at `outputs.packages` compiled through various systems.
Update package set and documentation
2021-11-29 10:27:56 +00:00
Add secret files in the public Was initially afraid of how age is secure for the publicly showing secret files (even if encrypted). We'll start with something simple for now.
2021-12-11 05:20:55 +00:00
* link:./secrets/[`./secrets/`] contains my secrets managed with link:https://github.com/ryantm/agenix[agenix].
Update README and flake inputs
2021-12-18 08:20:58 +00:00
footnote:[It is advised you should minimize SSH keys with passphrases since it is annoying to reenter passwords every time.]
Add secret files in the public Was initially afraid of how age is secure for the publicly showing secret files (even if encrypted). We'll start with something simple for now.
2021-12-11 05:20:55 +00:00
Create development shells Only with the basics for now. I've yet to explore more complex use cases such as the following repos: - https://github.com/GTrunSec/Coding-Dev-Env-With-NixFlake - https://github.com/LavaDesu/flakes This seems nifty feature especially when doing some project spelunking or something.
2021-12-13 07:32:58 +00:00
* link:./shells/[`./shells/`] contains my development shells for interacting with the usual type of projects.
Setting this up can bring benefits outside of NixOS (unless you're interacting with projects with any OpenGL-related stuff).
footnote:[Since packages brought from Nix shells can only work with the store, a container might be better at some situations.]
Update package set and documentation
2021-11-29 10:27:56 +00:00
* link:./users/[`./users/`] contains my link:https://github.com/nix-community/home-manager[home-manager] configurations and modules.
It is exported in the flakes at `outputs.homeConfigurations`.
For more information, see the link:./users/README.adoc[related documentation].
Rewrite as a flake I revisited NixOS this week and I've rewritten my NixOS config from scratch. I must say I really like Nix flakes. For whatever reason it just clicked and I understood more programming with Nix despite my previous experience which is not good. Could be just the fact I had a break for a long time from completely using Nix (I still used it on non-NixOS distros). Eh... I still took some things from the original inspiration of this configuration so there's that.
2021-11-25 11:55:30 +00:00
== TODO
Make the setup hardware-independent One of the bigger changes is to make the setup hardware-independent which is nice for easier (re-)installations. Finally about time it happens. Another big thing is the update of the README, now with some self-reminding pitch why choose NixOS (or something similar like GuixSD) which could be nice for other people too, provided they've come across my NixOS config. I made the module docstrings a bit more consistent (though still useless, to be honest). I've also updated config for Visual Studio Code.
2020-09-01 15:10:44 +00:00
Rewrite as a flake I revisited NixOS this week and I've rewritten my NixOS config from scratch. I must say I really like Nix flakes. For whatever reason it just clicked and I understood more programming with Nix despite my previous experience which is not good. Could be just the fact I had a break for a long time from completely using Nix (I still used it on non-NixOS distros). Eh... I still took some things from the original inspiration of this configuration so there's that.
2021-11-25 11:55:30 +00:00
In order of priority:
Make the setup hardware-independent One of the bigger changes is to make the setup hardware-independent which is nice for easier (re-)installations. Finally about time it happens. Another big thing is the update of the README, now with some self-reminding pitch why choose NixOS (or something similar like GuixSD) which could be nice for other people too, provided they've come across my NixOS config. I made the module docstrings a bit more consistent (though still useless, to be honest). I've also updated config for Visual Studio Code.
2020-09-01 15:10:44 +00:00
Update user-specific config Oh no, now I'm content with creating my own framework instead of using something like digga or flake-utils.
2021-11-29 05:30:57 +00:00
* [x] Create custom modules.
* [x] Create a themes system similar to link:https://github.com/hlissner/dotfiles[this NixOS config].
Update documentation
2021-12-26 10:43:23 +00:00
* [ ] Create a good workflow for creating ISOs.
Create development shells Only with the basics for now. I've yet to explore more complex use cases such as the following repos: - https://github.com/GTrunSec/Coding-Dev-Env-With-NixFlake - https://github.com/LavaDesu/flakes This seems nifty feature especially when doing some project spelunking or something.
2021-12-13 07:32:58 +00:00
* [x] Create development shells.
Update package set and documentation
2021-11-29 10:27:56 +00:00
* [x] Manage secrets with agenix.
Update documentation
2021-12-26 10:43:23 +00:00
* [ ] Create a good workflow for tests.
Update user-specific config Oh no, now I'm content with creating my own framework instead of using something like digga or flake-utils.
2021-11-29 05:30:57 +00:00
* [x] Automate backups with NixOS config.
Update package set and documentation
2021-11-29 10:27:56 +00:00
* [x] Create custom packages and export it to flakes. (Maybe consider making it to upstream)
Update user-specific config Oh no, now I'm content with creating my own framework instead of using something like digga or flake-utils.
2021-11-29 05:30:57 +00:00
* [x] Create cluser-wide configs.
* [x] Create host-wide configs.
Update package set and documentation
2021-11-29 10:27:56 +00:00
* [x] Create user-specific configs with home-manager.
* [x] ~Steal~ Get some ideas from link:https://github.com/divnix/devos[this overengineered template].
* [x] Make use of other established utilities such as link:https://github.com/divnix/digga/[digga], link:https://github.com/gytis-ivaskevicius/flake-utils-plus[flake-utils-plus], and link:https://github.com/nix-community/home-manager[home-manager] once I'm familiar to create my own Nix programs.
Make the setup hardware-independent One of the bigger changes is to make the setup hardware-independent which is nice for easier (re-)installations. Finally about time it happens. Another big thing is the update of the README, now with some self-reminding pitch why choose NixOS (or something similar like GuixSD) which could be nice for other people too, provided they've come across my NixOS config. I made the module docstrings a bit more consistent (though still useless, to be honest). I've also updated config for Visual Studio Code.
2020-09-01 15:10:44 +00:00
Update user-specific config Oh no, now I'm content with creating my own framework instead of using something like digga or flake-utils.
2021-11-29 05:30:57 +00:00
Out of scope:
Make the setup hardware-independent One of the bigger changes is to make the setup hardware-independent which is nice for easier (re-)installations. Finally about time it happens. Another big thing is the update of the README, now with some self-reminding pitch why choose NixOS (or something similar like GuixSD) which could be nice for other people too, provided they've come across my NixOS config. I made the module docstrings a bit more consistent (though still useless, to be honest). I've also updated config for Visual Studio Code.
2020-09-01 15:10:44 +00:00
Update user-specific config Oh no, now I'm content with creating my own framework instead of using something like digga or flake-utils.
2021-11-29 05:30:57 +00:00
* Text editor configurations.
They are often updated. I don't want to rebuild it every time I change it.
Make the setup hardware-independent One of the bigger changes is to make the setup hardware-independent which is nice for easier (re-)installations. Finally about time it happens. Another big thing is the update of the README, now with some self-reminding pitch why choose NixOS (or something similar like GuixSD) which could be nice for other people too, provided they've come across my NixOS config. I made the module docstrings a bit more consistent (though still useless, to be honest). I've also updated config for Visual Studio Code.
2020-09-01 15:10:44 +00:00
Update user-specific config Oh no, now I'm content with creating my own framework instead of using something like digga or flake-utils.
2021-11-29 05:30:57 +00:00
* Migration of my link:https://github.com/foo-dogsquared/dotfiles[dotfiles].
I still use it on other non-NixOS systems.
Update the Nix config A bunch of minor updates here, a bunch of minor changes there. All of the Nix changes is here for all the world to see.
2020-10-06 22:56:04 +00:00
Make the setup hardware-independent One of the bigger changes is to make the setup hardware-independent which is nice for easier (re-)installations. Finally about time it happens. Another big thing is the update of the README, now with some self-reminding pitch why choose NixOS (or something similar like GuixSD) which could be nice for other people too, provided they've come across my NixOS config. I made the module docstrings a bit more consistent (though still useless, to be honest). I've also updated config for Visual Studio Code.
2020-09-01 15:10:44 +00:00
Update user-specific config Oh no, now I'm content with creating my own framework instead of using something like digga or flake-utils.
2021-11-29 05:30:57 +00:00
== Frequently asked questions (FAQ)
Move drivers in a more appropriate folder
2020-11-02 14:44:48 +00:00
Update documentation
2021-12-26 10:43:23 +00:00
More like "Most anticipated questions (MAQ)" since almost no one asked me about this yet. :)
However, it doesn't roll off the tongue.
Update user-specific config Oh no, now I'm content with creating my own framework instead of using something like digga or flake-utils.
2021-11-29 05:30:57 +00:00
[qanda]
Hello! I'm new to Nix and NixOS, where should I start?::
Oh no, you've seen the multiple configurations from other systems, didn't you?
I hope you're ready for some time understanding because the learning curve is steeper than the link:https://en.wikipedia.org/wiki/Troll_Wall[Troll Wall].
I've written link:https://foo-dogsquared.github.io/blog/posts/moving-into-nixos/[a blog post regarding my experience with Nix] with a bunch of links for getting started.
(Un)Fortunately, it is mostly the same experience now that I've revisited it.
Move drivers in a more appropriate folder
2020-11-02 14:44:48 +00:00
Update user-specific config Oh no, now I'm content with creating my own framework instead of using something like digga or flake-utils.
2021-11-29 05:30:57 +00:00
Any requirements for this setup?::
You only need Nix 2.4 installed with the experimental features for Nix command and flakes enabled (i.e., `experimental-features = nix-command flakes`).
Make the setup hardware-independent One of the bigger changes is to make the setup hardware-independent which is nice for easier (re-)installations. Finally about time it happens. Another big thing is the update of the README, now with some self-reminding pitch why choose NixOS (or something similar like GuixSD) which could be nice for other people too, provided they've come across my NixOS config. I made the module docstrings a bit more consistent (though still useless, to be honest). I've also updated config for Visual Studio Code.
2020-09-01 15:10:44 +00:00
Update documentation
2021-12-26 10:43:23 +00:00
Hey! I have an error something like `/nix/${HASH}-nmd/` from my installation. Why it doesn't work?::
This error seems to be related to home-manager.
See this link:https://github.com/nix-community/home-manager/issues/2074[issue] for more details.
Basically, you have to add `--impure` flag when running `nixos-install`.
What is my experience on Nix flakes?::
link:https://youtu.be/iWJKZK_1l88[I LIKE IT!]
There are still some hiccups like the strict tie-in to Git which leads to strange experience like having to add untracked files just to be recognized.
However, this feature is still in the works so no surprise there.
Is this based from link:https://github.com/divnix/devos[devos]?::
Yes but I've created this from scratch.
One of my goals when creating this config is to use as little dependency as much as possible.
At the time I've rewritten this configuration, I have little idea about Nix as a language and I find devos to be overwhelming so I doubled down to create from scratch.
+
However, I can say that my configuration is moving in a similar direction to devos (which is intended to be modified anyways) as I explore more of Nix.
In fact, I've based much of my config from it and may even be ended up as one.
It is nice that such a project exists serving as a reference for bigger configurations.
Update package set and documentation
2021-11-29 10:27:56 +00:00
== Inspirations
I ~stole~ got the ideas from the following projects:
* link:https://github.com/divnix/devos[devos, an overengineered configuration framework.]
Update README and flake inputs
2021-12-18 08:20:58 +00:00
I'm slowly grokking Nix and its ecosystem so I didn't use this outright.
Though, this is where my config is heading to be and instead slowly making parts of my config based from this template.
Update package set and documentation
2021-11-29 10:27:56 +00:00
* link:https://github.com/divnix/digga/[digga, an flake utility library for your overengineered config.]
Update README and flake inputs
2021-12-18 08:20:58 +00:00
I also stole parts of it for my custom library.
I may have to use this at some point.
* link:https://github.com/hlissner/dotfiles/[hlissner's dotfiles, the original inspiration for this functional abomination of a configuration.]
Very nice.
Reference in New Issue Copy Permalink