Skip to content

Manual server installation on Windows

Preparing the package

  1. Download A.V.A.T.A.R server zip file from GitHub.
    • Click on the code button and Download zip.
  2. Extract the A.V.A.T.A.R-Server-master.zip file by the "Extract or Extract here" selection.
  3. Create a C:\packager\server directory which will be used to package the application.
  4. Copy the contents of downloads\A.V.A.T.A.R-Server-master\dist to C:\packager\server.

    > cd C:\A.V.A.T.A.R-Server-master/dist
    > xcopy /E *.* C:\packager\server
    

Installing the packager module

  1. Open a terminal DOS
  2. Change to C:\packager\server_ directory:

    cd C:\packager\server
    

  3. Enter the following command to install the packager and all application modules:

    C:\packager\server> npm install --save-dev @electron/packager
    

    About deprecated modules

    You can ignore messages about deprecated modules.
    These messages are not important and the installation can continue.

  4. After a few moments, you should see the following result:

    added <xxx> packages, and audited <xxx> packages in 15s
    
    <xx> packages are looking for funding
    run `npm fund` for details
    
    found 0 vulnerabilities
    

    About vulnerabilities

    The application is updated regularly, but it is possible that you may discover vulnerabilities.
    If this is the case, installation is unaffected and can continue.
    You can also contribute by leaving an issue to update the application.

Running the packager module

In order to have the latest version of Electron for your installation, you need to retrieve the latest version from the Electron GitHub which will be used to package it.

  1. Go to the Electron GitHub web site and on the right side, in the Releases section, below the About section, note the latest version (as in the example image below, framed in red):

  2. Run the packager:

    • Suppose that the lastest version readed on the Electron site is 34.8.1, then change the XX.X.X value to the latest version in the --electron-version=XX.X.X parameter in the command line below then execute it.

    C:\packager\server> npx electron-packager . --electron-version=XX.X.X --icon=./avatar.ico --out=output
    
    3. After a few moments, you should see the following result (varies by platform):
    Packaging app for platform win32 x64 using electron vXX.X.X (the latest version from Electron GitHub site)
    Wrote new app to: output\A.V.A.T.A.R-Server-win32-x64
    

installing Electron module

  1. Change to the output/A.V.A.T.A.R-Server-win32-x64/A.V.A.T.A.R-Server.app/resources/app directory:

    C:\packager\server> cd ./output/A.V.A.T.A.R-Server-win32-x64/resources/app
    
  2. Enter the following command to install Electron in the package:

    C:\packager\server\output\A.V.A.T.A.R-Server-win32-x64\resources\app> npm install electron --save-dev
    

  3. After a few moments, you should see the following result:
    added <xxx> packages, changed <x> packages, and audited <xxx> packages in 13s
    
    <xx> packages are looking for funding
    run `npm fund` for details
    
    found 0 vulnerabilities
    

Deploy A.V.A.T.A.R server as an application

A.V.A.T.A.R server is now ready to be moved into its application directory.

  1. Create a directory for the A.V.A.T.A.R server application (e.g. C:\avatar\server).
  2. Copy (or move) the contents of the output\A.V.A.T.A.R-Server-win32-x64 directory to C:\avatar\server.

    > cd C:\packager\client\output\A.V.A.T.A.R-Server-win32-x64
    C:\packager\client\output\A.V.A.T.A.R-Server-win32-x64> xcopy /E *.* C:\avatar\client
    
  3. Delete the C:\packager\server directory.

  4. Add a desktop shortcut:
    • Do a right click on the desktop environment
    • In the menu, select New -> Shortcut
    • Select C:\avatar\server\A.V.A.T.A.R-Server.exe as element
    • Click Next
    • Enter a name for the shortcut (eg. A.V.A.T.A.R Server)
    • Click Done

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

  1. Start A.V.A.T.A.R server by clicking on its desktop icon.
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".

You can now set some mandatory parameters at server startup.

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.

  1. Do a right click here and select 'Open link in new tab' to display the Server Settings page access.
  2. 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" (you can choose between "English or "French").
      • 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 Manual client installation on Windows