OpenSIPS(8)

📦
version 4.0.2 · 2 versions
, in arch rolling

💅 opensips(8) — the VoIP SIP Server page, but make it make sense

okay so bestie, quick housekeeping before we dive in: this whole thing is from the OpenSIPS(8) manual, the VoIP SIP Server section of it, and I'm gonna walk you through it like we're texting at 2am. it's a lot but we got this 🫶

✨ NAME ✨

opensips — a flexible and roboust SIP (RFC3261, RFC3263) server for Voice over IP (VoIP)

yes it says "roboust", not "robust" — that's the original's typo and I'm not about to gaslight you by fixing it, so it stays 💀

🎀 SYNOPSIS 🎀

opensips [ -hcCrRvdDEVT ] [ -f config-file ] [ -l address ] [ -n processes-no ] [ -N tcp processes-no ] [ -b max_rcv_buf_size ] [ -m shared_mem_size ] [ -w working-dir ] [ -W method ] [ -t chroot-dir ] [ -u uid ] [ -g gid ] [ -P pid-file ] [ -i fifo-path ] [ -x socket-path ]

like, that's the whole bingo card. every flag gets its own moment below, don't worry 🌸

🦋 DESCRIPTION 🦋

okay so OpenSIPS is a SIP-based VoIP server and it runs on most Unix-like operating systems — yes, basically everywhere your cool friends hang out. it supports UDP, TCP and TLS transport layers. and among its features, we have literally:

  • SIP Proxy Server, SIP Registrar Server, SIP Redirect Server, SIP Location Server, SIP Application Server
  • Call Processing Language (RFC3880)
  • ENUM support
  • server side NAT traversal
  • load balancing
  • AAA with database (MySQL, Postgres, Unixodbc) or RADIUS backend
  • audio, video, instant messaging and pressence
and yeah, "pressence" — again, that's their spelling, not mine. we respect the artifact 🙈

👑 OPTIONS 👑

one bullet per flag, all iconic, all here. let's go ✨

  • -h — Displays a short usage description, including all available options. the little "what do i even do here" helper 💅
  • -c — Checks the config file and displays the aliases and listen interface list. it's giving ✨vibe check✨ before you commit.
  • -C — Similar to -c but in addition checks the flags of exported functions from included route blocks. the extra thorough version of the vibe check.
  • -r — Uses dns to check if it is necessary to add a "received=" field to a via.
  • -R — Same as -r but uses reverse dns. the plot twist version 🌈
  • -v — Turns on via host checking when forwarding replies.
  • -d — Turns on debugging, multiple -d increase the debug level. stack 'em like candy 🍓
  • -D — Runs opensips in the foreground (it doesn't fork into daemon mode).
  • -T — Disables TCP support.
  • -V — Displays the version number. the classic "who are you" of flags.
  • -f config-file — Reads the configuration from config-file (default /etc/opensips/opensips.cfg).
  • -l address — Listens on the specified address/interface. Multiple -l mean listening on multiple addresses. The address format is [proto:]address[:port], where proto = udp|tcp and address = host|ip_address|interface_name. Example: -l localhost, -l udp:127.0.0.1:5080, -l eth0:5062. The default behaviour is to listen on all the ipv4 interfaces. literally main character energy, listening to everybody 🎤
  • -n processes-no — Specifies the number of children processes forked per interface (default 8).
  • -N tcp processes-no — Specifies the number of children processes forked to handle tcp incoming connections (by default is equal to -n).
  • -b max_rcv_buf_size — Maximum receive buffer size which will not be exceeded by the auto-probing procedure even if the OS allows. it's a hard limit, bestie, respect it 💀
  • -m shared_mem_size — Size of the shared memory which will be allocated (in Megabytes).
  • -w working-dir — Specifies the working directory. In the very improbable event that opensips will crash, the core file will be generated here.
  • -W method — Specify poll method.
  • -t chroot-dir — Forces opensips to chroot after reading the config file.
  • -u uid — Changes the user id under which opensips runs.
  • -g gid — Changes the group id under which opensips runs.
  • -P pid-file — Creates a file containing the pid of the main opensips process.
  • -i fifo-path — Creates a fifo, useful for monitoring opensips status.
  • -x socket-path — Creates a unix socket, useful for monitoring opensips status ( same as -i fifo-path but using instead unix sockets).

🧚 FILES 🧚

the sacred texts, if you will 📜

  • /usr/bin/opensips
  • /etc/opensips/opensips.cfg
  • /usr/lib/opensips/modules/*

🌸 AUTHORS 🌸

see /usr/share/doc/opensips/AUTHORS

they're not gonna list everyone here, the whole squad is in that file, go look 🫶

⭐ SEE ALSO ⭐

Full documentation on opensips is available at https://opensips.org/.

Project tracker and GIT https://github.com/OpenSIPS/opensips.

Mailing lists:

  • users@lists.opensips.org - opensips user community
  • devel@lists.opensips.org - opensips development, new features and unstable version

aaaand that's the page, bestie, we ate and left no crumbs 🔥

💌 cute little sign-off: this whole thing is from OpenSIPS, dated 08.06.2006, and the page itself is titled OpenSIPS(8). so like—old but iconic, periodt. 👑
📦 where this page comes from