How To Access Square One's Command Line Interface (Shell)

In Brief (for experienced users)

From a computer on the local network, telnet to 192.168.1.1 (or whatever local IP address you have assigned to Square One) and log in as "admin", password "squareone" (or whatever you have changed the admin password to). At the [Square One]# prompt, enter "quit" to gain access to the full shell prompt (#).

Note that Windows's built-in telnet client is not compatible with Square One's telnet service. You must use a telnet client that is (or can be) configured to send ^M when you press the Enter key. Read below for options.

Introduction

In order to perform tasks such as creating a MySQL database or installing PHP software on top of Square One's Apache web service, Square One offers shell (command prompt) access to its Linux operating system through telnet. The shell built into Square One is ash, a lightweight version of the Bourne Shell (sh).

Please note that only users experienced with Linux should attempt shell access. Quad Micro Works is not responsible for any damage to its operating system or your files that may occur when you use the shell.

To access the shell, you will need a telnet client. The standard telnet client built into Windows cannot be used, because its key mapping is not compatible with Square One's telnet service. We recommend you use either HyperTerminal, which comes with Windows, or PuTTY, a free third-party telnet client.

Using HyperTerminal to telnet into Square One

These instructions assume you are using Windows XP or 2003 and that Square One's LAN IP address is 192.168.1.1.

  1. On the Start menu, click Run....
  2. In the Run dialog box, enter the following command (including the quote marks) and press Enter:
    1. "%ProgramFiles%\Windows NT\hypertrm.exe" /t 192.168.1.1
  3. This will launch HyperTerminal and connect to Square One.
  4. At the Square One login: prompt, enter "admin". At the Password: prompt, enter your administrator password (default is "squareone").
  5. Initially, you will be in a limited shell prompt that only offers a few diagnostic commands. To switch to the full shell prompt, at the [Square One]# prompt, enter "quit".

When you have finished using the shell prompt, enter "exit" to disconnect from the telnet service.

Using PuTTY to telnet into Square One

  1. Launch PuTTY. The PuTTY Configuration dialog box will open.
  2. In the Host Name box, enter 192.168.1.1 (or whatever local IP address you have assigned to Square One).
  3. Under Protocol, select Telnet.
  4. On the Category tree on the left side of the window, under Connections, click Telnet. Clear (uncheck) the check box labeled Return key sends Telnet New Line instead of ^M.
  5. On the Category tree, go back to Session, type "Square One" in the box under Saved Sessions, and click Save. Now click Open to initiate the telnet connection.
  6. At the Square One login: prompt, enter "admin". At the Password: prompt, enter your administrator password (default is "squareone").
  7. Initially, you will be in a limited shell prompt that only offers a few diagnostic commands. To switch to the full shell prompt, at the [Square One]# prompt, enter "quit".

When you have finished using the shell prompt, enter "exit" to disconnect from the telnet service. The next time you use PuTTY to telnet into Square One, you can just double-click the "Square One" saved session in the PuTTy Configuration dialog box.