Skip to content
Documentation
Configuration
App Widgets

App Widgets

Both Sidebar Configuration and Dashboard Configuration support an app: entry - a link to one of Cavaliba’s built-in entry points, identified by a fixed keyname. Both features draw from the exact same registry (APP_REGISTRY in app_home/home.py), so a key added here becomes available as both a sidebar row and a dashboard card at once.

- app: import
- app: ipam
  icon: 'fa-plus'
  label: "Custom IPAM label"
  • label, icon, permission (all optional) - override the registry default for this entry only.
  • Setting permission: to an empty/no value makes the entry visible to any authenticated user, regardless of the registry default.
  • An unknown app key is skipped (logged as a warning) rather than breaking the sidebar/dashboard.

Predefined app entries

Key Default label Default permission
sirene Sirene Notification p_sirene_access
sirene_archive Sirene Archive p_sirene_access
sms SMS Sarbacane p_sirene_sms_send
sms_stat SMS Stats p_sirene_sms_stat
sms_journal SMS Journal p_sirene_sms_journal
status Status Monitor p_status_access
ipam IPAM p_ipam_access
all_schemas […] All p_data_access
import Import p_data_import
export Export p_data_export
code_editor Code Editor p_code_editor
enumerate Enumerate p_enumerate_read
pipeline Pipeline p_pipeline_read
dataview Dataview p_dataview_read
configuration Configuration p_conf_view
revision Revision Log p_admintools
admintools Admin Tools p_admintools
role Roles p_role_read
permission Permissions p_permission_read
apikey ApiKey p_apikey_read
log Logs p_log_view
cavaliba_doc Doc Cavaliba (Ext) (none - any authenticated user)

Note: all_schemas links to the page listing every schema (/data/private/) - not to be confused with schema: "@ALL" in DASHBOARD_CONTENT, which inserts a widget per schema instead. See Dashboard Configuration for that distinction.

Sidebar ConfigurationDashboard Configuration