ASTERISK(8)

📦
version 22.10.0 · 6 versions
, in ubuntu resolute, ubuntu stonking

💖 asterisk(8) — the all-purpose telephony server, bestie edition 💖

okay so you're looking at the manual page for asterisk, section 8 (that's the sysadmin-y section, iykyk). this is the whole thing, no skips, no cuts. let's go 🫶

✨ NAME ✨

asterisk — your all-purpose telephony server. that's it, that's the vibe.

🌸 SYNOPSIS 🌸

asterisk [-BcdfFghiImnpqRtTvVW] [-C file] [-e memory] [-G group] [-L
         loadaverage] [-M value] [-U user] [-s socket-file]
asterisk -r [-v] [-d] [-x command]
asterisk -R [-v] [-d] [-x command]

like. look at that flag soup. it's giving "I contain multitudes" 💅

🦋 DESCRIPTION 🦋

asterisk is a full-featured telephony server, and when I say full-featured I mean it does literally everything. it hands you:

  • Private Branch eXchange (PBX)
  • Interactive Voice Response (IVR)
  • Automated Call Distribution (ACD)
  • Voice over IP (VoIP) gatewaying
  • Conferencing
  • and a plethora of other telephony applications

...to a whole broad range of telephony devices, including packet voice devices (SIP, IAX2, H.323, Unistim) — both endpoints and proxies — plus traditional TDM hardware like T1, E1, ISDN PRI, GR-303, RBS, Loopstart, Groundstart, ISDN BRI and many more. not me listing all of those. okay yes me listing all of those, they all matter 🎀

At start, Asterisk reads the /etc/asterisk/asterisk.conf main configuration file and locates the rest of the configuration files from the configuration in that file. The -C option specifies an alternate main configuration file. Virtually all aspects of the operation of asterisk's configuration files can be found in the sample configuration files. The format for those files is generally beyond the scope of this man page — so don't come for me, I'm just the messenger 🙈

When running with -c, -r or -R options, Asterisk supplies a powerful command line, including command completion, which may be used to monitor its status, perform a variety of administrative actions and even explore the applications that are currently loaded into the system. tab completion in a telephony server?? main character energy fr fr 👑

