Skip to content
README.md 3.07 KiB
Newer Older
Gilles Mouchard's avatar
Gilles Mouchard committed
DECODER platform deployment using docker-compose
================================================

Introduction
------------

This program provides a command line interface and a control center for managing the services (download, install, update, start, ...) of DECODER EU Project Tool-chain, and will basically execute a [docker-compose file](https://gitlab.ow2.org/decoder/docker-deployment/-/blob/main/app/share/decoder-eu/docker-compose.yaml) with variable replacement and multiple checks. The docker-compose file can also be executed manually.
Gilles Mouchard's avatar
Gilles Mouchard committed

Minimum Hardware Requirements
-----------------------------

* 16 GiB RAM
* ~100 GB disk free space
* Internet connection

Gilles Mouchard's avatar
Gilles Mouchard committed
Dependencies
------------

* docker and docker-compose (for Mac, see [Install Docker Desktop on Mac](https://docs.docker.com/docker-for-mac/install))
Gilles Mouchard's avatar
Gilles Mouchard committed
* cURL
* xdg-open (optional)
* zenity (optional)
Gilles Mouchard's avatar
Gilles Mouchard committed

Gilles Mouchard's avatar
Gilles Mouchard committed
Control center
--------------

![Control center](control_center.png)

Command line interface
----------------------

	Usage: decoder-eu [<options>] [<commands>]
Gilles Mouchard's avatar
Gilles Mouchard committed
	    This program provides a command line interface and a control center for managing the components (download, install, update, start, ...) of DECODER EU Project Tool-chain.
	    When command list is empty and zenity (https://help.gnome.org/users/zenity/) is installed, it displays a control center, otherwise it displays this help.
Gilles Mouchard's avatar
Gilles Mouchard committed
	Options:
Gilles Mouchard's avatar
Gilles Mouchard committed
	    --version
	        Outputs version information and exit
Gilles Mouchard's avatar
Gilles Mouchard committed
	    --help
	        Display this help and exit
Gilles Mouchard's avatar
Gilles Mouchard committed
	    --user-pref-dir <directory>
Gilles Mouchard's avatar
Gilles Mouchard committed
	        Set the directory where the user's preferences are located (default: ~/.config/decoder-eu)
Gilles Mouchard's avatar
Gilles Mouchard committed
	    --user-data-dir <directory>
	        Set the directory where the user's data are located (default: ~/.local/share/decoder-eu)
Gilles Mouchard's avatar
Gilles Mouchard committed
	Commands:
Gilles Mouchard's avatar
Gilles Mouchard committed
	    start
	        Starts the DECODER EU Project Tool-chain services then opens the GUI in your default browser
Gilles Mouchard's avatar
Gilles Mouchard committed
	    gui
	        Opens the GUI in your default browser
Gilles Mouchard's avatar
Gilles Mouchard committed
	    stop
	        Stops the DECODER EU Project Tool-chain services'
Gilles Mouchard's avatar
Gilles Mouchard committed
	    status
	        Shows the status of the DECODER EU Project Tool-chain services
Gilles Mouchard's avatar
Gilles Mouchard committed
	    shell
	        Starts a shell with a preset environment
Gilles Mouchard's avatar
Gilles Mouchard committed
	    reset
Gilles Mouchard's avatar
Gilles Mouchard committed
	        Resets all data (but preserve your saved preferences) (default: in ~/.local/share/decoder-eu)
Gilles Mouchard's avatar
Gilles Mouchard committed
	    select-tools
	        Select the tools considered for start, install and update commands
Gilles Mouchard's avatar
Gilles Mouchard committed
	    configure
Gilles Mouchard's avatar
Gilles Mouchard committed
	        Edit configuration file (default: in ~/.config/decoder-eu/config)
Gilles Mouchard's avatar
Gilles Mouchard committed
	    delete-prefs
Gilles Mouchard's avatar
Gilles Mouchard committed
	        Delete your saved preferences (default: in ~/.config/decoder-eu)
Gilles Mouchard's avatar
Gilles Mouchard committed
	    install
	        Downloads, install, and preconfigure DECODER EU Project Tool-chain ready to use
Gilles Mouchard's avatar
Gilles Mouchard committed
	    update
	        Update DECODER EU Project Tool-chain (without altering your saved preferences)
Gilles Mouchard's avatar
Gilles Mouchard committed
	    uninstall
	        Uninstall DECODER EU Project Tool-chain (but preserve your saved preferences)
Gilles Mouchard's avatar
Gilles Mouchard committed

Gilles Mouchard's avatar
Gilles Mouchard committed
Licensing information
---------------------

Gilles Mouchard's avatar
Gilles Mouchard committed
Copyright (c) 2021 Capgemini Group, Commissariat à l'énergie atomique et aux énergies alternatives, OW2, Sysgo AG, Technikon, Tree Technology, Universitat Politècnica de València.
Gilles Mouchard's avatar
Gilles Mouchard committed

License: GNU GPL v2.0, see LICENSE.