Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update ontoportal docker to use docker compose of the ui and api #6

Closed
wants to merge 6 commits into from
Closed

Conversation

imadbourouche
Copy link
Member

@imadbourouche imadbourouche commented Jan 19, 2024

Prequisities

Proposition

The Ontoportal_docker repository has simplified the way ontoportal development works by containerizing the appliance component (API, UI ...etc).

The main goal of this PR is to make a one-click solution designed to simplify the Running and deployment of the Ontoportal appliance. This script streamlines the process of setting up and running the Ontologies API and User Interface (UI) components on your local machine or deploying it on a remote server.

This script also gives the user the ability to make his own configuration that has to be in the .env file. So it has two modes:

  • default mode: where the script will pull the configuration from ontoportal-lirmm
  • personalized mode: where the script will use the .env file provided by the user

You can find here the full documentation: Documentation

Demonstration Video: Demo

How it works

just run ./ontoportal help to see the help

➜  ontoportal_docker git:(main) ./ontoportal help
Usage: ./ontoportal <command>

Commands:
  start   : Start the ontologies API and UI (Default Mode / Personilized Mode)
  deploy  : Deploy the application using Kamal to the server
  stop    : Stop the API and UI services
  clean   : Clean up the server (remove ontologies_linked_data, docker-compose files, and remove all containers)
  help    : Show this help message

Additional notes:
- You can provide your own .env file to customize parameters:
  Just put the .env file in this directory and run ./ontoportal start

Run The appliance (API + UI)

./ontoportal start

Stop The appliance (API + UI)

./ontoportal stop

Clean The server: this will remove all docker-compose files and containers

./ontoportal clean

Deploy The appliance on a server: this will deploy the api and the ui on a server using configuration in .env file

./ontoportal deploy

ontoportal Outdated Show resolved Hide resolved
ontoportal Outdated Show resolved Hide resolved
ontoportal Show resolved Hide resolved
ontoportal Outdated Show resolved Hide resolved
ontoportal Outdated Show resolved Hide resolved
ontoportal Outdated Show resolved Hide resolved
ontoportal Outdated Show resolved Hide resolved
ontoportal Outdated Show resolved Hide resolved
ontoportal Outdated Show resolved Hide resolved
@syphax-bouazzouni
Copy link

syphax-bouazzouni commented Jan 24, 2024

Also, you(@imadbourouche) need to add the .env.sample file of the ontoportal docker

- Added support for user-defined environment variables
- Give the user ability to:
   - start/deploy the services that he wants (api / ui / ontoportal)
   - specify the source of his project (docker compose files)
- Fixing some functionalities:
   - fix the clean/stop methods to clean/stop only the services related to our project
- Refactored code for better readability and maintainability
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants