Repository navigation
docs(roles/nextcloud): document the subkeys of the app variables correctly - #440
Merged
Merged
Conversation
…ectly The README had the subkeys of nextcloud__apps__* and nextcloud__app_configs__* mixed up: `force` and the app states were listed under the app configs, while the apps claimed `present`/`absent` with a default of `present`. nextcloud_occ_app accepts `absent`, `disabled`, `enabled` and `present`, defaults to `enabled`, and `present` installs an app without enabling it. nextcloud_occ_app_config takes `type` and `state` (`present`/`absent`). Also note that combine_lod only overrides the subkeys an inventory entry sets, so an app disabled in the role defaults stays disabled unless the entry sets `state: 'enabled'`.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README had the subkeys of
nextcloud__apps__*andnextcloud__app_configs__*mixed up:nextcloud__app_configs__*listedforceand the app states (enabled,disabled, ...). It now lists the subkeysnextcloud_occ_app_configactually takes:typeandstate(present/absent).nextcloud__apps__*claimedpresent/absentwith a default ofpresent.nextcloud_occ_appacceptsabsent,disabled,enabledandpresentand defaults toenabled;presentinstalls an app without enabling it.forceis documented there now.combine_lod), so an app the role disables by default (activity,notifications,systemtags, ...) stays disabled unless the entry setsstate: 'enabled'.state: 'present'for an app that should be on, nor the non-existent appweather.Observed on a lab host deployed with
setup_nextcloud(Nextcloud 35.0.1, Rocky 10): entries foractivity,notifications,systemtagsandcircleswithoutstateleft these apps disabled.Documentation only, no change to tasks or modules.