Skip to content

Commit

Permalink
readme: document remote management status. (#38)
Browse files Browse the repository at this point in the history
Document how remote managemt has currently
been implemeted.

Add a reference to lib.mkOptionDefault.
  • Loading branch information
gmodena authored Feb 9, 2024
1 parent 35122ed commit 739d714
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,22 @@ services.flatpak.remotes = [{
name = "flathub-beta"; location = "https://flathub.org/beta-repo/flathub-beta.flatpakrepo";
}];
```
Note that this declaration will override the default remote config value (`flathub`).
If you want to keep using `flathub`, you should explicitly declare it in the
`services.flatpak.remotes` option.

Alternatively, it is possible to merge declared remotes with the default one with `lib.mkDefaultOption`.
```nix
services.flatpak.remotes = lib.mkOptionDefault [{
name = "flathub-beta";
location = "https://flathub.org/beta-repo/flathub-beta.flatpakrepo";
}];
```

**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:
Expand Down

0 comments on commit 739d714

Please sign in to comment.