Docs Developer Site
Enonic XP
arrow-down
    1. Widgets
    1. ID providers
    2. System ID provider
    3. Users and groups
    4. Roles
    1. Projects
    2. Layers
        1. AttachmentUploader
        2. Checkbox
        3. Combobox
        4. ContentSelector
        5. ContentTypeFilter
        6. CustomSelector
        7. Date
        8. DateTime
        9. Double
        10. GeoPoint
        11. HtmlArea
        12. ImageSelector
        13. Long
        14. MediaSelector
        15. Radiobutton
        16. Tag
        17. TextArea
        18. TextLine
        19. Time
      2. Field set
      3. Item set
      4. Option set
      5. Mixins
      6. Localization
    4. Content Types
    5. X-data
    6. Macros
    7. Custom styles
    8. Sites
      1. Regions
      2. Part component
      3. Layout component
      4. Text component
      5. Fragments
      6. Filtering
      7. Component indexing
      8. Visual editor
    10. Page templates
  4. Applications
    1. Sandboxes
    2. Code
    3. Building
    4. Configuration
    5. TypeScript
      1. Controllers
      2. Globals
      3. HTTP
      4. Events
      5. Error handler
      6. Filters
      7. ID provider
      8. Tasks
      9. Templating
      10. Localization
      11. Websocket
      12. Mappings
      13. Components
      14. Processors
      15. Contributions
      16. Main controller
      17. Java bridge
      1. Admin API
      2. Application API
      3. Auditlog API
      4. Authentication API
      5. Cluster API
      6. Common API
      7. Content API
      8. Context API
      9. Event API
      10. Export API
      11. Grid API
      12. I18N API
      13. IO API
      14. Mail API
      15. Node API
      16. Portal API
      17. Project API
      18. Repo API
      19. Scheduler API
      20. Schema API
      21. Tasks API
      22. Value API
      23. VHost API
      24. Websocket API
      1. Webapp Engine
        1. Image service
        2. Component service
      3. Admin Engine
      4. Asset service
      5. HTTP service
      6. IDprovider service
    2. Task engine
    3. Management Endpoint
    4. Statistics Endpoint
    1. Nodes and repos
    2. Properties
    3. Indexing
    4. Branches
    5. Queries (NoQL)
    6. Queries (DSL)
    7. Filters
    8. Aggregations
    9. Highlighting
    10. Editors
    1. Strategies
    2. Distributions
    3. Docker image
    4. Vhosts
    5. Configuration
    6. Backup & restore
    7. Systemd
    8. Clustering
  9. Audit Logs
    1. Upgrade Notes
    2. Upgrading Apps
Developer Docs Xp Stable Admin

XP Admin

Contents

This document describes built-in administration of Enonic XP. There are a number of apps that can extend and simplify XP administration. Please check out the documentation of each of them for details.

Admin console

When visiting the Enonic XP admin interface - you will be required to log in. For new installations and unless configured otherwise, you will first have to create the admin user.

After logging in, you will see the main admin console:

Admin Startup Page

In the top left corner, there are some important links for documentation and interaction with Enonic. On the right, there is a menu with all installed applications. Two of them are system applications that are installed on all installations:

  • Applications - Add applications from the market or upload your own. Applications may be everything from complete sites to simple admin widgets. Read more in Applications.

  • Users - Administrate users. More info in Identity and Access Managment (IAM).

If you are used to working in the Content Studio, you will miss it in a clean installation, as it has now been pulled out from the core and must be installed from Market in the Applications app. The Content Studio documentation may be found here: Content Studio Doc

Languages

The tools of the admin console have been translated to the following languages:

  • Belarussian

  • Dutch

  • English

  • French

  • Italian

  • Norwegian

  • Polish

  • Portuguese

  • Russian

  • Spanish

  • Swedish

The language used by the admin tools, is based on your browser settings. If your preferred language is one of the above, it will be used. If your preferred language is not in the list, the admin console will default to English.

If you know a language that is not supported, we would greatly appreciate help with translating the admin console to more languages. Please checkout out our guide on Contributing to Translations.

Admin extensions

XP enables developers to extend the admin console with custom functionality at pre-defined locations.

For more information on how to implement extensions, visit the admin engine documentation

Admin tools

Admin tools represent standalone applications that are integrated with the admin console login and launcher. Tools are launched in separate browser tabs, running independently of other admin components.

  • A single XP application may contain multiple admin tools

  • Access to an admin tool typically requires authentication, and a particular role memberships

  • Admin tools are all served within the admin URL pattern. i.e. //<server>:<port>/admin/tool/<tool-name>

Admin Widgets

Widgets are designed to extend functionality of existing admin interfaces. Widgets are essentially small applications that are displayed in the Context panel of the admin interface.

  • A single XP application may contain multiple widgets

  • Access to a widget typically requires authentication, and particular role memberships

  • Widgets are not supposed to be used outside the admin console

  • Widget can be context dependent (display data based on a selected content) or independent.

Contents

Contents

AI-powered search

Juke AI