Introduction

FileService

File Service

 

FileService is a utility application that can be used to remotely manage files in a Windows server-based folder via a RESTful Web Service API.

 

The service runs as a Windows Service and, by default, can be accessed at the following URL:

 

http://<server_name_or_ip>:8080/FileService

 

The service supports the following operations:

 

Ping

List all files

Check if a file exists

Download a text file

Create a file

Create a file (chunked)

Update a file

Delete a file

 

Synergy Licensing

 

FileService is a Windows service written in Synergy .NET and as such requires that Synergy/DE core components are installed and configured on the system, and requires the dedicated use of one Synergy/DE Windows runtime license (RUN10).

 

You should verify that these prerequisites are met BEFORE attempting to run the FileService installation.

 

Installation

 

The easiest way to install file service on a Windows system is to download the installer from the GitHub repository and then execute it on the desired system or systems system.

 

Because FileService runs as a Windows service, you must be logged into a user account that has administrative rights for the system in order to successfully run the installation.

 

The installer makes the following changes to the system:

 

1.Installs the FileService application code in C:\Program Files (x86)\Synergex\FileService

2.Creates a start menu folder containing shortcuts to the documentation and uninstall.

3.Registers a windows service named FileService and sets the service to start automatically when the system boots.

4.Starts the service.

 

Configuration

 

The service exposes the files in a single storage folder. By default that storage folder is C:\Users\Public\Documents\FileService.

 

You can change the location used by editing the configuration file C:\Program Files (x86)\Synergex\FileService\FileService.exe.config and specifying an alternate location via the StorageFolder setting.

 

The HTTP port that the server listens on can also be altered by changing the value of the HttpListenerPort setting.

 

<FileService.Properties.Settings>

    <setting name="StorageFolder" serializeAs="String">

        <value>C:\some\other\folder</value>

    </setting>

    <setting name="HttpListenerPort" serializeAs="String">

        <value>8080</value>

    </setting>

</FileService.Properties.Settings>

 

If you make any changes to this file then you must stop and restart the service.

 

Starting and Stopping the Service

 

The Windows service may be started and stopped in several ways:

 

1.From the Services tab in Task Manager.

2.From the Services control panel (services.msc).

3.From the command line

 

net stop FileService

 

net start FileService

 

License Agreement

 

Copyright (c) 2018, Synergex International, Inc.

All rights reserved.

 

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

 

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

 

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.