Skip to content

Install Etendo - Local Development Environment

Overview

This guide covers setting up a local Etendo development environment. It uses IntelliJ IDEA with a local Tomcat instance to run Etendo, and Docker to run Copilot and Main UI as containerized services.

Prerequisites

Before starting, make sure the following are ready:

Warning

Avoid installing Docker via Snap — its sandbox restrictions may prevent Etendo Docker containers from accessing host directories correctly. Install Docker following the official guide for your distribution.

Installation

1. Clone the Project

Terminal
cd /path/to/workspace
git clone https://github.com/etendosoftware/etendo_base.git EtendoERP
cd EtendoERP

2. Add GitHub Credentials

Edit gradle.properties and add your GitHub credentials. To generate them, follow the Use of Repositories in Etendo guide.

gradle.properties
githubUser=<username>
githubToken=<*******>

3. Expand the Project

Source format is recommended for local development as it gives full access to the codebase.

Terminal
./gradlew expand

Uncomment the core dependency in build.gradle:

build.gradle
implementation('com.etendoerp.platform:etendo-core:<version>')

Info

To know the available versions, visit the Etendo Release Notes.

4. Apply the Local Template

Run the following task to configure all required variables for Etendo, Copilot, and Main UI:

Terminal
./gradlew setup.applyTemplates --template=local

When prompted, enter your OpenAI API Key.

The template configures gradle.properties automatically with all required settings for a local environment, including Copilot and Main UI Docker services.

Availability

setup.applyTemplates is available from Etendo 26 onwards, or in earlier versions with the Etendo Gradle Plugin 3.0.0 or higher.

Info

For details about available templates, options, and advanced usage, see the How to Use Setup Apply Templates guide.

Alternative: Manual Configuration

Configure variables directly in gradle.properties and apply them by running: 

./gradlew setup --info

Alternative: Interactive Setup

For a fully guided, property-by-property configuration, run the interactive setup instead: 

./gradlew setup -Pinteractive=true --console=plain
For more details, see the How to Use the Interactive Setup guide.

5. Start Docker Services

Terminal
./gradlew resources.up --info
This starts the Copilot and Main UI containers. Both are included in the base installation.

6. Install Etendo

Terminal
./gradlew install smartbuild --info

This creates the database, compiles the sources, and deploys to the local Tomcat directory.

Run in IntelliJ

  1. Download and install IntelliJ IDEA Community Edition.

  2. Open the Etendo source directory with IntelliJ:

    open-project.png

  3. Install the Smart Tomcat plugin: go to Settings > Plugins and search for Smart Tomcat.

    install-smart-tomcat.png

  4. Download Apache Tomcat and unzip it inside the project directory.

  5. Set up the Tomcat run configuration:

    • Go to Current File > Edit Configurations.

      edit-configurations.png

    • Click + and add a new Smart Tomcat configuration with the following values:

      • Name: Tomcat
      • Tomcat Server: select the unzipped Apache Tomcat directory
      • Deployment directory: select the WebContent directory in the project
      • Context path: use the same value defined in gradle.properties (default: /etendo)
      • Before launch: remove all default tasks

      add-new-configuration.png

  6. Start Tomcat from the run configuration:

    start-tomcat.png

  1. Download and install IntelliJ IDEA Ultimate.

  2. Open the Etendo source directory with IntelliJ.

  3. Set up the Tomcat run configuration:

    • Go to Current File > Edit Configurations.

      edit-configurations.png

    • Select the Tomcat configuration from the list and verify the Tomcat server settings.

      add-new-configuration-ultimate.png

    • In the Deployment section, add external sources and select the ${env.CATALINA_HOME}/webapps/etendo folder.

      add-external-source.png

      config-deployment-folder.png

  4. Start Tomcat from the run configuration.

Access the Installation

Once Tomcat and Docker services are running:

Interface URL
Main UI http://localhost:3000
Classic UI http://localhost:8080/etendo

Default credentials

User: admin Password: admin

Optional

Enable Etendo Logs

  1. Open config/log4j2-web.xml and uncomment the Console appender reference:

    config/log4j2-web.xml
    <Loggers>
    <Root level="info">
        <AppenderRef ref="RollingFile"/>
        <AppenderRef ref="Console"/>  <!-- uncomment this line -->
    </Root>

  2. Run smartbuild to apply the change:

    Terminal
    ./gradlew smartbuild --info

This work is licensed under CC BY-SA 2.5 ES by Futit Services S.L.