Updates

The updates page is used to display and install available product updates, in addition to listing currently installed updates.

Checking for available updates

To check for available updates, click the Refresh update list button. Available updates will be displayed in the Available updates region.

Installing an update

Locate an available update by checking for available updates in the Available updates region. Download the update from SmoothWall Ltd's web site by clicking the update's Download button. Save the update file to the browser's local file system when prompted.

To install the update, click the Browse button in the Install new update region and locate the downloaded update file using the browser's "File upload" dialog. Select the file and click the dialog's Open button. Ensure that Upload update file text-field has been correctly populated with the file and its path, and click the Upload button.

Once this process has been completed, the update will be displayed in the Installed updates region. Some updates may require the system to be rebooted following installation, please follow the update's installation instructions carefully to ensure the update is installed and activated successfully.

Viewing currently installed updates

To view a list of currently installed updates, click the Refresh button and examine the Installed updates region. Each update that has been applied to the system is listed here, including a short summary of its purpose.

Clearing the download cache

Clearing the download cache frees up disk space that was used for downloading update files. To clear the cache, click the Clear download cache button.

Modules

The modules page is used to upload, view, check, install and remove system modules.

Uploading a module

To upload a module, click the Browse button in the Install new module region and locate the module file using the browser's "File upload" dialog. Select the file and click the dialog's Open button. Ensure that Upload module file text-field has been correctly populated with the file and its path, and click the Upload button. Viewing currently installed modules

To view a list of currently installed modules, click the Refresh module list button and examine the Installed modules region. Each module that has been installed on the system is listed here, including a short summary of its purpose.

Checking for available modules

To check for available modules, click the Refresh module list button. Available modules will be displayed in the Available modules region.

Installing a module

Locate an available module by checking for available modules in the Available modules region.

To install an available module, simply click the Install button. Some modules may require the system to be rebooted following installation, please follow the module's installation instructions carefully to ensure the module is installed and activated successfully.

Removing a module

Locate the module to be removed in the Installed modules region and click the module's Remove button.

Licences

The licences page is used to display and update licence information for the licensable components of the system.

Viewing current licences

Certain components that comprise a SmoothWall system may be subject to resource licensing restrictions. Each licensable component of the system is displayed on this page, in alphabetical order, including a description of the licensed resource and the total number of available licences.

Where appropriate, certain components may display current licence usage information. To refresh current usage information, click the Refresh licence list button.

Installing additional licences

Additional licences can be purchased directly from SmoothWall Ltd or an approved SmoothWall Partner. Licence installation and activation is an automated process, initiated via a secure request to SmoothWall Ltd licensing servers.

To install additional licences once purchased, click the Refresh licence list button. This will cause the available licence information to be updated via the Internet, and any new licences will be successfully installed.

Backup

The backup page is used to create and restore archives of system configuration information. Archives can be exported to a floppy disk and used during the installation process to restore complete system configuration. This process can also be useful for creating clones of existing systems.

Terminology

The following terminology is used on the Maintenance | backup configuration page:

  • Backup archive - A named collection of configuration details belonging to one or more system components or standard modules. Archives can be downloaded for secure storage, restored for configuration amendment, deleted if no longer required or uploaded from a browser's local storage medium.
  • System components - A fixed list of core system components whose configuration can be backed-up.
  • Standard modules - A dynamic list of installed system modules whose configuration can be backed-up
Choosing configuration settings to backup

Select the configuration elements that should be backed-up using the named tick-box controls located in the System components and Standard modules regions. Each selected tick-box ensures that the named component's configuration details are backup-up in the next archive created. Click the Save button to record the selected backup options for future archiving purposes.

Creating a backup archive

To create a backup archive, choose the configuration settings to backup as explained above. Click the Backup button to create the archive. The backup will be named automatically and displayed in the Archives region.

Downloading a backup archive

To download a backup archive, first locate it in the list of archives displayed in the Archives region. Select the archive using its adjacent Mark tick-box control. Click the Download button and save the archive to disk using the browser's "Save as" dialog controls.

Restoring a backup archive

To restore a backup archive, first locate it in the list of archives displayed in the Archives region. Select the archive using its adjacent Mark tick-box control. Click the Restore button to reinstate all configuration that was backed-up in the archive.

Deleting a backup archive

To delete one or more backup archives, first locate them in the list of archives displayed in the Archives region. Select each archive using its adjacent Mark tick-box control and click the Delete button.

Uploading a backup archive

To upload a backup archive, click the Browse button below the Archives region. Locate the archive file using the browser's "File upload" dialog and click the dialog's Open button. Ensure that Location text-field has been correctly populated with the file and its path, and enter a descriptive name for the archive in the Archive name text-field. Click the Upload button to import the backup archive to the archive list.

Once this process has been completed, the backup archive will be displayed in the list of archives in the Archives region.

Automatically creating backup archives

To automatically schedule creation of backup archives, please refer to the Maintenance | automation configuration page.

Automation

The automation page is used to automatically discover new system updates, modules and licences. It is also possible to schedule automatic downloads of system updates and create local and remote backup archives.

Creating an automation schedule

