Skip to content
This repository has been archived by the owner on Sep 13, 2020. It is now read-only.

Latest commit

 

History

History
106 lines (78 loc) · 3.49 KB

README.md

File metadata and controls

106 lines (78 loc) · 3.49 KB
Raw

pkg-admin-tools

Package admin utility to install or rollback several WLAN Pi utilities. The current utilities supported are:

  • bakebit
  • hotspot
  • profiler
  • wconsole
  • wiperf

Install

The pkg-admin-tools utility needs to be installed on to your WLAN Pi and run via an SSH session. If you do not have the utility on your WLAN Pi, then install it using the following commands, logged in as the wlanpi user:

cd ~
sudo git clone https://github.com/WLAN-Pi/pkg-admin-tools.git

(Note: the pkg_admin utility should only be run with the WLAN Pi in classic mode)

Once this operation has been completed, the utility can be run as follows (this example shows the help dialog):

sudo pkg_admin -h

Package Install

Note: the pkg_admin utility should only be run with the WLAN Pi in classic mode

The sudo pkg_admin -i command is used to install a package or update an existing package. When the command is run, the existing package files are moved to a backup directory (~/.recycle) and then the package files are pulled from GitHub and placed in the correct location on the WLAN Pi. Following the pull from GitHub, a few post install actions are performed to restore a number of config files from the original package install. The installer pulls the latest set of files from the GutHub master repo of the package, unless the '-d' option is also added, which will pull the latest dev branch.

If the WLAN Pi cannot access GitHub (e.g. no Internet connection), then the install will not proceed.

If you would like to install a specific version or branch from GitHub, use the sudo pkg_admin -b <branch_or_release_name>. For example, to install release v0.06 of the wconsole package, run the following command:

sudo pkg_admin -i wconsole -b v0.06

Package Rollback

If there are issues with the install, use the following command to roll-back to the original files:

sudo pkg_admin -i wconsole -r

(If there are issues with the roll-back, it is possible to manually copy the original files from the "~/.recycle/<package_name>" directory.)

Utility Update

The pkg-admin-tools itself may be updated from time to time to fix bugs & add features. To update to the latest version, execute the following command:

sudo pkg_admin -u

When the utility is next run, the new version will be run.

Usage

usage: pkg_admin [-h] [-i module] [-r module] [-d] [-b branch_name] [-u] [-e]
                 [-v]

Package install utility for the WLAN Pi.

optional arguments:
  -h, --help      show this help message and exit
  -i module       install module
  -r module       rollback module
  -d              install dev branch (used with -i option)
  -b branch_name  install branch specific branch/release (used with -i option)
  -u              update this utility with latest version
  -e              empty recycle bin folder
  -v              show program's version number and exit

Available package options:

  • bakebit
  • hotspot
  • profiler
  • wconsole
  • wiperf
  • fpms
  • pkg_admin
  • misc

Example 1: install version 0.05 of hotspot mode:

sudo pkg_admin -i hotspot -b v0.05

Example 2: install the latest live repo files of profiler (use with great care, as this may not be a fully tested/released set of files)

sudo pkg_admin -i profiler

Example 3: install the latest dev files for the wireless console (bleeding edge...take care!)

sudo pkg_admin -d wconsole

Example 4: Update the package admin tool itself (a good idea before downloading any new release):

sudo pkg_admin -u