Skip to content

Latest commit

 

History

History
326 lines (212 loc) · 13.6 KB

README.md

File metadata and controls

326 lines (212 loc) · 13.6 KB
Raw

Eclipse Dirigible™

Build Status Eclipse License Download Dirigible Artifact HUB Maven Central GitHub contributors FOSSA Status CII Best Practices REUSE status

Eclipse Dirigible is a High-Productivity Application Platform as a Service (hpaPaaS). It provides an application server consisting of pre-selected execution engines and built-in web development tools. It is suitable for rapid development of business applications by also leveraging the Low Code / No Code techniques.

dirigible logo

Enjoy Programming Like Never Before

From the end user's perspective (developer), Dirigible runs directly in the browser, therefore does not require any downloads or installations.

From the service provider's perspective (PaaS/SaaS), Dirigible packs all required components in a self-contained software bundle that can be deployed on a VM or Docker capable environment such as Kubernetes.

Dirigible supports access to RDBMS via JDBC. Currently supported versions for RDBMS are PostgreSQL, HANA, Sybase ASE, MySQL, H2, and Derby as well as NoSQL like MongoDB or pure OLAP like Snowflake.

Dirigible promotes the In-System Programming development model, where you make dynamic alteration of the live system. To provide the self-contained bundle serving all the needed features for a business application, Dirigible packs various engines such as ActiveMQ, Quartz, Lucene, Flowable, Mylyn, GraalJS and others.

The project started as an internal SAP initiative to address the extension and adoption use-cases related to SOA and Enterprise Services.

Instant Trial

You can try the sandbox instance to have a quick look on the functionality you are interested https://trial.dirigible.io.

Contact Us

Join the Eclipse Dirigible Slack Workspace to chat with the community: https://slack.dirigible.io

Get Started

Download

The "fast-track" - you can download the precompiled binaries produced by the GitHub Actions from http://download.dirigible.io/ and skip the build section.

Nevertheless, we highly recommend building the binaries from source in order to have all experimental features that are not available in the releases.

Build

Prerequisites
Steps
  1. Clone the project repository - master branch or download the latest sources.

In case there is an issue with 'Filename too long in Git for Windows' then add the fllowing git confoguration

git config --system core.longpaths true

  1. Go to the root folder.

  2. Build the project with:

     mvn clean install

    If you are using Windows, make sure that you open the terminal as Administrator otherwise the tests will fail

  • Quick build with tests:

     mvn -T 1C clean install -D maven.javadoc.skip=true -D license.skip=true

  • If you don't want to trigger license updates:

     mvn clean install -D license.skip=true

  • If you have a multi-core system, enable threads:

     mvn -T 1C clean install

  • If you don't need to run tests, you can add the following argument:

     mvn clean install -D skipTests

  • If you don't need to compile and run tests:

     mvn clean install -D skipTests

  • If you want to do a fast build, with no tests, javadocs and license updates:

     mvn -T 1C clean install -D skipTests -D maven.javadoc.skip=true -D license.skip=true

The build should pass successfully.

The produced dirigible-application-XXX-executable.jar file is in build/application/target/ and is ready to be deployed. It is Spring Boot application, so it can be executed locally right away.

Run

Standalone

Prerequisites

macOS:

    brew install ttyd

Linux:

Linux support is built-in

More info about ttyd can be found at: ttyd

Steps

  1. From the project root directory run command:

     java -jar build/application/target/dirigible-application-*-executable.jar

    for Windows

     java -jar build/application/target/$((Get-ChildItem dirigible-application-*-executable.jar -recurse -File | Sort-Object LastWriteTime | Select -Last 1).BaseName).jar

  2. In case you want to debug the application run:

     java -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=8000 -jar build/application/target/dirigible-application-*-executable.jar

  3. Open a web browser and go to: http://localhost:8080

  4. Login with user: admin and password admin

  5. REST API description in an OpenAPI format can be found at: http://localhost:8080/swagger-ui/index.html

Docker

Prerequisites
Steps
  1. Get the container

  • Pull the official image from Docker Hub:

      docker pull dirigiblelabs/dirigible:latest

  • Build it locally

      cd build/application
  docker build -t dirigiblelabs/dirigible:latest -f Dockerfile .

    prerequisite: build the project as described in step 4 here

  1. Start the container
docker run --name dirigible --rm -p 8080:8080 -p 8081:8081 dirigiblelabs/dirigible:latest

If you want to have persistent workspace and databases, mount a host folder

export WORKSPACE_DIR='/tmp/dirigible'

docker run --name dirigible --rm -p 8080:8080 -p 8081:8081 \
    -v "$WORKSPACE_DIR:/target/dirigible" \
    dirigiblelabs/dirigible:latest

Note: we have observed performance issues on Windows when mounting a folder. To improve the perfomance, use dedicated volume instead:

