NaviServer - programmable web server
4.99  5.0

[ Main Table Of Contents | Table Of Contents | Keyword Index ]

nscp(n) 5.0.0a nscp "NaviServer Modules"

Name

nscp - NaviServer Control Port Guide

Table Of Contents

Description

Introduction

NaviServer includes a control port interface that can be enabled with the nscp module. This control port interface allows you to telnet to a specified host and port where you can administer the server and execute database commands while the server is running.

The control port interface is a Tcl interface. Within it, you can execute any Tcl command that Tcl libraries and ADP can; the only exceptions being the ns_conn commands.

To administer a server with the control port interface while it is running, the nscp module must be loaded into the server. To set permissions for the server, the nsperm module must also be loaded. To execute database commands while the server is running, you must also configure database services for the server, including database drivers and pools.

Configuring the Control Port Interface

An example configuration for the control port interface is shown below. Three sections of the configuration file are included. The nscp module is loaded into the /modules section for $server. The /module/nscp section defines the control port parameters, and the /module/nscp/users section defines the users who can log into the control port.

 #
 # Control port -- nscp
 #
 ns_section ns/server/${server}/module/nscp {
   ns_param   port            9999        ;# Control port listens on port 9999
   ns_param   address         "127.0.0.1" ;# For security, use 127.0.0.1 only
 }
 
 # Control port users
 ns_section ns/server/${server}/module/nscp/users {
   #
   # The default password for nsadmin is "x". You should change it.
   # type "ns_crypt newpassword salt" and put the encrypted string
   # below.
   
   ns_param user "nsadmin:t2GqvvaiIUbF2:" ;# sample user="nsadmin", pw="x".
 }
 
 ns_section ns/server/${server}/modules {
   # ...
   ns_param nscp nscp.so
 }

Some things to notice about the configuration are:

See the Configuration Reference for complete information on configuration.

Using the Control Port Interface

To use the control port interface, follow these steps:

  1. Telnet to the address and port number defined in the /module/nscp section for the server. For example:

     telnet localhost 9999
    

    The session responds with:

     Trying 127.0.0.1...
     Connected to localhost.
     Escape character is '^]'.
     login:
    
  2. At the login prompt, type a valid username. The username must be one of the usernames defined in the /module/nscp/users section of the configuration file. For example:

      login: nsadmin
    

    The session responds with:

     password:
    
  3. At the password prompt, type the password associated with the username you specified. The default is "x".

    The session responds with:

     Welcome to server1 running at /usr/local/ns/bin/nsd (pid 22413)
     NaviServer/4.99.29 for linux built on MON/DAY/YEAR at HH:MM:SS
     server1:nscp 1>
    
  4. At the prompt you can type nearly any Tcl command available to NaviServer Tcl libraries and ADPs.

  5. When you're done, just type "exit" and you will be logged off.

Useful Commands

Type "lsort [info commands]" for a complete list of commands available to you. You can type nearly any Tcl command available to NaviServer Tcl libraries and ADPs, including the complete Tcl core and nearly any ns_* commands. Type "lsort [info commands ns*]" for a sorted list of available NaviServer Tcl commands.

Useful commands:

See Also

admin-maintenance

Keywords

configuration, module, nscp