aynish/nix-starter-configs
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

fix some typos and improve wording on later tips

Browse source
This commit is contained in:
Gabriel Fontes 2022-04-24 20:56:56 -03:00
parent f22eb905f4
commit c6cbb4b602
No known key found for this signature in database
GPG key ID: 2E54EA7BFE630916
1 changed files with 42 additions and 33 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

75
README.md
View file

@ -73,11 +73,12 @@ Congrats, your nix version supports flakes! It's just hidden behind a feature fl
You can bootstrap with: You can bootstrap with:
```bash ```bash
nix develop --experimental-features "nix-command flakes" .#default nix --experimental-features develop "nix-command flakes" .#default
``` ```
The shell will also enable those experimental features, so no need for that The shell will also enable those experimental features, so no need to pass that
argument after entering it. argument while you're inside (or after installation, if you set the option that
enables them globally).
This should generate a `flake.lock`. Remember to commit it, as this will make This should generate a `flake.lock`. Remember to commit it, as this will make
future bootstraps reproductible. future bootstraps reproductible.
@ -113,27 +114,26 @@ There's also more advanced options for secret management, including some that
can include them (encrypted) into your config repo and/or nix store, be sure to can include them (encrypted) into your config repo and/or nix store, be sure to
check them out if you're interested. check them out if you're interested.
## Include files using home-manager ## Dotfile management with home-manager
Besides just adding packages to your environment, home-manager can also manage Besides just adding packages to your environment, home-manager can also manage
your dotfiles. I strongly recommend you do, it's awesome! your dotfiles. I strongly recommend you do, it's awesome!
For full nix goodness, check out the home-manager modules with `man For full nix goodness, check out the home-manager options with `man
home-configuration.nix`. Using them, you'll be able to fully configure any home-configuration.nix`. Using them, you'll be able to fully configure any
usual dotfile with nix syntax and abstractions (including your own powerful program with nix syntax and its powerful abstractions.
modules and functions).
Alternatively, if you're still not ready to rewrite all your configs in nix Alternatively, if you're still not ready to rewrite all your configs to nix
syntax, there's home-manager options (such as `xdg.configFile`) for including syntax, there's home-manager options (such as `xdg.configFile`) for including
files from your nix-config repository into your config directories. Add your files from your config repository into your usual dot directories. Add your
existing dotfiles to this repo and try it out! existing dotfiles to this repo and try it out!
## Try opt-in persistance ## Try opt-in persistance
You might have noticed that there's impurity in your NixOS system, in the form You might have noticed that there's impurity in your NixOS system, in the form
of configuration files and other cruft your system generates when running. What of configuration files and other cruft your system generates when running. What
if you change them in a whim? Boom, your system is not fully reproductible if you change them in a whim to get something working and forget about it?
anymore. Boom, your system is not fully reproductible anymore.
You can instead fully delete your `/` and `/home` on every boot! Nix is okay You can instead fully delete your `/` and `/home` on every boot! Nix is okay
with a empty root on boot, and will happily reapply your configurations (as with a empty root on boot, and will happily reapply your configurations (as
@ -150,45 +150,54 @@ for mounting stuff you to keep to a separate partition/volume (such as
can keep track of what you specifically asked to be kept. can keep track of what you specifically asked to be kept.
## Customize your NixOS configuration ## Adding custom packages
Use the `nixos/configuration.nix` file. Something you want to use that's not in nixpkgs yet? You can easily build and
iterate on a derivation (package) from this very repository.
For a list of options, see `man configuration.nix`. Also see [the Create a folder with the desired name inside `pkgs`, and add a `default.nix`
manual](https://nixos.org/manual/nixos/stable/index.html#ch-configuration).
## Customize your home-manager configuration
Use the `home-manager/home.nix` file.
For a list of options, see `man home-configuration.nix`. Also see [the
manual](https://rycee.gitlab.io/home-manager/index.html#ch-usage).
## Adding packages
Create a folder with the package name inside `pkgs`, and add a `default.nix`
file containing a derivation. Be sure to also `callPackage` them on file containing a derivation. Be sure to also `callPackage` them on
`pkgs/default.nix`. `pkgs/default.nix`.
See [the manual](https://nixos.org/manual/nixpkgs/stable/). You'll be able to refer to that package from anywhere on your
home-manager/nixos configurations, build them with `nix build .#package-name`,
or bring them into your shell with `nix shell .#package-name`.
See [the manual](https://nixos.org/manual/nixpkgs/stable/) for some tips on how
to package stuff.
## Adding overlays ## Adding overlays
Use the `overlay/default.nix` file. Found some outdated package on nixpkgs you need the latest version of? Perhaps
you want to apply a patch to fix a behaviour you don't like? Nix makes it easy
and manageble with overlays!
If you're applying patches, you can keep them on the `overlay` folder as well. Use the `overlay/default.nix` file for this.
See [the wiki article](https://nixos.wiki/wiki/Overlays). If you're creating patches, you can keep them on the `overlay` folder as well.
See [the wiki article](https://nixos.wiki/wiki/Overlays) to see how it all
works.
## Adding your own modules ## Adding your own modules
Got some configurations you want to create an abstraction of? Modules are the
answer. These awesome files can expose _options_ and implement _configurations_
based on how the options are set.
Create a file for them on either `modules/nixos` or `modules/home-manager`. Be Create a file for them on either `modules/nixos` or `modules/home-manager`. Be
sure to also add them to the listing at `modules/nixos/default.nix` or sure to also add them to the listing at `modules/nixos/default.nix` or
`modules/home-manager/default.nix`. `modules/home-manager/default.nix`.
See [the wiki article](https://nixos.wiki/wiki/Module). See [the wiki article](https://nixos.wiki/wiki/Module) to learn more about
them.
## Adding more hosts or users ## Adding more hosts or users
You can organize them by hostname and username on `nixos` and `home-manager` You can organize them by hostname and username on `nixos` and `home-manager`
directories, be sure to also add them to `flake.nix` directories, be sure to also add them to `flake.nix`.
NixOS makes it easy to share common configuration between hosts (you might want
to create a common directory for these), while keeping everything in sync.
home-manager can help you sync your environment (from editor to WM and
everything in between) anywhere you use it. Have fun!