From 178647a0e65be00c57c96143a90684bdef10ae27 Mon Sep 17 00:00:00 2001 From: maugde <167874615+maugde@users.noreply.github.com> Date: Tue, 27 Aug 2024 11:59:20 +0200 Subject: [PATCH] docs: add installer directions (#2114) Addind the new installer to the package requires to update the documentation with new directions about how to install the application. In this PR, I added instructions for both CLI and GUI version of the installer. --- docs/install/2-DEPLOY.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/docs/install/2-DEPLOY.md b/docs/install/2-DEPLOY.md index 5946e362f9..1136e24410 100644 --- a/docs/install/2-DEPLOY.md +++ b/docs/install/2-DEPLOY.md @@ -80,3 +80,31 @@ You can download the latest version here: - [For Windows](https://github.com/AntaresSimulatorTeam/AntaREST/releases/download/v2.5.0/AntaresWeb-windows-latest.zip) - [For Ubuntu](https://github.com/AntaresSimulatorTeam/AntaREST/releases/download/v2.5.0/AntaresWeb-ubuntu-latest.zip) + +The local application contains an installer program that you can use to manage the installation. +This program will keep your local data while updating the functional parts of the server. + +### GUI installer (windows only) + +Double-click on the installer executable and follow the instructions. +In case you already have a local application, choose your current application path +in order to update it. + +### CLI installer (linux only) + +Open a new command prompt or powershell instance. +Run the following command: + +``` +AntaresWebInstaller -t +``` + +where `` is the directory where you want to install the Antares Web Desktop. + +Note that you can specify an existing directory as value of `TARGET_DIR`, in which case the installer will update the +existing installation. + +By default, the installer will generate shortcuts and launch the server at the end of the installation, but you +optionally can decide to deactivate these steps with `--no-shortcut` and `--no-launch`. + +Run ```AntaresWebInstaller --help``` for more options. \ No newline at end of file