Skip to content

Commit

Permalink
docs: add installer directions (#2114)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
maugde authored Aug 27, 2024
1 parent aa2216a commit 178647a
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions docs/install/2-DEPLOY.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <TARGET_DIR>
```

where `<TARGET_DIR>` 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.

0 comments on commit 178647a

Please sign in to comment.