Installation Mode
Select Required Features
Check the features you need to enable. Only the relevant installation steps will be shown.
Installation Steps
-
Download and Extract
Download the version that you would like from the releases page (use the "Service" download) (use the "Standalone" download), and extract the ZIP file. Copy the executable called
TarasaGateway.WindowsService.exeTarasaGateway.Client.exeand the json file calledclient-settings.jsonto%programfiles%/TarasaGateway/, which is likelyC:/Program Files/TarasaGateway. If this is your first time, you'll need to create this folder. Ensure the folder name is exactly TarasaGateway. a folder of your choice. -
Configure Settings
In the TarasaGateway folder, open the file named
client-settings.jsonin a text editor (Notepad works fine), and:- Change the
ServerUrlto the URL of the Tarasa application, including the/api/suffix, for examplehttps://www.example.com/api/ - Change the
ApiKeyto the API key of the user that should be used to connect to the gateway. - Add the
IntegrateUrlsetting with the URL to your Flexpoint Integrate server, for examplehttp://localhost:9995/integrate - Add the
FileLocationWhitelistsetting to control which files and folders the Tarasa Gateway Client is allowed to manage — see the dedicated step below for how this works.
- Change the
-
Install and Configure FlexpointFLEXPOINT
To enable Flexpoint functionality, you need to install Flexpoint and ensure the Flexpoint Integrate server is running.
- Install Flexpoint on the machine running the Tarasa Gateway Client
- Start the Flexpoint Integrate service
- Verify it is accessible at the URL you configured in
client-settings.json
-
Install Ghostscript for PDF PrintingPDF PRINTING
To enable PDF printing functionality, you'll need to manually install Ghostscript. Download the latest version of Ghostscript from https://www.ghostscript.com/download/gsdnld.html, and install it. Make sure it is installed in the "Program Files" folder, or that the "bin" directory is added to the PATH.
-
Install Microsoft Word for Word to PDF ConversionWORD TO PDF
To enable Word to PDF conversion functionality, you need to have Microsoft Word installed locally on the machine running the Tarasa Gateway Client. The gateway will use Word's COM automation to perform the conversion.
-
Configure Firewall for WebRTCWEBRTC
To enable local device connections via WebRTC, you need to allow outgoing connections in any firewall, including Windows Firewall.
-
Configure File Access (FileLocationWhitelist)MANAGING FILES
When the Tarasa server needs the gateway client to read, write, or list a file on this machine — for example to save an uploaded document, or fetch a report for someone — it does so through a command called
ManageFile. Which files that command is allowed to touch is controlled entirely by theFileLocationWhitelistsetting inclient-settings.json. Anything not covered by it is refused.FileLocationWhitelistis a list of entries. Each entry has three parts:- Alias — the entry's name (e.g.
"Logs","Uitwisseling") is not a folder path, it's a label. The Tarasa server refers to files using this label, so the exact same spelling must also be configured on the Tarasa server side. Two different gateway clients can use the same alias name to point at two completely different folders — the alias is just the shared vocabulary between server and client, not the location itself. This is useful, because the server does not need to know anything of the file system of the pc that runs that gateway client. Rootis the actual folder on this machine that the alias points to. It can be an absolute path, or a path relative to the Tarasa Gateway Client's working directory.Permissionslists, as single letters, which actions are allowed inside that folder:ccreate,rread,wwrite (overwrite),aappend,ddelete,llist. Combine as many as needed, in any order, e.g."rwad". A single request from the server can need more than one letter at once — for example, "create this file if it doesn't exist yet, otherwise add to the end of it" needs bothcandapresent. Having only one of the two means that request is refused whenever the file happens to be in the state the missing letter would have covered.
Example — two aliases with different access levels:
"FileLocationWhitelist": { "Uitwisseling": { "Root": "D:/tarasa/uitwisseling/", "Permissions": "crwad" }, "Logs": { "Root": "./logs/", "Permissions": "rl" } }Here,
"Uitwisseling"is a full-access alias pointing at a folder on theD:drive: the server can create, read, overwrite, append to, and delete files inside it."Logs"only allows reading and listing inside the gateway client's ownlogsfolder — the server can look at log files, but can't change or delete them. - Alias — the entry's name (e.g.
-
Create Windows Service
Open a command prompt as administrator, and run these two commands:
-
Basic installation (default settings):
sc.exe create "Tarasa Gateway" binpath= "C:\Program Files\TarasaGateway\TarasaGateway.WindowsService.exe" start=auto -
With custom configuration and log paths (optional):
sc.exe create "Tarasa Gateway" binpath= "\"C:\Program Files\TarasaGateway\TarasaGateway.WindowsService.exe\" --config my-settings.json --log mylogs" start=auto -
Configure failure recovery:
sc.exe failure "Tarasa Gateway" reset=0 actions=restart/60000/restart/60000/run/1000
Note: Choose either option 1 (default) or option 2 (custom paths), not both. Then run option 3 to configure failure recovery.
-
Basic installation (default settings):
-
Start the Service
- Open the services control panel (use Windows-R and then type
services.msc) - Find the service named "Tarasa Gateway" and start it
- Open the services control panel (use Windows-R and then type
-
Run the Application
Double-click
TarasaGateway.Client.exeto run the gateway client. The application will run in the foreground and you can close it by closing the console window.Using Command-Line Parameters:
To use custom configuration or log paths, open a command prompt in the gateway folder and run:
TarasaGateway.Client.exe --config my-settings.json --log mylogs -
Verify Installation
If successful, a new
logsfolder will appear in the gateway installation folder (C:\Program Files\TarasaGateway\logs) (in the same folder as the executable), or in the custom location if you specified the--logparameter. Inside, there should be a txt file with an entry like:2024-06-18 14:34:39.217 +02:00 [INF] Registered with serverThis confirms that the gateway has successfully connected to the Tarasa application.
Troubleshooting
- Service won't start: Check the logs folder for error messages. Ensure the client-settings.json file is valid JSON and contains the correct ServerUrl and ApiKey.
- Application won't run: Check the logs folder for error messages. Ensure the client-settings.json file is valid JSON and contains the correct ServerUrl and ApiKey.
- Can't connect to server: Verify that the ServerUrl in client-settings.json is correct and that the server is accessible from the machine running the gateway.
- Flexpoint proxying not working: Verify that the Flexpoint Integrate server is running and accessible at the URL specified in the IntegrateUrl setting. Check the gateway logs for connection errors to Flexpoint.
- PDF printing not working: Verify that Ghostscript is installed correctly and either in Program Files or added to the PATH environment variable.
- Word to PDF conversion failing: Ensure Microsoft Word is installed and can be launched. Check that the gateway application has appropriate permissions to interact with Word COM objects.
- WebRTC connection issues: Verify that firewall rules are correctly configured and that no third-party security software is blocking the connection.