Hiding settings based on authentication

[lgwapnitsky]

All right plan on using a keycloak to provide authentication to dashy. Is it possible to hide the configuration options based on your login permissions?

[Lissy93]

Yes, it is.
AFK at the moment, but see the docs, under authentication

[Lissy93]

Yes, groups and roles are supported. This is outlined here, in the Authentication Docs. This feature was contributed by leocov-dev in #397

[schmug]

Is this only for Sections, or is it possible to hide config/save options behind keycloak roles/groups as well?

[Lissy93]

Yes, see Authentication Docs --> Permissions
It's appConfig.disableConfiguration: true

[schmug]

I think I'm being dense, I can't figure out how to appconfig.disableConfiguration: true and use keycloak for auth.

How do I set type: admin in keycloak for dashy to recognize it?

in this example config I have role1 in keycloak attached to my user. I've tried being keycloak group and role admin, and keycloak attribute type: admin.

appConfig:
---
  auth:
    enableGuestAccess: true
    users: []
    enableKeycloak: true
    keycloak:
      serverUrl: keycloak.url
      realm: Dashy
      clientId: clientid
  showSplashScreen: false
  preventWriteToDisk: false
  preventLocalSave: false
  disableConfiguration: true
  allowConfigEdit: true
  enableServiceWorker: false
  disableContextMenu: false
  disableUpdateChecks: false
  disableSmartSort: false
  enableErrorReporting: false
pageInfo:
---
sections:
  - name: section1
    displayData:
      showForKeycloakUsers:
        roles:
          - role1
---
    items:

[schmug]

the docs show the example when using built-in auth only from what I could find

appConfig:
  auth:
    users:
    - user: alicia
      hash: 4D1E58C90B3B94BCAD9848ECCACD6D2A8C9FBC5CA913304BBA5CDEAB36FEEFA3
      type: admin
    - user: bob
      hash: 5E884898DA28047151D0E56F8DC6292773603D0D6AABBDD62A11EF721D1542D8

I don't pretend to know what I'm doing, but it seems like only preventWriteToDisk checks for admin.

dashy/src/store.js

Lines 83 to 96 in 05f5d71

	// Disable saving changes to disk, only
	if (appConfig.preventWriteToDisk || !isUserAdmin) {
	perms.allowWriteToDisk = false;
	}
	// Legacy Option: Will be removed in V 2.1.0
	if (appConfig.allowConfigEdit === false) {
	perms.allowWriteToDisk = false;
	}
	// Disable everything
	if (appConfig.disableConfiguration) {
	perms.allowWriteToDisk = false;
	perms.allowSaveLocally = false;
	perms.allowViewConfig = false;
	}

and I can't find where keycloak users/groups/roles can have a type:

dashy/src/utils/KeycloakAuth.js

Lines 63 to 69 in c2559bc

	const info = {
	groups,
	roles,
	};
	localStorage.setItem(localStorageKeys.KEYCLOAK_INFO, JSON.stringify(info));
	localStorage.setItem(localStorageKeys.USERNAME, preferredUsername);