Apps Page
The Apps Page provides a centralized navigation screen where users can access all applications installed on a Frappe site. By default, every installed Frappe application is displayed on this page.
The Apps Page serves as the entry point for users when no default application has been configured.
Adding a Custom App to the Apps Page
To display your custom application on the Apps Page, define the add_to_apps_screen configuration in your application’s hooks.py file.
The following example shows the configuration used by the Frappe CRM application:
# Each item in the list will be shown as an app in the Apps Page
add_to_apps_screen = [{
"name": "crm",
"logo": "/assets/crm/logo.png",
"title": "CRM",
"route": "/crm",
"has_permission": "crm.api.check_app_permission"
}]The configuration supports the following properties:
- name – Unique application identifier.
- logo – Path to the application logo.
- title – Display name shown on the Apps Page.
- route – URL opened when the application is selected.
- has_permission – Optional permission method used to determine whether the application should be visible to the current user.
Use the has_permission callback to display or hide an application based on custom business logic, such as restricting access for specific user types.
The add_to_apps_screen hook is supported in Frappe Version 15 and later.
Only applications that satisfy the configured permission logic are displayed to the user.
Setting a Default App
You can configure a default application so that users are taken directly to that app immediately after signing in.
If no default application is configured, users are redirected to the Apps Page after logging in.
Default App Configuration Levels
1. User-Level Configuration
Individual users can choose their own default application. This setting affects only their account and overrides the system-wide default, if applicable.
User-level settings allow each user to customize the application that opens after login.
2. System-Level Configuration
Administrators can configure a global default application for the entire site.
This setting is applied to users who have not selected their own default application.
Configure a system-level default app for organizations where most users work primarily within the same application, while allowing individual users to override it if needed.
