Skip to content

Installation

Overview

This section explains how to install a new Etendo environment. It includes:

  • Tutorial about the Etendo installation.
  • The steps to install Etendo.

Tutorial

Requirements

This section outlines the System Requirements.

PostgreSQL Configuration

Check this article to configure PostgreSQL correctly: PostgreSQL Configuration

Install Etendo

Steps to Install Etendo in JAR Format

  1. Clone Etendo Base project in a temporal directory.

    Terminal
    cd /tmp
git clone https://github.com/etendosoftware/etendo_base.git EtendoERP

  2. Copy the sources in /opt/EtendoERP folder.

    Terminal
    mv EtendoERP/* /opt/EtendoERP/
cd /opt/EtendoERP

  3. Modify the gradle.properties file with your GitHub Credentials. Create the credentials by following this guide.

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

  4. Change the build.gradle file, uncomment the core dependency in the dependencies section:

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

    Info

    To know the available versions of Etendo Classic, please visit the Release Notes page.

  5. Modify the gradle.properties file with your environment variables, if it is necessary:

    gradle.properties
    context.name=etendo

bbdd.sid=etendo
bbdd.port=5432
bbdd.systemUser=postgres
bbdd.systemPassword=syspass
bbdd.user=tad
bbdd.password=tad

org.gradle.jvmargs=-Dfile.encoding=UTF-8

  6. Dependencies

    Terminal
    ./gradlew dependencies

  7. Setup

    Terminal
    ./gradlew setup

  8. Installation
    Terminal
    ./gradlew install smartbuild

  9. Start the Tomcat, in case of Linux you can run:

    Terminal
    sudo /etc/init.d/tomcat start

    Note

    If you want to run Etendo locally, go to Run Etendo Development Environment.

  10. Open your browser in https://<Public server IP>/<Context Name>

Steps to Install Etendo in Sources Format

  1. Clone Etendo Base project in a temporal directory.

    Terminal
    cd /tmp
git clone https://github.com/etendosoftware/etendo_base.git EtendoERP

  2. Copy the sources in /opt/EtendoERP folder.

    Terminal
    mv EtendoERP/* /opt/EtendoERP/
cd /opt/EtendoERP

  3. Modify the gradle.properties file with your GitHub Credentials. Create the credentials by following this guide.

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

  4. By default, the latest core version available will be expanded but if there is a need to change it, edit the build.gradle file changing the coreVersion = "(<version>,<version>)".

    build.gradle
    etendo {
    coreVersion = "<version>"
}

    Info

    To know the available versions of Etendo Classic, please visit the Release Notes page.

  5. Expand Etendo Base

    Terminal
    ./gradlew expand

  6. Modify the gradle.properties file with your environment variables, if it is necessary:

    gradle.properties
    context.name=etendo

bbdd.sid=etendo
bbdd.port=5432
bbdd.systemUser=postgres
bbdd.systemPassword=syspass
bbdd.user=tad
bbdd.password=tad

org.gradle.jvmargs=-Dfile.encoding=UTF-8

  7. Setup: to apply or create the initial configurations

    Terminal
    ./gradlew setup

  8. Installation: Create the database, compile the sources and deploy to Apache Tomcat

    Terminal
    ./gradlew install smartbuild

  9. Make sure you have the following PostgreSQL configuration in your postgresql.conf, this file is located wherever you have postgresql installed

    Terminal
    lc_numeric = 'en_US.UTF-8'
max_locks_per_transaction = 128

    Note

    After modifying the file restart postgresql service

  10. Start the Tomcat, in case of Linux you can run:

    Terminal
    sudo /etc/init.d/tomcat start

    Note

    If you want to run Etendo locally, go to Run Etendo Development Environment.

  11. Open your browser in https://<Public server IP>/<Context Name>

Steps to Install the ISO with Internet Connection

  1. Download the ISO from the release notes page.

  2. Burn the ISO image into a USB stick. It is recommended to use balenaEtcher on Linux and Rufus on Windows. Alternatively, you can begin with your preferred virtualizer.

  3. Start the system using the ISO image. You will be prompted:

    • Network Connections: Verify that you are on a network with an internet connection and that an IP address is correctly assigned to your server.

    • Guide Storage Configuration: Select the disk where you want to run the installation. If you only have one disk, proceed to the next step.

    • Storage Configuration: Same as the previous step.

    • Profile Setup: Enter your name, the server's name, and the user etendo with the password of your choice.

  4. Wait for the operating system installation and server upgrade to take place. When prompted, select reboot now.

  5. After the restart, the final server configuration will begin. Wait for it to finish, and the server will be ready.

Steps to Install the ISO without Internet Connection

If you do not have an internet connection during installation, follow these additional steps:

  1. Follow the same procedure outlined in the previous section, Steps to Install the ISO with Internet Connection up to the network configuration stage.

    • Network Configuration: In this section, if you do not have an internet connection, select Continue without internet.

  2. After the operating system installation is complete, restart the server as prompted.

  3. Log in to the server using the username and password you configured during installation.

  4. Configure the network settings as desired to establish an internet connection.

  5. Once connected to the internet, log in as the superuser: sudo su.

  6. Begin the installation process by running the command: etendo-install.

  7. After the installation is finished, the server will be ready for use.

Steps to Install Etendo with Postgres Database and Tomcat Dockerized

The Docker Management module allows for the distribution of the infrastructure needed to configure Etendo Classic within Etendo modules, which include Docker containers for each service. Specifically, the Docker Management module includes the PostgreSQL Database Service and the Dockerized Tomcat Service module, which, as its name suggests, provides the Tomcat service. These modules are part of the Platform Extensions bundle, which will be covered in this step-by-step guide on how to install them.

Info

In this guide we will assume the installation of Etendo Classic in Sources format, in case you want to install it in JAR format you should consult the changes in the corresponding tab.

  1. Clone Etendo Base project in a temporal directory.

    Terminal
    cd /tmp
git clone https://github.com/etendosoftware/etendo_base.git EtendoERP

  2. Copy the sources in /opt/EtendoERP folder.

    Terminal
    mv EtendoERP/* /opt/EtendoERP/
cd /opt/EtendoERP

  3. Modify the gradle.properties file with your GitHub Credentials. Create the credentials by following this guide.

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

  4. By default, the latest core version available will be expanded but if there is a need to change it, edit the build.gradle file changing the coreVersion = "<version>".

    build.gradle
    etendo {
    coreVersion = "<version>"
}

    Info

    To know the available versions,, please visit the Etendo Classic Release Notes page.

  5. Expand Etendo Classic

    Terminal
    ./gradlew expand

  6. Add Platform Extensions bundle dependency, to include the dockeridez platform features

    build.gradle
    dependencies {
    //Add other dependencies bellow
    implementation ('com.etendoerp:platform.extensions:latest.release')
}

  7. Modify the gradle.properties file with your environment variables

    gradle.properties
    context.name=etendo

bbdd.sid=etendo
bbdd.port=5434
bbdd.systemUser=postgres
bbdd.systemPassword=syspass
bbdd.user=tad
bbdd.password=tad

org.gradle.jvmargs=-Dfile.encoding=UTF-8

docker_com.etendoerp.tomcat=true
docker_com.etendoerp.docker_db=true

    Info

    The dockerized database service will run on the port defined in the bbdd.port variable, we suggest using port 5434 to avoid conflict if you have a local Postgres instance using the default port.

    By default the Tomcat service will be up on port 8080, in case that port is busy you can use the variable docker_com.etendoerp.tomcat_port=<port>.

  8. Launching Dockerized Tomcat and Database services

    Terminal
    ./gradlew resources.up
    tomcat-database-dockerized
    Postgres database and Tomcat service running dockerized, if necessary you can access the log of each service.

  9. Setup: to apply or create the initial configurations

    Terminal
    ./gradlew setup

  10. Installation: Create the database, compile the sources and deploy to Apache Tomcat

    Terminal
    ./gradlew install smartbuild

  11. After the smartbuild task finish, the Tomacat service will automatically restart, open your browser in:

    https://<Public server IP>/<context.name> or in case that you run in local environment http://localhost:8080/etendo