🔗 Ligoj - API - UI

A web application to centralize the related tools of your projects, a dynamic connection management with security and data collection.

More technical details can be found in the subdirectories ligoj-api and ligoj-ui.

Big Thanks

Cross-browser Testing Platform and Open Source <3 Provided by Sauce Labs

Get started

curl https://raw.githubusercontent.com/ligoj/ligoj/master/docker-compose.yml -o docker-compose.yml -s && docker-compose up

Open your browser at : Ligoj Home User/password for administrator role : ligoj-admin and ligoj-user for a regular user

You can install the plug-ins for RBAC security : plugin-id,plugin-id-ldap,plugin-id-ldap-embedded

Dev section

See Wiki page

See each container ligoj-api and ligoj-ui.

License

Installation guides

One script rebuild and run

Docker, compose and git install, then build, then run.

sudo yum install -y docker git
sudo pip3 install docker-compose
sudo usermod -a -G docker ec2-user
sudo systemctl enable docker.service
sudo systemctl start docker.service
git clone https://github.com/ligoj/ligoj.git
cd ligoj
mkdir -p "$(pwd)/.ligoj"
echo "LIGOJ_HOME=$(pwd)/.ligoj
PODMAN_USERNS=keep-id" > .env
docker-compose -p ligoj up -d --build
open http://localhost:8080/ligoj

Publish to AWS ECR

AWS_ACCOUNT="$(aws sts get-caller-identity --query "Account" --output text)"
AWS_REGION="$(curl -s http://169.254.169.254/latest/meta-data/placement/availability-zone | sed 's/\(.*\)[a-z]/\1/')"
ECR_REGISTRY=$AWS_ACCOUNT.dkr.ecr.$AWS_REGION.amazonaws.com
docker image tag ligoj/ligoj-api:4.0.0 $ECR_REGISTRY/ligoj/ligoj-api:4.0.0
docker image tag ligoj/ligoj-ui:4.0.0 $ECR_REGISTRY/ligoj/ligoj-ui:4.0.0
aws ecr get-login-password --region $AWS_REGION | docker login --username AWS --password-stdin $ECR_REGISTRY
docker push $ECR_REGISTRY/ligoj/ligoj-api:4.0.0
docker push $ECR_REGISTRY/ligoj/ligoj-ui:4.0.0

Advanced deployments with compose

Custom Docker Compose variables

Variable	Service	Phase	Default	Note
LIGOJ_HOME	api	RUN	/home/ligoj	To map a persistent home
LIGOJ_REGISTRY	*	BUILD		To push to your registry. When provided, must ends with /.
LIGOJ_VERSION	app-*	BUILD	(version of application)
LIGOJ_WEB_PORT	web	RUN	8080	Internal WEB port
LIGOJ_PORT	web	RUN	8080	Exposed port
LIGOJ_API_JAVA_OPTIONS	api	RUN	-Duser.timezone=UTC
LIGOJ_WEB_JAVA_OPTIONS	web	RUN	-Duser.timezone=UTC -Dsecurity=Rest
LIGOJ_API_CRYPTO	api	RUN	-Dapp.crypto.password=public	Double encryption feature, see core-context-common.xml
LIGOJ_WEB_CRYPTO	web	RUN	-Dapp.crypto.password=public	Double encryption feature, see core-context-common.xml
LIGOJ_API_CUSTOM_OPTS	api	RUN	``	Additional Java properties LIGOJ_API_JAVA_OPTIONS
LIGOJ_WEB_CUSTOM_OPTS	web	RUN	``	Additional Java properties, merged with LIGOJ_WEB_JAVA_OPTIONS
LIGOJ_BUILD_PLATFORM	app-*	BUILD	linux/amd64	Docker build platform.
LIGOJ_TARGET_PLATFORM	app-*	BUILD	linux/amd64	Docker run platform.

Sample .env file:

LIGOJ_HOME=/var/data/ligoj
PODMAN_USERNS=keep-id
LIGOJ_BUILD_PLATFORM=linux/arm64
LIGOJ_TARGET_PLATFORM=linux/arm64
LIGOJ_REGISTRY=nexus.sample.local/
LIGOJ_API_PREPARE_BUILD='export HTTP_PROXY=192.168.0.254:8000 && export HTTPS_PROXY=192.168.0.254:8000'

Custom Docker Compose discovered scripts

Source	Service	Destination	Phase	Note
prepare-build.sh	app-*	WORKDIR	BUILD	Additional Bash commands executed inside the builder , before mvn but after MAVEN_OPTS is set.
prepare-run.sh	app-*	WORKDIR	RUN	Additional Bash commands executed inside the final image, before java
.m2/	app-*	/root/.m2/	BUILD	Custom Maven configuration: proxy, mirror, dependencies,...

Sample prepare-build.sh file:

export http_proxy=192.168.0.254:8000
export https_proxy=192.168.0.254:8000

Persistent Ligoj home

By default, with Docker compose, the home is persistent it contains:

• plugins installation
• logs of containers
• database data

mkdir -p "$(pwd)/.ligoj"
echo "LIGOJ_HOME=$(pwd)/.ligoj
PODMAN_USERNS=keep-id" > .env

Use MySQL or PostgreSQL databases

By default, the Docker compose overrides is loaded from compose.override.yml and contains MySQL configuration.

For MySQL, the docker-compose command is:

export BUILDAH_FORMAT=docker
podman-compose -p ligoj build
podman-compose -p ligoj -f compose.yml  -f compose.override.yml up -d
podman-compose -p ligoj down

For PostgreSQL, the docker-compose command is:

export BUILDAH_FORMAT=docker
podman-compose -p ligoj build
podman-compose -p ligoj -f compose.yml  -f compose-postgres.yml up -d
podman-compose -p ligoj -f compose.yml  -f compose-postgres.yml down

API Description

API is only available from a valid session.

• Swagger UI page
• WADL

Plugin management

Ligoj is massively based on plugin management.

All plugins are deployed in Maven central

To build and deploy a plugin, more information are available in plugin-api repository.

Custom UI

Ligoj comes with a modular approach. For custom UI, the solutions are:

• Rebuild plugin-ui, with specific assets, and deploy this plugin in a custom Maven repository, or upload it with /system/plugin/{artifact}/{version} API
• Create your own plugin plugin-ui-company, with you specific assets: overrides and additions. Then install this plugin as above solution
• Copy you specific assets in the Ligoj home directory such as /home/ligoj/META-INF/resources/webjars, $(pwd)/.ligoj/META-INF/resources/webjars, depending on your runtime. For sample:

  # With Ligoj CLI
  ligoj file put --from /path/to/icon.png  --path "META-INF/resources/webjars/home/img/logo.png"
  
  # With local access of Ligoj home folder
  mkdir -p "${LIGOJ_HOME}/META-INF/resources/webjars/home/img" && cp /path/to/icon.png "$_/logo.png"