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 Deployment Distro

XP distributions

Contents

This chapter investigates the anatomy of the XP distribution files (aka the XP runtime)

XP_INSTALL

When downloading and unzipping the XP distro, you will find the following root structure inside:

XP distribution folder structure 
enonic-xp-<OS>-<type>-<version>  (1)
 |- bin/  (2)
 |- home/   (3)
 |- java/  (4)
 |- lib/  (5)
 |- service/  (6)
 |- system/  (7)
1 The root folder is simply referred to as XP_INSTALL.
2 bin/* contains the scripts for starting and stopping Enonic XP and setting environment variables.
3 home/ also known as XP_HOME
4 java/ contains the embedded JVM distro, contents vary with distro
5 lib/ contains the bootstrap code used to launch Enonic XP.
6 service/ contains install script for Linux to make Enonic XP run as a service
7 system/ Default OSGi bundles are placed here.

XP_HOME

By default, this folder structure exists inside the XP_INSTALL. It is commonly moved out or treated specially from the rest of the files and folders in XP_INSTALL, as it contains stateful data. An example of this is when using Enonic CLI. Each "sandbox" created is basically a copy of the XP_HOME structure.

You may override the default location of XP_HOME by passing a boot parameter to XP, or by creating an XP_HOME environment variable.

Folders marked with * will not appear until XP is started the first time
Standard folder structure 
XP_HOME/
|- config/  (1)
|- data/ *  (2)
   |- dump/
   |- export/
|- deploy/  (3)
|- logs/  (4)
|- repo/ *
   |- index/  (5)
   |- blob/  (6)
|- snapshots/ *  (7)
|- work/ *  (8)
1 config/ holds all configuration files, including vhost.cfg and system.properties. XP supports hot reloading of all files ending with .cfg
2 data/ Contains system dumps and exports.
Should be mounted to a dedicated volume as usage may grow quickly, and exceed the size of the live repo data. Clusters should use a shared volume.
3 deploy/ Apps placed here are automatically loaded and started on the specific node.
4 logs/ default output location for all logs.
5 repo/index/ contains repository metadata and indexes
Requires a local persisted volume (Preferably using SSD). Must never be mapped to a shared volume. The content is automatically replicated across nodes in the cluster.
6 repo/blob/ contains the XP blobstore
Requires a persisted volume. For clusters, this must be a shared volume, accessible by all nodes.
7 snapshots/ Location where snapshots (of index and metadata) are stored when using the snapshot-operation.
For clusters, this must be mounted to a shared volume, accessible by all nodes.
8 work/ Cache and generated bundles (apps etc) are stored here.
For optimal performance ,mount this to a local persisted volume. Caches do not need to be re-generated after each restart.*

Contents

Contents

AI-powered search

Juke AI