EBAD

EBAD is a project to run your batchs on remote server from a central place.

⚠️ To build EBAD please read this : ⚠️

You need a github token to get all maven package. Please read this article : https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry

Getting Started

These instructions womm get you a working application.

Configuration

To configure your application create application.yml file

Database

spring:
  datasource:
    url: jdbc:postgresql://<url>:<port>/<database>?stringtype=unspecified
    username: <username>
    password: <password>

Replace with your values.

For initialize data (global settings, user and roles) activate spring profile "init-database" for example :

java -jar <downloaded-release>.jar --spring.profiles.active=jwt,init-database --spring.config.additional-location=<path-to-your-application.yml>

Remember to remove it for next application start

SSH Connection

For the ssh connection edit this values :

ebad:
  ssh:
    login: <login>
    private_key_path: </path/to/key>

Replace with your values.

Authentication JWT

If you use JWT authentication edit the JWT Secret

ebad:
  security:
    authentication:
      jwt:
        secret: <my-secret-token-to-change-in-production>

Replace with your values.

In case you want use JWT (standalone mode) run with "jwt" Spring profile

java -jar <downloaded-release>.jar --spring.profiles.active=jwt --spring.config.additional-location=<path-to-your-application.yml>

By default this application run on port 10300 and context ebad : http://localhost:10300/ebad

Then, your back is running, after this run ebad-front project. The user created is admin / admin .

Authentication OAUTH2

If you use OAUTH2 authentication edit you application.yml file

security:
  oauth2:
    resource:
      user-info-uri: <URL-USER-INFO>
      prefer-token-info: true
      jwt:
        key-value: <JWT-KEY-VALUE>
    client:
      client-id: <CLIENT-ID>
      client-secret: <CLIENT-SECRET>

ebad:
  security:
    mapping-user:
      authorities: <AUTHORITIES_USER_INFO_FIELD>
      login: sub
      firstname: <FIRSTNAME_USER_INFO_FIELD>
      lastname: <LASTNAME_USER_INFO_FIELD>
      email: <EMAIL_USER_INFO_FIELD>

Replace with your values.

Then run this commandline

java -jar <downloaded-release>.jar --spring.config.additional-location=<path-to-your-application.yml>

Build project

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

the project needs Java 15+ and a PostgreSQL database. To build the project, Maven 3+ is required.

⚠️ You need a github token to get all maven package. Please read this article : https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry ⚠️

Installing

This project uses Spring Boot.
To build EBAD, use this command:

mvn clean package

And to run EBAD, use this command:

java -jar <generated-artifact>.jar

Running the tests

To run tests, use this command:

mvn clean verify

Break down into end to end tests

We use cypress for end to end tests with other ebad-front project

Deployment

Add additional notes about how to deploy this on a live system

Keycloak

helm install keycloak -f values.yaml oci://registry-1.docker.io/bitnamicharts/keycloak ingress: enabled: true hostname: idp.local

Built With

• Maven - Dependency Management

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

For the available versions, see the releases on this repository.

Authors

• Damien Trouillet - Initial work - dtrouillet

See also the list of contributors who participated in this project.

License

This project is licensed under the Apache 2.0 License - see the LICENSE.md file for details