Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

TurnKey GNU/Linux Configuration Console

Overview

The objective of the Configuration Console (AKA confconsole) is to provide the user with basic network configuration information and the ability to perform basic tasks, so as not to force the user to the command line.

It is licensed under GPLv3. We aim to keep this documentation up to date, but the Confconsole documentation source should always be up to date.

Main screen and basic functionality

The main screen of Confconsole provides the following information:

  • The currently bound IP address
  • The listening services the user may connect to over the network

./docs/images/00_confconsole_core_main.png

As of v2.x (default in v16.x TurnKey appliances), Configuration Console will be invoked automatically on first log in. It will also automatically start on firstboot; but without the "Advanced Menu" available (log in is required to access "Advanced").

The Configuration Console (confconsole) may be executed manually as well:

confconsole

Advanced

Additional Confconsole functionality is provided by way of a "Plugin" system. To navigate to the plugins, please enter the "Advanced" menu.

The advanced menu:

./docs/images/01_confconsole_core_advanced.png

The Advanced menu provides the below functionality in all appliances (some items have additional docs available via clickable headings). Note that some appliances may include additional (or modified) plugins.

  • Networking:
    • Setting a static IP address
    • Requesting DHCP
  • Let's Encrypt:
    • Enable/disable auto SSL cert update
    • Get SSL certificate from Let's Encrypt
  • Mail relaying:
    • configure and enable remote SMTP email relay
  • Proxy settings:
    • configure apt proxy
  • Region config:
    • Keyboard layout
    • Locales and language
    • Tzdata (timezone)
  • System settings:
    • install security updates
    • update hostname
  • Install the system to the hard disk (only when running live)
  • Reboot the appliance
  • Shut down the appliance
  • Quit (return to commandline)

Installation

Confconsole is installed by default in all TurnKey Linux Appliances so no installation should be required for TurnKey users.

For users of TurnKey Linux v15.x, bugs related to Let's Encrypt require you to manually update - please carefully follow the v1.1.2 Release notes.

For v16.x (Confconsole v2.0.x) users, the Let's Encrypt bug has been resolved and it should "just work". However, if you wish to ensure that you are running the latest, please see below for how to upgrade to the latest version.

As of v2.x, Confconsole should be compatible with vanilla Debian Buster (and possibly vanilla Ubuntu of a similar age version too). It does have some specific TurnKey dependencies, but now uses default Debian python3-dialog.

Upgrade Confconsole

If you are running TurnKey v15.x - with Confconsole v1.1.x - these instructions do not apply. v15.x users need to carefully follow the v1.1.2 Release notes. If you have problems or questions, please post on our support forums (requires free website user account).

Confconsole v2.0.x is installed by default in TurnKey Linux v16.0+. However, to ensure that you are running the latest version, you can upgrade via apt:

apt-get update
apt-get install confconsole

Plugins

The plugins system allows support for additional functionality via simply dropping a(n appropriately coded) python3 plugin file within the Confconsole file hierarchy. We aim to include more new functionality via this in coming releases.

Developers may be interested in reading further about the Plugin system.