chirp_server(1)

📦
version 9.9 · 3 versions
, in debian bookworm, ubuntu jammy, ubuntu noble

💖 chirp_server(1) — the manual page, bestie edition 💖

okay so this is chirp_server, from the Cooperative Computing Tools (cctools for the girlies who know 👑). it's section 1 of the manual, and it's literally about to change your whole filesystem-sharing life. sit down, hydrate, let's go 🍓

✨ NAME ✨

chirp_server — spin up a whole Chirp user-level filesystem, no admin required, no cap 🦋

🎀 SYNOPSIS 🎀

chirp_server [options]

🌸 DESCRIPTION 🌸

so. you wanna share data with your friends and colleagues but you don't have admin privileges and you're not about to beg IT for anything? chirp_server is the answer, periodt. it starts a Chirp server, which is basically a little icon that lets people share files with each other without needing root, without needing permission slips, without any of that 💅

under the hood, Chirp gives you an RPC network interface pointed at a "backend" filesystem — and that backend can be your plain old local filesystem, or even the Hadoop HDFS filesystem, because we contain multitudes. and bestie, the ACL management? flexible, robust, chef's kiss. your data, your rules ✨

if you want the complete details, with examples and everything, go read the Chirp User's Manual at http://ccl.cse.nd.edu/software/manuals/chirp.html — it's giving required reading 📚

🧚 OPTIONS 🧚

every single one, no skips, we don't gatekeep here 💜

  • -A, --default-acl=<file> — use this file as the default ACL.
  • --inherit-default-acl — directories that don't have their own ACL just inherit from their parent directories. passing down the family recipes fr fr.
  • -a, --auth=<method> — turn on this authentication method.
  • -b, --background — run as a daemon (background main character energy).
  • -B, --pid-file=<file> — write the PID to this file.
  • -C, --no-core-dump — do NOT create a core dump, not even if it crashes. we're keeping it cute even in our worst moments 🙈
  • -c, --challenge-dir=<dir> — the challenge directory for unix filesystem authentication.
  • -d, --debug=<flag> — enable debugging for this subsystem.
  • -E, --parent-death — exit if the parent process dies. ride or die, literally — if they go, we go 💀
  • -e, --parent-check=<time> — check whether the parent is still around at this interval. (default is 300s)
  • -F, --free-space=<size> — leave this much space free in the filesystem. save some room for later 🫶
  • -G, --group-url=<url> — base url for group lookups. (default: disabled)
  • -h, --help — give help information.
  • -I, --interface=<addr> — listen only on this network interface. exclusive, and honestly? valid.
  • -M, --max-clients=<count> — set the maximum number of clients to accept at once. (default unlimited — the door is OPEN)
  • -n, --catalog-name=<name> — use this name when reporting to the catalog. your stage name, basically ⭐
  • -o, --debug-file=<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=<bytes> — rotate the debug file once it reaches this size. glow-up for your logs ✨
  • -P, --superuser=<user> — superuser for all directories. (default is none)
  • -p, --port=<port> — listen on this port (default is 9094, arbitrary is 0).
  • --project-name <name> — the project name this Chirp server belongs to.
  • -Q, --root-quota=<size> — enforce this root quota in software.
  • -R, --read-only — read-only mode. look but don't touch, bestie 👀
  • -r, --root=<url> — URL of the storage directory, like file://path or hdfs://host:port/path.
  • -s, --stalled=<time> — abort stalled operations after this long. (default is 3600s)
  • -T, --group-cache-exp=<time> — maximum time to cache group information. (default is 900s)
  • -t, --idle-clients=<time> — disconnect idle clients after this time. (default is 60s) if you're gonna ghost, ghost 👻
  • -U, --catalog-update=<time> — send status updates at this interval. (default is 5m)
  • -u, --advertize=<host> — send status updates to this host. (default is catalog.cse.nd.edu)
  • -v, --version — show version info.
  • -W, --passwd=<file> — use an alternate password file for unix authentication.
  • -w, --owner=<name> — the name of this server's owner. (default is username)
  • -y, --transient=<dir> — location of transient data (default is pwd).
  • -Z, --port-file=<file> — select a port at random and write it to this file. (default is disabled)
  • -z, --unix-timeout=<time> — set the max timeout for unix filesystem authentication. (default is 5s)

🌈 ENVIRONMENT VARIABLES 🌈

the vibes your shell can set before chirp_server even walks in:

  • CATALOG_HOST — hostname of the catalog server (same as -u).
  • TCP_LOW_PORT — inclusive low port in the range used with -Z.
  • TCP_HIGH_PORT — inclusive high port in the range used with -Z.

💅 EXIT STATUS 💅

  • on success, returns zero. slay. ✨
  • on failure, returns non-zero. not slay. 😭

🔥 EXAMPLES 🔥

wanna start a Chirp server with a local root directory? say less:

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

and now the various authentication modes moment — stacking them like accessories:

% 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 🦋

and that's the whole page, bestie 💖 this one's from CCTools 8.0.0 DEVELOPMENT — go forth, share files, stay iconic, and remember: no admin privileges required, only vibes 🧚✨
📦 where this page comes from