• Web Console usage:
  • When I pass some console command to Web Console, under which user account it executes on the web server?
  • It is possible to execute some command from Web Console interface under "root" user privileges?
  • Is it possible to have more than one user in Web Console?
  • It is possible to access through Web Console to another shell at another host?
• Web Console configuration/installation:
  • How can I change Web Console style (i.e. font color, size...)?
  • How can I configure Web Console encodings?
• Web Console development:
  • I would like participate in the Web Console development process, what should I do?
• I have got one of the following error/warning messages, what should I do?
  • MOD_PERL detected
  • Incorrect Web Console call
  • Login or password is not defined
  • Users DB is not loaded
  • Unable change directory to 'dirname'
  • Unable to make AJAX response
  • Web Console temp directory is not defined (unable to initialize 'NL::File::Lock')
  • Web Console temp directory is not exists
  • WC::File::save(): Unable to lock/open file 'filename' (file name/DATA is not specified)
  • Main Web Console config filename is not defined
  • WC::Config::load(): Unable to load/lock config file 'filename'
  • Web Console Users DB file name is not defined
  • Web Console configuration object not found, users DB not found, users DB checking error
  • Unable to check if configuration file is exists

Web Console usage

When I pass some console command to Web Console, under which user account it executes on the web server?

By default Web Console is running under the web server user account (or for some web server configurations — it is a specified user, who runs scripts). All commands, which you pass to Web Console, executes using that user account.

It is possible to execute some command from Web Console interface under "root" user privileges?

Yes, it is possible to execute commands from Web Console interface under "root" user privileges. To do that you can use "sudo" command. To run commands using "sudo" you need to configure '/etc/sudoers' file. You can read more information about it here.

For example, your configuration maybe looks as follows:

• At Web Console run "id" command (you will see current Web Console user account information):

  /var/www/web-console> id
  uid=33(www-data) gid=33(www-data) groups=33(www-data)

• Now you need allow that user to use "sudo". For example, we will allow that user to run any commands as "root" using "sudo" without password (but, we are highly recommending run Web Console with minimal permissions, depends on your Web Console usage requirements). To do that — add following line to the '/etc/sudoers' file:

  www-data   ALL=(ALL) NOPASSWD: ALL

  Where "www-data" is a Web Console user account.

Now you can run from Web Console any commands as "root" using "sudo" without password. For example:

/var/www/web-console> sudo id
uid=0(root) gid=0(root) groups=0(root)

You can also create new Web Console user using internal Web Console command "#user create" and add following "User startup JavaScript" to that user:

