Skip to content

Commit

Permalink
README: Document the NixOS module's enable option
Browse files Browse the repository at this point in the history
  • Loading branch information
talyz committed Jun 9, 2024
1 parent a33ef10 commit f6a5d85
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions README.org
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,7 @@
#+begin_src nix
{
environment.persistence."/persistent" = {
enable = true; # NB: Defaults to true, not needed
hideMounts = true;
directories = [
"/var/log"
Expand Down Expand Up @@ -242,6 +243,16 @@
and one you don't, you can use both by defining two separate
attributes under ~environment.persistence~.

- ~enable~ determines whether the persistent storage location should
be enabled or not. Useful when sharing configurations between
systems with and without an impermanence setup. Defaults to
~true~.

- ~hideMounts~ allows you to specify whether to hide the
bind mounts from showing up as mounted drives in the file
manager. If enabled, it sets the mount option ~x-gvfs-hide~
on all the bind mounts.

- ~directories~ are all directories you want to bind mount to
persistent storage. A directory can be represented either as a
string, simply denoting its path, or as a submodule. The
Expand Down Expand Up @@ -304,11 +315,6 @@
If the file exists in persistent storage, it will be bind
mounted to the target path; otherwise it will be symlinked.

- ~hideMounts~ allows you to specify whether to hide the
bind mounts from showing up as mounted drives in the file
manager. If enabled, it sets the mount option ~x-gvfs-hide~
on all the bind mounts.

- ~users.talyz~ handles files and directories in ~talyz~'s home
directory

Expand Down

0 comments on commit f6a5d85

Please sign in to comment.