Installation

First download the following files into the same folder/directory,

1. accdb-server.exe = Windows x64 standalone executable
2. html\index.html = a hosting file, with sample and server information (with 'html' folder)
3. settings.json = defines the host name, IP port, database file to be used and shutdown password
4. test.accdb = a test access database

or download the preconfigure archive,

1. accdb-server-preconfigured.zip = contains accdb-server, settings.json, test.accdb, and html/index.html
2. extract into a separate directory
3. open a command prompt and start the accdb-server
4. your server will be access from http://localhost:3000

Start the standalone executable

> accdb-server

The response should be similar to,

> localhost server running on port 3000 for test.accdb

Now, open your browser to

URL: http://localhost:3000/about

List all routes

To list all routes available, use

http://localhost:3000/

Settings.JSON

Edit the settingsjson to specify the accdb database file

{
    "domain": "localhost",
    "host": "localhost",
    "port": 3000,
    "database": "test.accdb",
    "password": "5f4dcc3b5aa765d61d8327deb882cf99",
    "format": "json|base64|pk",
    "publicKey": "-----BEGIN PUBLIC KEY----------END PUBLIC KEY-----\n"
}

IMPORTANT! Whenever SETTINGS.JSON file is changed, the ACCDB-SERVER MUST BE RESTARTED in order for the new settings to take effect.

FORMAT Setting

If the FORMAT setting is NOT PRESENT, the default return format is JSON.

"format": "json"    => returns JSON
"format": "base64"  => returns Base64 encoded
"format": "pk"      => returns encrypted string using the "publicKey" value

*The result is NOT jsonized for 'base64' nor 'pk' formatting.

Generate the Public-Private Keys

Before using the public-private encryption, you must generate and supply your keys. Encryption is performed using the PUBLIC key and decryption is performed using the PRIVATE key.

To generate your public-private keys,

http://localhost:3000/generate_seckeys

Then edit your SETTINGS.JSON with the public key and save your private key separately.

PASSWORD Setting

The password is an MD5 hash. Use the MD5 route to determine the MD5 hash value,

http://localhost:3000/md5/password

where password is yout plain text password, then copy and paste (without double quotes) to the settings.json

Release Schedule

Whenever the code base is updated, a new standalone executable is created and replaced with the existing executable.

Version     Date        Changes
1.1.0       TBD         A future release: Manage through the Windows Services Manager
1.0.12      9/27/2019   Move API list to new route, fixed POST requests and req.body undefined error, added folder/file html\index.html hosting file on root route
1.0.11      9/26/2019   Added route for viewing active SETTINGS.JSON and logging to the Windows Event Viewer
1.0.10      9/26/2019   Added public-private key encryption to the output JSON object.
1.0.9       9/26/2019   Added return format of JSON or BASE64, based on SETTINGS.JSON paramater "format"
1.0.8       9/19/2019   Added route listing to base|root route of http://localhost:5151/
1.0.7       9/19/2019   Added password protection for SHUTDOWN route, new MD5 route added
1.0.6       9/19/2019   Added shutdown route, for shutting down the server
1.0.5       9/14/2019   Change ABOUT route to read PACKAGE.JSON
1.0.4       9/10/2019   Add new route EXECUTE, duplicate of the SQL route
1.0.3       9/9/2019    Fix for building a stand alone windows executable
1.0.2       9/8/2019    Fix post parameter reference
1.0.1       9/8/2019    Added new route ABOUT displaying module information
1.0.0       9/7/2019    Initial commit

EOL or End-of-Life

When a piece of software is useful, there should never be an EOL doctrine. The intention for accdb-server is to achieve immoratlity ;).

At some point of time in the future, this project may appear to be dead and abandon. The opposite will be true!

When this project reaches that stage, this project has matured to a level where maintenance is minimal (mostly updating to latest version of Node).

Patrick Ingle
Developer
September 10, 2019