WC.Console.Exec.CMD_original = WC.Console.Exec.CMD;
WC.Console.Exec.CMD = function(in_CMD) {
   if (in_CMD && !in_CMD.match(/^(cls|clear)[ ]{0,}$/i) && !in_CMD.match(/^#/)) {
      in_CMD = 'sudo '+in_CMD;
   }
   WC.Console.Exec.CMD_original(in_CMD);
};

Is it possible to have more than one user in Web Console?

Yes, it is, but you need to understand distinguish between Web Console users and operation system users. By default Web Console is running under the web server user account (or for some web server configurations — it is a specified user, who runs scripts). All commands, which you pass to Web Console, executes using that user account.

You can add new users to Web Console using internal application command "#user add". But currently, all Web Console users have exactly the same privileges — it looks like all Web Console users map to one operation system user.

It is possible to access through Web Console to another shell at another host?

Through Web Console you can access to another shell at another host, but not interactively. To execute some commands at remote host you can write simple shell script and run it using Web Console (for example, have a look at "rexec" UNIX command description here and here, or "rsh" UNIX command description here).

You can write simple script that will accept input parameter. That parameter will represent as a shell command that should be run on remote host. After that — create new Web Console user using internal Web Console command "#user create" and add following "User startup JavaScript" to that user:

WC.Console.Exec.CMD_original = WC.Console.Exec.CMD;
WC.Console.Exec.CMD = function(in_CMD) {
   if (in_CMD && !in_CMD.match(/^(cls|clear)[ ]{0,}$/i) && !in_CMD.match(/^#/)) {
      in_CMD = '/path_to_script/remote_host_exec.sh '+in_CMD;
   }
   WC.Console.Exec.CMD_original(in_CMD);
};

Now logon to the Web Console under created user, all commands will be executed through your script '/path_to_script/remote_host_exec.sh', so it will be executed at remote host.

You can write script that will receive host as first parameter and command as second parameter, so using that script and by creating Web Console users you can execute commands at any hosts.

Web Console configuration/installation

How can I change Web Console style (i.e. font color, size...)?

To change Web Console style setting please type "#settings" in the Web Console command prompt and press "Enter" key on your keyboard. At the following configuration area choose "Style" tab. In the "Style" tab please set following values:

• At the field "Console font styles / Family" you can set console font family at the CSS 'font-family' property format.
• At the field "Console font styles / Color" you can set console font color at the CSS 'color' property format.
• At the field "Console font styles / Size" you can set console font size at the CSS 'font-size' property format.

Values at these fields should be set according the CSS font specification ('font-family', 'font-size', 'color', ...).

Web Console style settings examples:

• To set only one font family — enter font family name in the field "Console font styles / Family" (for example — "courier") and click "Save" button. After reloading the Web Console, text in the application will be displayed with selected font (at our example — "courier" font).
• To set first available font family — enter font family names, as a coma separated list, in the field "Console font styles / Family" (for example — "fixedsys, courier new, courier, verdana, helvetica, arial, sans-serif") and click "Save" button. After reloading the Web Console, text in the application will be displayed with first available font (at our example — first font "fixedsys", if that font doesn't exists at the system, than the next in the list — "courier new" font will be used and so on).
• To set color of the font — enter font color in the field "Console font styles / Color". For example, to set white font color, enter "white" or "#ffffff" (hex HTML code for white color), and click "Save" button. After reloading the Web Console, text in the application will be displayed with selected font color (at our example — white color).
  To restore default font color — enter "#bbbbbb" in the field "Console font styles / Color".
• To set font size at points or pixels — enter font size in the field "Console font styles / Size" (for example — "10pt" for 10 points or "14px" for 14 pixels) and click "Save" button. After reloading the Web Console, text in the application will be displayed with selected font size (at our example — 10 points or 14 pixels).

How can I configure Web Console encodings?

To change Web Console encodings settings please type "#settings" in the Web Console command prompt and press "Enter" key on your keyboard. At the following configuration area choose "Encodings" tab. In the "Encodings" tab please set following values:

• At the field "Server console encoding" you can set encoding of server shell commands execution output (like 'ls', 'dir', ...).
• At the field "Server system encoding" you can set encoding of server internal commands (programming commands) output (like getting listing of the directory using internal Perl function).
• At the field "Text editor encoding" you can set encoding for text files editor ("#file edit"), if that field empty, then for text files editor the "Server system encoding" will be used.
• At the field "Downloading (filename)" you can set encoding for downloaded file names.

Common encodings list:

Web Console development

I would like participate in the Web Console development process, what should I do?

To get most recent development version of the Web Console application please use our Subversion repository. If you would like to submit your changes back to the core — please read Web Console development version description for details.

If you have any questions about Web Console development process, please contact us — development@web-console.org.

I have got one of the following error/warning messages, what should I do?

MOD_PERL detected

Web Console has detected mod_perl, script "wc.pl" should be executed by web server without mod_perl.

Make sure that "wc.pl" executed by web server without mod_perl. Simple Apache configuration to run Web Console without mod_perl will looks like that:

AddHandler cgi-script .cgi .pl
<Directory /var/www/web-console/>
	AllowOverride All
	Options +FollowSymLinks +ExecCGI
</Directory>

Incorrect Web Console call

Undefined Web Console action was called or action needs more parameter(s). Please check that data didn't change during transmitting on the network. If you use proxy server, it may change transmitting data.

Make sure that the Web Console installed properly, reinstall application if required.

Login or password is not defined

Make sure that data didn't change during transmitting on the network. If you use proxy server, it may change transmitting data.

Make sure that the Web Console installed properly, reinstall application if required.

Users DB is not loaded

Make sure that Web Console main config file (usually — 'wc_data/configs/wc_config.pl' in the directory where the Web Console was installed) exists and that file wasn't modified by some program or user.

Make sure that Web Console users DB config file (usually — 'wc_data/configs/wc_users.pl' in the directory where the Web Console was installed) exists and that file wasn't modified by some program or user.

As well, make sure that the Web Console installed properly, reinstall application if required.

Unable change directory to 'dirname'

Please make sure that directory 'dirname' was not removed or renamed. You can change current directory using "cd" command. Make sure that Web Console main config file (usually — 'wc_data/configs/wc_config.pl' in the directory where the Web Console was installed) exists and that file wasn't modified by some program or user.

As well, make sure that the Web Console installed properly, reinstall application if required.

Error: Unable to make AJAX response

Looks like it was bad AJAX request. Make sure that data didn't change during transmitting on the network. If you use proxy server, it may change transmitting data.

Make sure that the Web Console installed properly, reinstall application if required.

Error: Web Console temp directory is not defined (unable to initialize 'NL::File::Lock')

In case, if you are using Web Console version 0.2 beta or eailer and you are using Apache web server, make sure that script "wc.pl" executed by web server without mod_perl. Simple Apache configuration to run Web Console without mod_perl will looks like that:

AddHandler cgi-script .cgi .pl
<Directory /var/www/web-console/>
	AllowOverride All
	Options +FollowSymLinks +ExecCGI
</Directory>

Also, if Web Console installed, please make sure that Web Console main config file (usually — 'wc_data/configs/wc_config.pl' in the directory where the Web Console was installed) exists and that file wasn't modified by some program or user.

As well, make sure that the Web Console installed properly, reinstall application if required.

Error: Web Console temp directory is not exists

If you are installing Web Console:

Please make sure that 'wc.pl' script has write permissions to Web Console root directory (where 'wc.pl' is located). For example, change permissions for Web Console root directory (where 'wc.pl' is located) to: 755, 775 or 777 (using chmod command).

If Web Console already installed:

Make sure that Web Console temp directory (usually — 'wc_data/temp' in the directory where the Web Console was installed) exists and that directory wasn't renamed or deleted by some program or user.

Make sure that Web Console main config file (usually — 'wc_data/configs/wc_config.pl' in the directory where the Web Console was installed) exists and that file wasn't modified by some program or user.

As well, make sure that the Web Console installed properly, reinstall application if required.

Error: WC::File::save(): Unable to lock/open file 'filename' (file name/DATA is not specified)

Please make sure that file 'filename' exists. Also, make sure that file 'filename' is NOT exclusively locked by another program.

Make sure that Web Console main config file (usually — 'wc_data/configs/wc_config.pl' in the directory where the Web Console was installed) exists and that file wasn't modified by some program or user.

As well, make sure that the Web Console installed properly, reinstall application if required.

Error: Main Web Console config filename is not defined

Please make sure that Web Console main config file (usually — 'wc_data/configs/wc_config.pl' in the directory where the Web Console was installed) exists and that file wasn't modified by some program or user.

As well, make sure that the Web Console installed properly, reinstall application if required.

Error: WC::Config::load(): Unable to load/lock config file 'filename'

Please make sure that config file 'filename' exists and that file wasn't modified by some program or user. Also, make sure that file 'filename' is NOT exclusively locked by another program.

As well, make sure that the Web Console installed properly, reinstall application if required.

Error: Web Console Users DB file name is not defined

Make sure that Web Console main config file (usually — 'wc_data/configs/wc_config.pl' in the directory where the Web Console was installed) exists and that file wasn't modified by some program or user.

As well, make sure that the Web Console installed properly, reinstall application if required.

Error: Web Console configuration object not found, users DB not found, users DB checking error

Make sure that Web Console main config file (usually — 'wc_data/configs/wc_config.pl' in the directory where the Web Console was installed) exists and that file wasn't modified by some program or user.

Make sure that Web Console users DB file (usually — 'wc_data/configs/wc_users.pl' in the directory where the Web Console was installed) exists and that file wasn't modified by some program or user.

As well, make sure that the Web Console installed properly, reinstall application if required.

Error: Unable to check if configuration file is exists

Make sure that Web Console main config file (usually — 'wc_data/configs/wc_config.pl' in the directory where the Web Console was installed) exists and that file wasn't modified by some program or user.

Make sure that Web Console users DB file (usually — 'wc_data/configs/wc_users.pl' in the directory where the Web Console was installed) exists and that file wasn't modified by some program or user.

As well, make sure that the Web Console installed properly, reinstall application if required.