Skip to content

cla web-start - Start the web server

cla web-start starts the Clarive web server process.

The web server provides the HTTP interface for the Clarive application, including the user interface, REST API, and pubsub module for worker connections.

Usage

cla web-start -c MYCONFIG [options]

Options

  • -c, --config MYCONFIG - Specify the configuration file to use (required).
  • -d, --daemon - Run the web server as a background daemon.
  • --debug <level> - Set debug level (1-5, higher numbers show more detail).
  • --port <port> - Override the web server port from config.
  • --reload - Enable automatic reload when files are modified (development mode).

Environment Variables

  • CLARIVE_DEBUG=<level> - Set debug output level (1-5).
  • CLARIVE_TRACE=db - Print every MongoDB call with parameters and elapsed time.

Examples

Start the web server in foreground mode:

cla web-start -c myconfig

Start as a daemon with auto-reload for development:

cla web-start -c myconfig --daemon --reload

Start with high debug output:

CLARIVE_DEBUG=5 cla web-start -c myconfig
  • cla web-stop - Stop the web server.
  • cla web-restart - Restart the web server.

Modules

The web server starts the following modules by default:

  • Web Interface - User interface and HTML pages.
  • REST API - RESTful API endpoints.
  • Pubsub - WebSocket connections for workers and real-time updates.

Notes

  • The web server automatically reloads modified files after 3 seconds when --reload is enabled.
  • The pubsub module must be active for workers to connect.
  • Check logs in the configured log directory for troubleshooting.
  • To see web server status, use cla ps -c myconfig.
  • Default port is typically 3000, configurable in the YAML config file.