chirp_server(1)

NAME

chirp_server - create a Chirp user-level filesystem

SYNOPSIS

*chirp_server [options]*

DESCRIPTION

Starts a Chirp server which allows the sharing of data with friends and colleagues without requiring any administrator privileges. Chirp provides an RPC network interface to a "backend" filesystem which can be the local filesystem or even the Hadoop HDFS filesystem. Chirp supports flexible and robust ACL management of data.

For complete details with examples, see the Chirp User's Manual.

OPTIONS

  • -A --default-acl Use this file as the default ACL.
  • --inherit-default-acl Directories without an ACL inherit from parent directories.
  • -a --auth Enable this authentication method.
  • -b, --background Run as daemon.
  • -B --pid-file Write PID to file.
  • -C, --no-core-dump Do not create a core dump, even due to a crash.
  • -c --challenge-dir Challenge directory for unix filesystem authentication.
  • -d --debug Enable debugging for this sybsystem
  • -E, --parent-death Exit if parent process dies.
  • -e --parent-check Check for presence of parent at this interval. (default is 300s)
  • -F --free-space Leave this much space free in the filesystem.
  • -G --group-url Base url for group lookups. (default: disabled)
  • -h, --help Give help information.
  • -I --interface Listen only on this network interface.
  • -M --max-clients Set the maximum number of clients to accept at once. (default unlimited)
  • -n --catalog-name Use this name when reporting to the catalog.
  • -o --debug-file Write debugging output to this file. By default, debugging is sent to stderr (":stderr"). You may specify logs to be sent to stdout (":stdout") instead.
  • -O --debug-rotate-max Rotate debug file once it reaches this size.
  • -P --superuser Superuser for all directories. (default is none)
  • -p --port Listen on this port (default is 9094, arbitrary is 0)
  • --project-name name Project name this Chirp server belongs to.
  • -Q --root-quota Enforce this root quota in software.
  • -R, --read-only Read-only mode.
  • -r --root URL of storage directory, like file://path or hdfs://host:port/path.
  • -s --stalled Abort stalled operations after this long. (default is 3600s)
  • -T --group-cache-exp Maximum time to cache group information. (default is 900s)
  • -t --idle-clients Disconnect idle clients after this time. (default is 60s)
  • -U --catalog-update Send status updates at this interval. (default is 5m)
  • -u --advertize Send status updates to this host. (default is catalog.cse.nd.edu)
  • -v, --version Show version info.
  • -W --passwd Use alternate password file for unix authentication
  • -w --owner The name of this server's owner. (default is username)
  • -y --transient Location of transient data (default is pwd).
  • -Z --port-file Select port at random and write it to this file. (default is disabled)
  • -z --unix-timeout Set max timeout for unix filesystem authentication. (default is 5s)

ENVIRONMENT VARIABLES

  • *CATALOG_HOST Hostname of catalog server (same as -u*).
  • *TCP_LOW_PORT Inclusive low port in range used with -Z*.
  • *TCP_HIGH_PORT Inclusive high port in range used with -Z*.

EXIT STATUS

On success, returns zero. On failure, returns non-zero.

EXAMPLES

To start a Chirp server with a local root directory:

% chirp_server -r file:///tmp/foo

Setting various authentication modes:

% chirp_server -a hostname -a unix -a ticket -r file:///tmp/foo

The Cooperative Computing Tools are Copyright (C) 2005-2019 The University of Notre Dame. This software is distributed under the GNU General Public License. See the file COPYING for details.

SEE ALSO

CCTools 8.0.0 DEVELOPMENT released on