Skip to content

Commit

Permalink
Update doc (#57)
Browse files Browse the repository at this point in the history
* readme: update unmanaged remotes doc

* readme: clarify system/user behaviour.
  • Loading branch information
gmodena authored Apr 1, 2024
1 parent 7c436bd commit db5ea76
Showing 1 changed file with 14 additions and 10 deletions.
24 changes: 14 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,11 +90,6 @@ Alternatively, it is possible to merge declared remotes with the default one wit
}];
```

**Note**: currently no state management has been implemented for `remotes`.
Removing a remote for the config declaration won't delete it from the system.
A manual `flatpak remote-delete [...]` is required. Improving remote management
is planned for future releases.

### Packages
Declare packages to install with:
```nix
Expand All @@ -108,13 +103,22 @@ You can pin a specific commit setting `commit=<hash>` attribute.

Rebuild your system (or home-manager) for changes to take place.

##### Unmanaged packages
##### Unmanaged packages and remotes

By default `nix-flatpak` will only manage (install/uninstall/update) packages declared in the
`services.flatpak.packages` and repositories declared in `services.flatpak.remotes`.
Flatpak packages and repositories installed by the command line of app stores won't be affected.

Set `services.flatpak.uninstallUnmanaged = true` to alter this behaviour, and have `nix-flatpak` manage the
lifecycle of all flatpaks packages and repositories.

By default `nix-flatpak` will only managed (install/uninstall/update) packages declared in the
`services.flatpak.packages`. Flatpak installed by the command line of app stores won't be affected.
Note that `services.flatpak.uninstallUnmanaged` will only affect a given `system` of `user` installation
target. If `nix-flatpak` is installed as a HomeManager module all packages/remotes will be managed
in a `user` installation. Packages/remotes installed system-wide won't be affected
by `services.flatpak.uninstallUnmanaged`.

Set `services.flatpak.uninstallUnmanagedPackages = true` to alter this behaviour, and have `nix-flatpak` manage the
lifecyle of all flatpaks installed on the system.
Similarly, when `nix-flatpak` is installed as a NixOs module, only system-wide config will
be affected.

### Updates

Expand Down

0 comments on commit db5ea76

Please sign in to comment.