Installing and running KnowAssist

KnowAssist runs as an HTTP server. When it is running, you access the user interface by visiting the IP that KnowAssist is listening to.

KnowAssist requires no installation, and does not require you to install any other software.

Before you start using KnowAssist, you will need to create a new database.

Creating a database

On Linux, from a terminal:

$ knowassist-0.1.0-1003-linux my_database

On Windows, from a command prompt:

knowassist-0.1.0-1003.exe my_database

On Mac, from a terminal:

$ knowassist-0.1.0-1003-mac my_database

You will be prompted to enter an admin password for the database, which you can use to gain access to the admin interface.

Running KnowAssist from a terminal or command prompt

Once you have created a database, you can run KnowAssist directly from a terminal (Linux or Mac) or the command prompt (Windows). When you run KnowAssist without any arguments, a printout will show with information about which arguments you can use. Below is an example of how one could start KnowAssist:

$ knowassist-0.1.0-1003-linux -a 127.0.0.1 -p 8000 -l logfile my_database

Read on if you would like to run KnowAssist as a daemon (Linux or Mac) or as a Windows Service.

Running KnowAssist as a Windows Service

On Windows, the -s flag can be used to run KnowAssist as a Windows Service.

To register KnowAssist as a Service, use the sc.exe utility. If for example, you have placed the KnowAssist executable in C:\Program Files\knowassist, you can use the command below.

sc.exe create "KnowAssist" binPath= "C:\Program Files\knowassist\knowassist-0.1.0-1003.exe -s -a 127.0.0.1 -p 8000 -l \"C:\Program Files\knowassist\logfile\" \"C:\Program Files\knowassist\knowassist.db\""

With the above, KnowAssist will serve requests from 127.0.0.1 on port 8000, using the specified logfile and database file.

Note that the database must already have been initialized by calling KnowAssist from a command prompt with the path to the database as the only argument.

If you want to change the settings of a KnowAssist Windows Service, run regedit.exe as administrator and go to HKLM\SYSTEM\CurrentControlSet\Services\KnowAssist, where "KnowAssist" is the name you assigned when creating it with sc.exe. Change the ImagePath variable as desired.

Running KnowAssist as a daemon

On Mac and Linux, the -d flag can be used to run KnowAssist as a daemon. When running as a daemon, the paths to the database and log files must be absolute.

Note that the database must already have been initialized by calling KnowAssist from a command prompt with the path to the database as the only argument.

Running KnowAssist behind a reverse proxy

KnowAssist is not designed to serve requests directly over the internet to the users. If you want to access your KnowAssist server over the internet, you should use a reverse proxy such as Apache or Nginx.

KnowAssist has been designed to be reverse proxy friendly. It works with a reverse proxy setup with minimal work - try it.