Asterisk is a trademark of Digium, Inc. 💜 (legal said I have to say it, so I'm saying it)

💅 OPTIONS 💅

okay so real talk: running Asterisk starts the asterisk daemon (optionally running it in the foreground). However running it with -r or -R connects to an existing Asterisk instance through a remote console. two completely different moods. know which one you're in bestie.

  • -B — Force the background of the terminal to be black, in order for terminal colors to show up properly. Equivalent to forceblackbackground = yes in asterisk.conf. See also -n and -W. 🖤
  • -C file — Use file as master configuration file instead of the default, /etc/asterisk/asterisk.conf
  • -c — Provide a control console on the calling terminal. The console is similar to the remote console provided by -r. Specifying this option implies -f and will cause asterisk to no longer fork or detach from the controlling terminal. Equivalent to console = yes in asterisk.conf. 🎮
  • -d — Enable extra debugging statements. This parameter may be used several times, and each increases the debug level. Equivalent to debug = num in asterisk.conf to explicitly set the initian debug level to num. When given at startup, this option also implies -f (no forking). However when connecting to an existing Asterisk instance (-r or -R), it may only increase the debug level. (yes, "initian" — I said what I said, that's the typo that lives in the original and I'm not touching it 🫣)
  • -e memory — Limit the generation of new channels when the amount of free memory has decreased to under memory megabytes. Equivalent to minmemfree = memory in asterisk.conf.
  • -f — Do not fork or detach from controlling terminal. Overrides any preceding specification of -F on the command line. Equivalent to nofork = yes in asterisk.conf. See also -c.
  • -F — Always fork and detach from controlling terminal. Overrides any preceding specification of -f on the command line. May also be used to prevent -d and -v to imply no forking. Equivalent to alwaysfork = yes in asterisk.conf.
  • -g — Remove resource limit on core size, thus forcing Asterisk to dump core in the unlikely event of a segmentation fault or abort signal. NOTE: in some cases this may be incompatible with the -U or -G flags. 💀 (yes it's a core dump, yes it's dramatic, that's the point)
  • -G group — Run as group instead of the calling group. NOTE: this requires substantial work to be sure that Asterisk's environment has permission to write the files required for its operation, including logs, its comm socket, the asterisk database, etc. so like... do your homework first, bestie. this is not a set-it-and-forget-it situation.
  • -h — Provide brief summary of command line arguments and terminate. the classic "help me I'm lost" flag, we've all been there 🌸
  • -i — Prompt user to intialize any encrypted private keys for IAX2 secure authentication during startup. (another lil typo from the original, "intialize" — she stays. it's her house 🏠)
  • -I — Enable internal timing if DAHDI timing is available. The default behaviour is that outbound packets are phase locked to inbound packets. Enabling this switch causes them to be locked to the internal DAHDI timer instead. ⏰
  • -L loadaverage — Limits the maximum load average before rejecting new calls. This can be useful to prevent a system from being brought down by terminating too many simultaneous calls. protect the machine!! 🛡️
  • -m — Temporarily mutes output to the console and logs. To return to normal, use logger mute. 🤫
  • -M value — Limits the maximum number of calls to the specified value. This can be useful to prevent a system from being brought down by terminating too many simultaneous calls. same energy as -L but with a hard number instead of a vibe check.
  • -n — Disable ANSI colors even on terminals capable of displaying them. This option can be used only at startup (e.g. not with remote console). 😭 the anti-color flag. tragic but valid.
  • -p — If supported by the operating system (and executing as root), attempt to run with realtime priority for increased performance and responsiveness within the Asterisk process, at the expense of other programs running on the same machine.
Note: astcanary will run concurrently with asterisk. If astcanary stops running or is killed, asterisk will slow down to normal process priority, to avoid locking up the machine. so like, astcanary is the little buddy that keeps the whole thing from going feral. respect the canary 🐤
  • -q — Reduce default console output when running in conjunction with console mode (-c). quieter. calm. lowkey serene. 🧘
  • -r — Instead of running a new Asterisk process, attempt to connect to a running Asterisk process and provide a console interface for controlling it.
  • -R — Much like -r. Instead of running a new Asterisk process, attempt to connect to a running Asterisk process and provide a console interface for controlling it. Additionally, if connection to the Asterisk process is lost, attempt to reconnect for as long as 30 seconds. she's clingy in a GOOD way. 30 seconds of pure loyalty 🥹
  • -s socket file name — In combination with -r, connect directly to a specified Asterisk server socket. (the synopsis calls this socket-file, the options section calls it socket file name — both are here, both are correct, I don't make the rules 💅)
  • -t — When recording files, write them first into a temporary holding directory, then move them into the final location when done. safety first, slay second 🎀
  • -T — Add timestamp to all non-command related output going to the console when running with verbose and/or logging to the console. timestamps! for the girlies who need to know when things went down ⏱️
  • -U user — Run as user instead of the calling user. NOTE: this requires substantial work to be sure that Asterisk's environment has permission to write the files required for its operation, including logs, its comm socket, the asterisk database, etc. (same disclaimer as -G, same amount of work, same energy)
  • -v — Increase the level of verboseness on the console. The more times -v is specified, the more verbose the output is. Specifying this option implies -f and will cause asterisk to no longer fork or detach from the controlling terminal. This option may also be used in conjunction with -r and -R.
Note: This always sets the verbose level in the asterisk process, even if it is running in the background. This will affect the size of your log files. 👀 your log files. watch them. they will grow.
  • -V — Display version information and exit immediately. no thoughts, just version, bye ✌️
  • -W — Display colored terminal text as if the background were white or otherwise light in color. Normally, terminal text is displayed as if the background were black or otherwise dark in color. 🤍
  • -x command — Connect to a running Asterisk process and execute a command on a command line, passing any output through to standard out and then terminating when the command execution completes. Implies -r when -R is not explicitly supplied. one-shot command, in and out, no notes 🔥
  • -X — Enables executing of includes via #exec directive inside asterisk.conf.

🌈 EXAMPLES 🌈

asterisk — Begin Asterisk as a daemon

asterisk -vvvgc — Run on controlling terminal

asterisk -rx "core show channels" — Display channels on running server

(that last one is the one you'll type a million times, bestie. memorize it. it's iconic.)

🐛 BUGS 🐛

Bug reports and feature requests may be filed at https://github.com/asterisk/asterisk/issues/

found a bug? file it. don't just vague-post about it 💖

👀 SEE ALSO 👀

👑 AUTHOR 👑

Mark Spencer <markster@digium.com>

Countless other contributors, see CREDITS with distribution for more information. the "countless" is doing a lot of heavy lifting here and honestly? they earned it 🫶

okay that's the whole page, every single flag, every default, every note, every typo (lovingly preserved), every link. nothing skipped, nothing invented.

this was asterisk from asterisk Trunk, dated 2011-02-08, manual section asterisk (8) — mwah, that's the whole thing, periodt 💅✨🎀

📦 where this page comes from