Maintenance actions can be automatically executed at a scheduled weekly time. To configure the schedule, select a day and hour using the Day and Hour drop-down menus. Click the Save button to save the schedule.

Automating maintenance tasks

Firstly, create an automation schedule as described above. The following list of standard maintenance tasks can be automated:

  • Check for new updates - Automatically check for new system updates on a scheduled basis.
  • Download updates - Automatically download available updates on a scheduled basis.
  • Check for new modules - Automatically check for new modules on a scheduled basis.
  • Check for licensing upgrades - Automatically check for licence upgrades on a scheduled basis.
  • Take automatic backup - Automatically create backup archives on a scheduled basis (according to the settings on the Maintenance | backup configuration page).

To automate a maintenance action, click its adjacent tick-box as displayed in the Actions region. Click the Save button to save the configuration changes.

Note - Additional maintenance tasks may be added to this list by other system modules.

Note - Checks for new updates, modules and licence upgrades will be automatically performed when an external connection is made available.

Automatic remote archiving

The automation page also allows automatic remote archiving to be configured. As standard, this allows the most recent automated backup archive to be securely copied to a remote system. If the SmoothMonitor module is installed, various log files can also be archived to a remote location using the same mechanism.

The automatic remote archiving system uses "SSHKeys" to allow it to securely copy files to a remote SSH server without the need for passwords. The use of "SSHkeys" requires the SmoothWall system to generate a Key Pair which it will use to encrypt all file transfers sent to the SSH server. However, the SSH server must be configured to accept connections from the SmoothWall system in this manner - it requires the public half of the key pair to be installed. To export the public key to the local file system, click the Export Public Backup Key button. The public key must then be installed on the remote SSH server - for details on how to do this, please consult the administrator's guide of the SSH server in use.

Next, enter appropriate values into the configuration controls contained in the Remote archive region:

  • Username - Used to specify the username of the account on the SSH server that will be used. For additional security it is recommended that this user has no additional privileges and is only allowed write access to the specified Remote Path.
  • Remote Path - Used to set the path where archives will be placed on the remote SSH server.
  • Server - Used to set the IP address of the SSH server.
  • Port Number - Used to set the port number used to access the SSH server (normally port 22).
  • Transfer Speed Limit - Used to determine the maximum transfer speed when automatic backup occurs. This control is useful for preventing the automatic remote archiving system adversely affecting the performance of other network traffic.

Once the settings for the remote system have been entered, the types of archives that should be remotely backed-up can be set using the Automatic Remote Backup table. To select a particular type of backup, select the Backup tick-box adjacent to the archive's description and Click the Save button to

Diagnostics

The diagnostics page is used to create diagnostic data files for support purposes.

Generating a diagnostics file

Diagnostic log files are typically requested by SmoothWall support agents for resolving configuration problems and issues.

To generate a diagnostics file, select the relevant configuration details from the System and Modules regions, and click the Generate button.

The diagnostics file is generated and output as text to the browser. To save the output as a text file, use the "Save" command from the browser's File menu.

Note - no confidential information is included in the generated file.

Shutdown Control

The shutdown page is used to shutdown or reboot the system. The system will beep once to indicate that the power can be disconnected. Rebooting is sometimes required after applying system updates, but is not needed as part of a general maintenance cycle.

Setting an immediate shutdown or reboot

To immediately shutdown the system, select the Immediately radio-button and click the Shutdown button.

To immediately reboot system, select the Immediately radio-button and click the Reboot button.

Setting a delayed shutdown or reboot

To create a delayed system shutdown, select the Delay action for radio-button and choose a time period between 5 minutes and 1 hour from the adjacent drop-down menu. Click the Shutdown button.

To create a delayed system reboot, select the Delay action for radio-button and choose a time period between 5 minutes and 1 hour from the adjacent drop-down menu. Click the Reboot button.

Setting a scheduled shutdown or reboot

To create a scheduled system shutdown, select the At the following time radio-button and choose a time using the adjacent Hour and Minute drop-down menus. Click the Shutdown button.

To create a scheduled system reboot, select the At the following time radio-button and choose a time using the adjacent Hour and Minute drop-down menus. Click the Reboot button.

Cancelling a delayed or scheduled shutdown / reboot

To cancel a delayed or scheduled shutdown / reboot, click the Cancel button.

Shutting the system down from the console

Alternatively, the system can be shutdown directly from the console. Press Ctrl + Alt + Del to start the shutdown sequence. The machine will not reboot.

Alcatel SpeedTouch USB ADSL Firmware Upload

The firmware upload page is used to upload the mgmt.o file to the system, without which the Alcatel SpeedTouch USB ADSL will not work.

Uploading the Alcatel firmware

To install the Alcatel firmware, click the Browse button in the Alcatel ADSL driver upload region and locate the mgmt.o file using the browser's "File upload" dialog. Select the file and click the dialog's Open button. Ensure that Upload file text-field has been correctly populated with the file and its path, and click the Upload button.

Once this process has been completed, the system must be rebooted before the new firmware is activated

Note - The 330 version of this modem also requires this firmware update to function correctly.