DSLstats

After downloading the appropriate package for your system you need to extract the files from the downloaded archive. Windows and Raspberry Pi versions are in .zip format and you can extract these with Winzip or something similar. Linux versions are in .tar.gz format, and these can be extracted by any of the normal methods.

The extracted files will be in a folder with a name like dslstats32W-3.0 or dslstats64L-3.0. Copy this folder with all its contained files to a suitable place in your system. Please note that this must be a place where you have full read/write access (as an ordinary user, not an administrator).  The Windows version should not be installed in Program Files or Program Files(x86), or in the top level of C:\. The best location is under C:\Users\YourName, or in a non-system partition (e.g. D:\) if your system has this.

Inside the folder, you'll see an executable called dslstats (for Linux and Raspberry Pi) or dslstats.exe (for Windows). Double-click this executable to run the program. Depending on your system, you can create a desktop shortcut to the executable, or add a menu entry for it, to make it more readily available for regular use. DSLstats must be run as an ordinary user, not an administrator.

If the host system is one of the Linux versions, including the Raspberry Pi, the main executable (dslstats) must have its executable permission bit set. If the downloaded archive was extracted using Windows, the executable bit will be lost. In this case it must be restored after copying the file to its destination. This can be done from the command line ("chmod +x dslstats") or by right-clicking on the file and selecting Properties --> Permissions from the context menu.

Note that there is no permanent installation as such, and the Windows version doesn't write anything to the Registry. To remove the program from your system, all you need to do is delete the installation folder with all its files, and remove any shortcuts or menu entries which you created.

Using command line parameters

If you start the program from a command line terminal, or from a script or batch file, you can append parameters to the executable command to modify how the program starts up. Three parameters are recognised:

• "minimised" (or "minimized") starts the program in a minimised state
• "maximised" (or "maximized") starts the program in full-screen mode
  
• "startrecording" has the effect of pressing the green button after the program has loaded

Examples:

• dslstats.exe minimised - starts dslstats.exe in a minimised state
• dslstats minimised startrecording - starts dslstats in a minimised state and starts a recording session

Files included in the download package

dslstats (Linux / Raspberry Pi) or dslstats.exe (Windows) - the program executable
routers.dat - the main file of default configuration details for various modem/routers
specialrouters.dat - the file of default configuration details for modem/routers requiring a "Special login" setup
routertraffic.csv - traffic monitoring configuration details for some modem/routers
*.html - templates for the webserver pages
combined.template - template for the combined webserver page
libeay32.dll, ssleay32.dll (Windows only) - support DLLs for sending SSL email alerts
dslstatssampling.exe (Windows only) - support for HG612-Modem-Stats co-operation
CHANGELOG - the history of DSLstats releases
LICENCE - the release licence for the program (GPLv2)
README - brief "getting started" details

Files created and saved by the program

webserver - folder containing all the webserver images and web pages (in the snapshots directory)
dslstats.ini - all the configuration settings and other data
traffic.ini - the accumulated traffic data (updated every 10 minutes while recording is in process)
traffic.txt - the daily traffic
errors1.dat - the accumulated average error rates
es_data.txt - the accumulated data for errored seconds per hour