API checks
Container builder
Bandit Workflow
Prospector Workflow

Admin web
Package builder

Community web
Package builder

Licence
FOSSA

Social networks
Twitter

Set up an instance

For developers

With Docker (easy mode)

It required to have docker installed: Get Docker

This is compatible with Windows and Unix distributions (including MacOS). The web apps and the API containers handle the hot reloading for a better development expetience.

• Clone the project
• Change Dir to the freshly cloned project
• Run these commands:

$ docker compose up

This process might require several minutes at first idue to the Docker images setup.

Without Docker (hard mode)

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

• oxe-api/README.md
• oxe-web-admin/README.md
• oxe-web-community/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

Install and run the openXeco containers and its dependencies

$ docker network create openxeco
$ docker run -d \
    --network openxeco \
    --network-alias mariadb \
    -p 3306:3306 \
    -e MARIADB_ROOT_PASSWORD=E4syPass \
    mariadb:10.7.3
$ docker run -d \
  --network openxeco \
  --network-alias smtp \
  -p 1025:1025 \
  -p 1080:1080 \
  reachfive/fake-smtp-server
$ docker build \
    -f openxeco-core-oxe-web-admin/Dockerfile \
    -t oxe-web-admin \
    --build-arg TARGET_DIR=openxeco-core-oxe-web-admin \
    https://github.com/CybersecurityLuxembourg/openxeco-core/releases/latest/download/openxeco-core-oxe-web-admin.tar.gz
$ docker run -d -p 3000:80 oxe-web-admin
$ docker build \
    -f openxeco-core-oxe-web-community/Dockerfile \
    -t oxe-web-community \
    --build-arg TARGET_DIR=openxeco-core-oxe-web-community \
    https://github.com/CybersecurityLuxembourg/openxeco-core/releases/latest/download/openxeco-core-oxe-web-community.tar.gz
$ docker run -d -p 3001:80 oxe-web-community
$ docker run -d -p 5000:5000 \
    --network openxeco \
    -e ENVIRONMENT=dev \
    -e JWT_SECRET_KEY=my_secret_developer_key \
    -e DB_HOSTNAME=mariadb \
    -e DB_PORT=3306 \
    -e DB_NAME=OPENXECO \
    -e DB_USERNAME=root \
    -e DB_PASSWORD=E4syPass \
    -e MAIL_SERVER=smtp \
    -e MAIL_PORT=1025 \
    -e MAIL_USE_TLS=True \
    -e MAIL_USE_SSL=False \
    -e [email protected] \
    -e IMAGE_FOLDER=/image_folder \
    -e DOCUMENT_FOLDER=/document_folder \
    -e [email protected] \
    ghcr.io/cybersecurityluxembourg/openxeco-core-oxe-api:latest

Enjoy the solution

Access the administrator interface:

• http://localhost:3000

Access the community interface:

• http://localhost:3001

Access the API documentation:

• http://localhost:5000

Access the emails sent on the SMTP mock:

• http://localhost:1080

An initial account is created with the following email: "[email protected]" And a default password: "Passw0rd!"

For production server

To set up the production instance, please see this file:

• doc/INSTALL_SERVER.md