Confconsole - TurnKey Linux Configuration Console

We aim to keep this documentation up to date, but the Confconsole documentation source (on GitHub) should always be up to date.

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
Confconsole main screen

The Configuration Console will be invoked automatically on a new vt (by its init script) unless the boot paramater 'noconfconsole' is present on /proc/cmdline.

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

confconsole

Advanced

For version v1.0.0 (default in TurnKey v14.2+), Confconsole has been significantly refactored and includes some long overdue additional functionality. The additional functionality is provided by way of a "Plugin system. To navigate to the new plugins, please enter the "advanced" menu.

The advanced menu:

Confconsole Advanced menu

As of v1.0.0 the Advanced menu provides the following functionality (some items have additional docs avaialble via clickable headings):

  • Networking:
    • Setting a static IP address (don't do this on cloud servers!!)
    • 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 v14.0 & v14.1, please see below for how to upgrade to the latest version.

In theory it should be compatible with vanilla Debian Jessie (and possibly vanilla Ubuntu of a similar age version too). However, currently it depends on a legacy version of python-dialog (which is packaged in the TurnKey apt repo).

At some point we hope to rewrite it to rely on the default python-dialog.

Upgrade to v1.0.0+

Confconsole v1.0.0 is installed by default in TurnKey Linux v14.2+. However it is also possible to upgrade to the current version on other v14.x releases.

To upgrade your instance of Confsole on v14.0 & v14.1, including support for Let's Encrypt, please do the following:

cat > /etc/apt/sources.list.d/backports.list <<EOF
# Jessie Backports
deb http://ftp.debian.org/debian jessie-backports main
EOF

service confconsole stop

apt-get update
apt-get install confconsole python-bottle authbind
apt-get install -t jessie-backports dehydrated

confconsole

Plugins

The plugins system allows support for additional functionality via simply dropping a(n appropriately coded) python 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.

Comments

Frank Kincell's picture

Installation has 2 L's in it. The typo is in the title of the section and in the table of contents.
Jeremy Davis's picture

Thanks tons for that! :) I should probably get in the habit of spell checking my content really...

Anyway I just fixed it manually here, but I also fixed it in the source, so it doesn't get lost next time we update the docs (the html here is generated from the source).

Andreyyyyyy's picture

Hello. Jessie-backports is deprecated. Stretch-backports should be used instead.
Jeremy Davis's picture

Thanks for your comment, but those install instructions are explicitly for installing v1.x confconsole on v14.0/v14.1 TurnKey appliances (v14.x was based on Debian Jessie). As noted as of v14.2, all TurnKey appliances should already include Confconsole v1.x by default.

As you note though, jessie-backports no longer exists, so we should remove that section altogether.

It's also worth noting that there is currently a bug which affects our Let's Encrypt implementation. Hopefully that will be resolved shortly...

Andreyyyyyy's picture

Here is the solution to that unfortunate bug: https://github.com/turnkeylinux/tracker/issues/1359 It helped me with my TurnKey MediaWiki server recently. I was looking for it here at first. So this link may ease someones life.
Jeremy Davis's picture

There is now a proper fix for that issue and other closely related ones, with the release of [Confconsole v1.1.1](https://github.com/turnkeylinux/confconsole/releases/tag/v1.1.1). It's not yet available from our repos (will be soon though) and still requires some specific steps to use on a v15.x server (although better than instructions published previously). Please see the [release notes](https://github.com/turnkeylinux/confconsole/releases/tag/v1.1.1) for full step by step setup and further info.

If you have any further feedback (questions or report your experience), please either start new thread in the forums or post in one of the relevant forum threads, e.g. here, here or here.