Skip to content

Manual server installation on macOS

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 using "Extract or Extract here" selection..
  3. In your Desktop, create a packager/server directory which will be used to package the application.

  4. Copy the contents of Downloadsd/A.V.A.T.A.R-Server-master/dist to Desktop/packager/server.

    $ cd Downloads/A.V.A.T.A.R-Server_-master/dist
$ cp - r * $HOME/Desktop/packager/server_

Installing the packager module

  1. Open a terminal
  2. Change to ./Desktop/packager/server_ directory: 
    cd ./Desktop/packager/server

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

    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, 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.

    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-darwin-x64

    Warning

    The architecture name depends of the packaging, it can be A.V.A.T.A.R-Server-darwin-x64 or A.V.A.T.A.R-Server-darwin-arm64.

    In the section below, we assume that it is A.V.A.T.A.R-Server-darwin-x64 but it can be A.V.A.T.A.R-Server-darwin-arm64. If it is the case, change the directory name according to your platform.

Installing Electron module

  1. Change to output/A.V.A.T.A.R-Server-darwin-x64/A.V.A.T.A.R-Server.app/Contents/Resources/app directory: 
    server % cd ./output/A.V.A.T.A.R-Server-darwin-x64/A.V.A.T.A.R-Server.app/Contents/Resources/app
  2. Enter the following command to install Electron: 
    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.

You have two possible choices:

  1. Copy (or move) the contents of the Desktop/packager/server/output/A.V.A.T.A.R-Server-darwin-x64 directory to a Desktop directory and start the server with the A.V.A.T.A.R-Server.app application icon.
  2. Create an A.V.A.T.A.R-Server application.

Choose what you want to do below (between « Move to a Desktop directory » or « Create an application »)

  1. Open a Finder and change to Desktop/packager/server/output/A.V.A.T.A.R-Server-darwin-x64 directory.
  2. Select the A.V.A.T.A.R-Server icon and drop it to the Applications section (to the left of the Finder)
  1. Create a directory for the A.V.A.T.A.R server (e.g. Desktop/avatar/server).

  2. Copy (or move) the contents of the Desktop/packager/server/output/A.V.A.T.A.R-Server-darwin-x64 directory to Desktop/avatar/server. 

    cd /Users/<account>/Desktop/packager/server/output/A.V.A.T.A.R-Server-darwin-x64
mv -r * /Users/<account>/Desktop/avatar/server

    note: You can use a Finder to do the same thing.

  3. Delete the Desktop/packager/ directory.

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

Start the A.V.A.T.A.R Server according to the installation choice:

  • In a directory:
    • Click on the A.V.A.T.A.R-Server.app icon in the installation directory.
  • As an application:
    • Locate the A.V.A.T.A.R Server application in the Applications list and run it.
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".

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 Client installation