API checks
Container builder
Bandit Workflow
Prospector Workflow

Web application
Package builder

Licence
FOSSA

Social networks
Twitter

openXeco compatibility

openXeco middleware version	compatible openXeco core versions
v1.0.0	v1.17.x

Set up an instance

For development

To set up the dev environment, please see those sub-project README files:

• oxe-api/README.md
• oxe-web/README.md

For testers

If you want to set up a local instance to test the project, please follow these instructions:

Install docker

Get Docker

Linux:

$ sudo mkdir -p /etc/apt/keyrings/
$ curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg
$ echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu \
  $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
$ sudo apt update && sudo apt install docker-ce docker-ce-cli containerd.io docker-compose-plugin
$ sudo adduser <your-oxe-user> docker
$ newgrp docker
# If you want to verify your docker install run: docker run hello-world

Install and run the openXeco containers and its dependencies

$ docker network create openxeco
$ docker build \
    -f openxeco-eccc-middleware-oxe-web/Dockerfile \
    -t oxe-web \
    --build-arg TARGET_DIR=openxeco-eccc-middleware-oxe-web \
    https://github.com/CybersecurityLuxembourg/openxeco-eccc-middleware/releases/latest/download/openxeco-eccc-middleware-oxe-web.tar.gz
$ docker run -d -p 3006:80 oxe-web
$ docker run -d -p 5002:5002 \
    --network openxeco \
    -e ENVIRONMENT=dev \
    -e JWT_SECRET_KEY=my_secret_developer_key \
    -e OPENXECO_API_ENDPOINT=http://localhost:5000/ \
    -e ECCC_API_ENDPOINT=http://eccc.example.com/ \
    -e ECCC_API_KEY=ECCC_EXAMPLE_KEY \
    ghcr.io/cybersecurityluxembourg/openxeco-eccc-middleware-oxe-api:latest

Enjoy the solution

Access the user interface:

• http://localhost:3006

Access the API documentation:

• http://localhost:5002