YAMon v4 Manual Install Steps

What's new in YAMon v4? (besides everything!!)

You can now help to improve YAMon via GitHub

The steps below described how to selectively install and/or update your router using the files in manual install (4.0.7).zip rather than running install.sh in the latest installer script (v4.0.7). [Pro tip... running install.sh will be simpler!]

These instructions presume that you have already replaced your stock firmware with a current version of DD-WRT, Turris, OpenWrt / LEDE, GNU/Linux, Asuswrt-Merlin, Tomato, etc. and have mounted a USB drive (preferably with ext4 file system) to /opt/. You can choose another mount point (e.g., /mnt/) but the instructions below presume /opt/.

Old (aka out-of-date) firmware versions may encounter problems (e.g., missing features upon which YAMon depends).

Latest versions:

  • Bash scripts (on the router): v4.0.7, and
  • HTML files (for the reports): v4.0 (internal to `yamon4.0.html`: v4.0.1).

To see which files you currently have installed on your router, check the reports:

Past Versions

If you want to revert to a previous version, select it here:

The following files have been tweaked/updated in the past 7 days - either run install.sh on your router or click to download the files individually:

Manual Steps:

Before going any further ...
Remember that I said properly configured and current firmware? A number of firmware settings are known to prevent YAMon from collecting accurate traffic data - the most common recent culprit has been the Shortcut Forwarding Engine (SFE) option which was added in DD-WRT build 33006+ (and is enabled by default). Other known offenders include `enhanced privacy` tools (like PrivOxy) and Universal Plug and Play (UPnP) settings - see PrivOxy & UPnP. Apparently `Cut Through Forwarding` is similar to SFE so it too will be problematic but I don't have a lot of details on that yet... stay tuned!. These options *must* be disabled if you want to get accurate results from YAMon!

If you are updating from a previous version of YAMon (rather than a fresh install), back up everything before proceeding! This includes any customizations you've made to devices in the reports - see Exporting device customizations.

  1. Download and expand the manual install (4.0.7).zip archive onto your computer's harddrive
  2. On your router, create a directory named YAMon4 in /opt/
  3. Using WinSCP or equivalent, copy the following files into /opt/YAMon4/: alias.sh, block.sh, calculate-daily-totals.sh, changes.log, check-network.sh, clear-iptables.sh, compare.sh, copy-log.sh, default_config.file, end-of-day.sh, end-of-hour.sh, getACRules.sh, in-unlimited.sh, new-billing-interval.sh, new-day.sh, new-hour.sh, pause.sh, purge.sh, run-fixes.sh, setPaths.sh, setup4.0.7.sh, start.sh, update-live-data.sh, update-reports.sh, up-rev-users-js.sh, validate.sh
    all of these files are included in the zip file but you can also click to download them individually
  4. Create a directory named includes in /opt/YAMon4/ and copy the following files into /opt/YAMon4/includes/: dailytotals.sh, fixes.sh, prompts.sh, setupIPChains.sh, shared.sh, start-stop.sh, traffic.sh, version.sh
  5. Create a directory named strings in /opt/YAMon4/ and copy title.inc into /opt/YAMon4/strings/
  6. Then add a directory named en in /opt/YAMon4/strings/ and copy strings.sh into /opt/YAMon4/strings/en/
  7. Create a directory named www in /opt/YAMon4/ and copy yamon4.0.html into /opt/YAMon4/www/
  8. Create a directory named css in /opt/YAMon4/www/ and copy custom.css into /opt/YAMon4/www/css/
  9. Create two more directories named js and images in /opt/YAMon4/www/
  10. Give alias.sh execute permissions - e.g. chmod 700 /opt/YAMon4/ or better yet, use WinSCP
  11. Run setup4.0.7.sh - e.g., /opt/YAMon4/setup4.0.7.sh
  12. Answer the prompts in the Setup script and finally launch YAMon!

To view your reports,

  • go to http://192.168.1.1/user/

    This may change slightly depending on your router IP address and/or your firmware... e.g., for Turris, the path typically is http://192.168.1.1/yamon/.

    It will take several minutes for your data to appear in the reports (that is dictated by your selections during the setup script).

Sign-up to get automatic notifications when there are updates to YAMon.

If you are having problems, please see the Common Problems page or send a question to questions@usage-monitoring.com.