docker volume create dirigible_volume

docker run --name dirigible --rm -p 8080:8080 `
    -v "dirigible_volume:/target/dirigible" `
    dirigiblelabs/dirigible:latest

  1. Open a web browser and go to: http://localhost:8080

  2. Optionally you can enhance and customize the Dockerfile from here

Native image

Prerequisites
  • Install SDKMAN
  • Install GraalVM: sdk install java 21.0.1-graal
  • Make sure that JAVA_HOME and PATH env variables point to your graalvm jdk from the previous step
Steps
  • Execute the following on your github repo root folder
# build dirigible fat jar
mvn -T 1C clean install -D maven.test.skip=true -D skipTests -D maven.javadoc.skip=true -D license.skip=true

rm -rf dirigible

# build native image
native-image -jar 'build/application/target/dirigible-application-10.0.0-SNAPSHOT-executable.jar' -o dirigible

# start dirigible
./dirigible

PostgreSQL

Steps

  1. Install PostgreSQL e.g. for MacOS:

     brew install postgresql

    Alternatively you can use docker image

     docker run -itd -e POSTGRES_DB=postgres -e POSTGRES_USER=postgres -e POSTGRES_PASSWORD=postgres  -p 5432:5432 --name postgresql postgres

  2. The run it:

     brew services start postgresql

  3. Create a default user:

     createuser -s postgres

  4. And expose the following environment variables:

     export DIRIGIBLE_DATASOURCE_DEFAULT_DRIVER=org.postgresql.Driver
 export DIRIGIBLE_DATASOURCE_DEFAULT_URL=jdbc:postgresql://localhost:5432/postgres
 export DIRIGIBLE_DATASOURCE_DEFAULT_USERNAME=postgres
 export DIRIGIBLE_DATASOURCE_DEFAULT_PASSWORD=postgres

    for Windows execute the following in the terminal with admin privileges

    [System.Environment]::SetEnvironmentVariable('DIRIGIBLE_DATASOURCE_DEFAULT_DRIVER','org.postgresql.Driver', 'Machine')
[System.Environment]::SetEnvironmentVariable('DIRIGIBLE_DATASOURCE_DEFAULT_URL','jdbc:postgresql://localhost:5432/postgres', 'Machine')
[System.Environment]::SetEnvironmentVariable('DIRIGIBLE_DATASOURCE_DEFAULT_USERNAME','postgres', 'Machine')
[System.Environment]::SetEnvironmentVariable('DIRIGIBLE_DATASOURCE_DEFAULT_PASSWORD','postgres', 'Machine')

  5. Then you can run Dirigible with PostgreSQL default database (DefaultDB).

    If you have started the Dirigible before, make sure to execute mvn clean before starting the Dirigible with the PostgreSQL

CMS with AWS S3

Eclipse Dirigible's Document perspective can be used with AWS S3, providing you CMS with S3's cloud storage.

Setup:

  • AWS account with generated credentials (AWS Acces Key, AWS Secret Key)
  • Set up the environment variables regarding CMS/CMS S3 exposed by Eclipse Dirigible. Full list can be found here.

Usage:

  • Navigate to the Document perspective in your Eclipse Dirigible instance
  • Upload a file and you should see the file in the perspective as well as in the S3 bucket

Test environment with LocalStack

If you prefer working with a test environment you can use LocalStack.

Setup:

  • Install LocalStack on your machine using the installation guide here or the following commands:

    • MacOS - brew install localstack/tap/localstack-cli

    • Linux -

      For x86-64:

       curl -Lo localstack-cli-3.0.2-linux-amd64-onefile.tar.gz \ 
  https://github.com/localstack/localstack-cli/releases/download/v3.0.2/localstack-cli-3.0.2-linux-amd64-onefile.tar.gz

      For ARM64:

      curl -Lo localstack-cli-3.0.2-linux-arm64-onefile.tar.gz \
  https://github.com/localstack/localstack-cli/releases/download/v3.0.2/localstack-cli-3.0.2-linux-arm64-onefile.tar.gz

      Then extract the LocalStack CLI from the terminal:

      sudo tar xvzf localstack-cli-3.0.2-linux-*-onefile.tar.gz -C /usr/local/bin
  • Start LocalStack using - localstack start -d
  • Set up the environment variables, mainly DIRIGIBLE_S3_PROVIDER=localstack, exposed by Eclipse Dirigible

Additional Information

License

This project is copyrighted by Eclipse Dirigible contributors and is available under the Eclipse Public License v 2.0. See LICENSE.txt and NOTICE.txt for further details.

FOSSA Status

Contributors

If you like to contribute to Dirigible, please read the Contributor's guide.

Attribution links

Unicons by IconScout: https://github.com/Iconscout/unicons

References