readme.txt 2022-05-20
To be a beta tester of this hobby project includes that you must be active,
and report your experience to me or the community, so that we together can
find bugs and introduce new functions.

The 5.5+ beta has a lot more functions than the official 5.0 beta, 
but is also more tested and with less known bugs.


Install instruction for Kamoj Add-on beta
=========================================
1). Download the add-on FAQ.txt, readme.txt and release_notes.txt files.

2). Read the documentation, at least the readme.txt is very important.

3). Backup your current configuration, SSH keys, wireguard/openvpn client configs, etc
    The add-on will not touch this, but better safe than sorry
    See end of this file for a basic example on how to make a backup.

4). Uninstall previous version of kamoj-addon (if any).
    (Your settings will not be lost).
    Code from the routers telnet/ssh prompt:
    /bin/opkg remove -V1 --force-remove kamoj-addon
    reboot
    =====================================================================================
    ##### reboot MUST be performed #####
    WARNING: If you don't reboot at this stage your router firmware may become corrupt!!!
    =====================================================================================

5). Install latest Voxel firmware - if not already installed.
    Note that this will erase current kamoj add-on, SSH keys, wireguard/openvpn client configs, Aegis etc.

    If you have a backup of the router configuration, and want to restore it,
    you should restore it now - before installing the add-on!

6). Login to the router command line ("shell")
    (Instructions #1-4 at https://www.snbforums.com/threads/kamoj-add-on-v5-for-netgear-r7800-x4s-and-r9000-x10.60590/)
    Change directory to where you downloaded the install ipk file,
    e.g. if you are using one and only one USB device:
    cd /mnt/sda1  # R7800
    cd /mnt/sdb1  # R8900/R9000
    (To see all mounted devices, run command from telnet prompt: df 
    and look to the most right column for /tmp/mnt/sd* )
    If you don't use any USB, just do:
    cd /

7). Transfer the .ipk installation file to the router (via wget/curl/scp/ftp/usb-device...)
    (Instructions #5 at https://www.snbforums.com/threads/kamoj-add-on-v5-for-netgear-r7800-x4s-and-r9000-x10.60590/)
    Note that there are different versions of the add-on for R7800 and R8900/R9000.
    For the R7800 the file name ends with _ipq806x.ipk
    For the R8900/R9000 the file name ends with _r9000.ipk

    The file with full path is found in the list.txt file available to the beta-testers.
    Easiest way is to directly download the installation file to the router using wget/curl.
    
    Example on how to download the .ipk file to the router root directory (survives a reboot):
    cd /
    curl -k -R -O https://voxel-firmware.com/Kamoj/Downloads/kamoj-addon_211229-192611-5.5b1_ipq806x.ipk
   
    To make sure the file is downloaded correctly you can also download the md5-file to test the .ipk file:
    curl -k -R -O https://voxel-firmware.com/Kamoj/Downloads/kamoj-addon_211229-192611-5.5b1.md5
    md5sum -c /kamoj-addon_211229-192611-5.5b1.md5
    (If you only download one of the install files, the other one will fail the m5d test).

8). Install the new add-on
    (Instructions #6 at https://www.snbforums.com/threads/kamoj-add-on-v5-for-netgear-r7800-x4s-and-r9000-x10.60590/)
    "name_of_your_downloaded_ipk" is to be replaced by filename of the .ipk you are to install.
    Note that there are different filenames for R7800 and R9000/R8900.

    /bin/opkg install -V1 --force-overwrite /"name_of_your_downloaded_ipk"

9). Reboot
    reboot
    =====================================================================================
    ##### reboot MUST be performed #####
    WARNING: If you don't reboot at this stage your router firmware may become corrupt!!!
    =====================================================================================

10). Login to router at: http://www.routerlogin.net

11). Select the ADVANCED tab and verify that the 2 new menus are available:
    Kamoj Menu
    Hidden Menus
    
12). Update displayed add-on version:
     Select Kamoj Menu, and then Router Information
     Refresh page

INFORMATION:
- Read Frequently Asked Questions: FAQ.txt
  Please read this file before asking question about the add-on.
  You might get confused by all information, but as a beta tester you will learn a lot.

- Read Release Notes with changes: release_notes.txt

- You can share issues/wishes/questions in private message, as well as in the thread:
  https://www.snbforums.com/threads/kamoj-addon-5-5-beta-for-netgear-r7800-r8900-r9000-with-voxel-fw.76440/
  Watch this thread for add-on updates - or look at the Router Information page.

--------------------------------------------------------------------------------------

Wishing you a good experience of the add-on, and to hear more from you!

Stay safe!

/kamoj

Appendix 1:
# Example on how to to backup ssh keys and VPN configurations (to USB if inserted):
\ls -al /mnt/sda1/* >/dev/null 2>/dev/null && USB="/mnt/sda1" || USB="/"
\ls -al /mnt/sdb1/* >/dev/null 2>/dev/null && USB="/mnt/sdb1"
savedir="$USB"/BACKUPS
mkdir -p "$savedir"
TIMENOW=$(date +"%y%m%d-%H%M%S")
BACKUPFILE="ROUTER_BACKUP-${TIMENOW}.tar.gz"
BUP="\
root/.ssh/
etc/dropbear/
etc/openvpn/config/client/
etc/wireguard/config/client/
"
tar -C / -czf /tmp/"${BACKUPFILE}" ${BUP}
\cp /tmp/"${BACKUPFILE}" "$savedir"
sync

# To manually restore the backup to the router (from USB mounted as sda1) example:
tar -C / --overwrite -xmvf /mnt/sda1/ROUTER_BACKUP-211229-111213.tar.gz root etc"

Appendix 2:
I strongly recommend you to use Aegis in the router(s).
The add-on has support for the Aegis with a link to it when installed.
https://www.snbforums.com/threads/aegis-1-7-x.70761/

Install by e.g. these commands from the router prompt:
wget -qO- https://github.com/bolemo/aegis/raw/stable/aegis-install.sh --no-check-certificate | sh -s -- '' 1
aegis log -enable
aegis web -install
aegis refresh
aegis up