Server installation by the Installer

A.V.A.T.A.R offers a PowerShell application for automatic installation.
For those who want full control, you can also install it manually. Simply open "Manual installation" and follow the section corresponding to your platform.

Danger

The “Installer” application will delete an existing version in the same installation directory.
If you reinstall A.V.A.T.A.R Server, remember to backup your plugins!

To backup and restore them, you can use the Backup/Restore command in the A.V.A.T.A.R. menu.

Preparing the package

Download A.V.A.T.A.R server zip file from GitHub.
- Click on the button and Download zip.
Extract the A.V.A.T.A.R-Server-master.zip file using "Extract or Extract here" selection.
Run PowerShell regarding the platform:

Warning

Check the PowerShell version, it must be 7.0 or higher.
If the version is lower than 7.0, see the PowerShell section for more information.
WindowsLinuxmacOS
1. Run PowerShell from "All applications" menu.
2. Change to A.V.A.T.A.R-Server-master/ directory.
  > cd $env:HOMEPATH\downloads\A.V.A.T.A.R-Server-master
1. Open a terminal
2. Change to downloads/A.V.A.T.A.R-Server-master directory.
  $ cd downloads/A.V.A.T.A.R-Server-master $ pwsh
1. Open a terminal
2. Change to downloads/A.V.A.T.A.R-Server-master directory.
  % cd downloads/A.V.A.T.A.R-Server-master % pwsh

Start the installer

Parameters

Below are the mandatory or optional parameters added to the command:

Parameter	Windows	linux	macOS	Comment
`-help`				Display help about the Installer.
`-directory`				`Windows`: mandatory parameter. The installation can be made only in a directory. You must enter a full path. `linux` and `macOS`: optional parameter. The installation is made in this directory. The user home directory is automatically added with the directory.
`-application`				`Windows`: Unable to install the server as Windows application. `linux` and `macOS`: optional parameter. The server is installed as an application. The directory is automatically set.
`-shortcut`				`Windows`: optional parameter. If it is present, an application shortcut is created on the desktop. `linux`: optional parameter, only for the `-directory` parameter. If it is present, a server shortcut is created in the dock. `macos`: A shorcut is automatically created.

Examples

WindowsmacOSlinux

Installing the server in the "c:\avatar\server" directory and no desktop shortcut:
```
./installer.ps1 -directory "c:\avatar\server"
```
Installing the server in the "c:\avatar\server" directory with a desktop shortcut:
```
./installer.ps1 -directory "c:\avatar\server" -shortcut
```

Installing the server as an application:
```
./installer.ps1 -application
```
Installing the server in a "$HOME/avatar/server" directory (The $HOME is automatically added):
```
./installer.ps1 -directory "avatar/server"
```

Installing the server as an application:
```
./installer.ps1 -application
```
Installing the server in a "$HOME/avatar/server" directory and no desktop shortcut (The $HOME is automatically added):
```
./installer.ps1 -directory "avatar/server"
```
Installing the server in a "$HOME/avatar/server" directory with a desktop shortcut (The $HOME is automatically added):
```
./installer.ps1 -directory "avatar/server" -shortcut
```

Execution of the installer

Regarding want you want to do, start the installer with its parameters.

WindowslinuxmacOS

For an installation in the c:\avatar\server directory and a desktop shortcut:

> ./installer.ps1 -directory "c:\avatar\server" -shortcut

Warning

The following error message may appear when starting PowerShell.
This is due to the Windows security policy, since this script has no digital signature.

Enter the following command to bypass execution of the security policy temporarily and only for this PowerShell session (after closing, the next window will use the defined security policy again):
```
Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
```
Restart the Installer

For an installation as linux application:

> ./installer.ps1 -application

For an installation as macOS application:

> ./installer.ps1 -application

You can stop or start the installation by answer "Y" or "N" ("Y" by default).

Note

The installer warns you with messages if anything might prevent installation.

Installation of the A.V.A.T.A.R. server is automatic and requires no additional input.

End of the installation

At the end of the installation, the following message should appear:

Warning

If this message does not appear, an error has stopped the installation.
You can check the error on the terminal or in the ./server-installer.log file.
Once you've corrected whatever prevented the installation from continuing, you can retrieve the command and run it again.

Start A.V.A.T.A.R server

Depending of the platform and the installation type, choose an action to start A.V.A.T.A.R:

WindowslinuxmacOS

Type	Action
Click on the executable	1. Open a Windows explorer and change to the `-directory` parameter directory. 2. Double-click on the A.V.A.T.A.R-Server.exe file
Shortcut	Click on the A.V.A.T.A.R server shortcut in the desktop environment

Parameter	Type	Action
`-application`	linux application	1. Show applications and click on the A.V.A.T.A.R Server application
`-directory`	standalone	1. Open a file explorer and change to the `-directory` parameter directory. 2. Double-click on the A.V.A.T.A.R-Server file
`-directory` and `-shortcut`	standalone	2. Double-click on the A.V.A.T.A.R Server icon in the dock

Parameter	Type	Action
`-application`	macOS application	1. Open a Finder and click on the A.V.A.T.A.R Server application
`-directory`	standalone	1. Open a Finder and change to the `-directory` parameter directory. 2. Double-click on the A.V.A.T.A.R-Server app directory For a shortcut, `Options`->`Keep in dock`

Warning

Warning: if you have anti-virus software, it may notify you that the application does not have a valid digital signature.
Click on "always authorize".

WindowslinuxmacOS

Mandatory parameters

You're starting the server for the first time.
Although some server properties have been configured automatically, others need to be changed quickly.

Do a right click here and select 'Open link in new tab' to display the Server Settings page access.
Then, change these parameters to complet the installation:
- Default client - Mandatory -
  - The name of a default client when it is homis in an action to be executed (enter the name of the most frequently used client).
  - At the installation, this parameter is empty.
- Application language - Optional -
  - Defines the language used for all graphical interfaces and application messages.
  - At the installation, this parameter is set to "English".
  - If "English" is the language you need, you can bypass this step.
- Communication port (HTTP) - Optional -
  - The communication port used by all clients with the A.V.A.T.A.R Server.
  - At the installation, this parameter is set to "3000".
  - If this port is not used by another application you can leave this number and bypass this step.
- Background image - Optional -
  - A Background image for the server. Not mandatory but so much nicer!

Test the installation

Install a client first then at the end of the client installation step, you'll see a step for testing the installation.

Introduction Client installation through the installer