File Server Configuration

Instructions to configure the Avo Assure File Server

Prerequisites

1. Ensure Webserver (avoassurewebserver.exe) is running.

2. Create a folder in the server machine (preferably in the WebServer folder, named "PatchUpdate").

3. Copy manifest.json file to this folder ("patchUpdate" folder).

4. For the 'Download ICE' feature, AvoAssure_ICE.zip should be added (or replaced) to this folder ("PatchUpdate" folder)

5. Create a folder (inside the "PatchUpdate" folder) with the alpha version (major-minor) of the AvoAssure_ICE patch. (Eg: if the Patch provided is AvoAssure_ICE_X.Y.Z, then folder X.Y should be created). If the folder with the alpha versioning is already created, then this step can be ignored. Note: The folder structure should be maintained.

Folder Structure for Patch Updater

6. Place AvoAssure_ICE_X.Y.Z.zip (patch file) files in this folder location. Note: The patch files must have the same alpha version as the folder name.

Patch File Placement

7. Copy the absolute path of this folder, then navigate to the ‘webapp/.env’ file and add this folder path to variable HOST_PATH.

8. ‘File_Server_Port’ (in webapp/.env file) is set to 5100 by default. Any changes in port are to be made here.

Starting the Server

1. Open an elevated command prompt in the ‘webapp’ folder.

2. Type ‘run-fileserver.bat’ and hit enter. Alternatively, type ‘npm run filestart’ and hit enter.

3. Upon successful start, you will receive the following message: ‘!!!!!File Server is up!!!!!’

Starting the File Server

4. Avo Assure File Server is available at ‘https://<localhost>:5100’ or ‘https://< localhost >:<port_configured>’. Open the URL in a browser depending on the port they selected (to verify the above).

Stopping the Server

1. Close the command prompt window in which the File Server is running.

Installing the Server as a Window Service

1. Open an elevated command prompt in the ‘webapp’ folder.

2. Type ‘install-fileserver-service.bat’ and hit enter.

Installing File Server as a Service

Starting the Windows Service

1. Open an elevated command prompt in the ‘webapp’ folder. Note: avoassurefileserver.exe service should already be installed.

2. Type ‘start-fileserver-service.bat’ and hit enter.

Starting File Server as a Service

Stopping the Windows Service

1. Open an elevated command prompt in the ‘webapp’ folder. Note: avoassurefileserver.exe service should be running.

2. Type ‘stop-fileserver-service.bat’ and hit enter.

Stopping File Server Service

Removing the Windows Service

1. Open an elevated command prompt in the ‘webapp’ folder. Note: avoassurefileserver.exe service should be in the stopped state.

2. Type ‘remove-fileserver-service.bat’ and hit enter.

Removing File Server Service

Restarting the Windows Service

1. Open an elevated command prompt in the ‘webapp’ folder.

2. Run the following commands in sequential order i.e., only after the previous command has been completed:

   1. Type ‘stop-fileserver-service.bat’ and hit enter.

   2. Type ‘remove-fileserver -service.bat’ and hit enter.

   3. Type ‘install-fileserver -service.bat’ and hit enter.

   4. Type ‘start-fileserver -service.bat’ and hit enter.

Troubleshooting

In case any of the above-mentioned steps fail, ensure the following points have been taken care of:

1. Commands are being run with an elevated command prompt (i.e., prompt has Administrator privileges).

2. Ensure port 5100 (or any custom selected port) is available and not used by any other program.

3. There are no spaces or special characters (such as ! @ # $ % ^ & ( ) + - = { } , . ; ' [ ] ~ `) in the folder name (and entire path) where the WebServer is being extracted. Example:

   1. Valid: D:\AvoAssure\Server\WebServer\

   2. Invalid: D:\AvoAssure install files\Server\WebServer\

   3. Invalid: D:\AvoAssure\Server@files\WebServer\

4. If all the above scenarios hold true and the server is still not running, please contact Avo Assure Support Team.