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 Development Sandboxes

Sandboxes

Contents

Sandboxes are independent Enonic XP development environments

Using CLI, and sandbox may be created and started with the following commands: enonic sandbox create, enonic sandbox start.

Below, we dive into details of manually setting up and starting sandboxes:

Download distro

Start by downloading an Enonic XP distribution file. This is essentially the software version of the Enonic XP platform.

Distros for your architecture can be downloaded from the Enonic repo. Look for folders named enonic-xp-<architecture>-sdk.

Only distros ending with sdk are suitable for development purposes

Starting sandbox

After downloading and unzipping the distro, Enonic XP can be started on your local machine with the following command:

enonic-xp-<architecture>-sdk-<version>/bin/server.sh

Where <architecture> and <version> match the distro you downloaded.

Multiple sandboxes

If you wish to run multiple Sandboxes, this can be done by copying the home folder (located within your distro) to a new location. Then, use the XP_HOME environment variable to let XP know where to find it.

XP_HOME

Defaults to the $DISTRO_FOLDER/home/ folder

To set these variables use one of the following approaches:

Linux/MacOS 
export XP_HOME=/path/to/home
Windows 
set XP_HOME=c:\path\to\home

Contents

Contents

AI-powered search

Juke AI