bbb-install icon indicating copy to clipboard operation
bbb-install copied to clipboard

Long options

Open debuglevel opened this issue 2 years ago • 0 comments

This issue might be opinionated, but I'm a huge fan of long options - especially for commands I do not use every second day. In the last two years, I looked up every time, what the short options of bbb-install.sh actually mean.

(To be honest, I don't know if this is easy with bash.)

Some ideas; but feel free to use completely different ones:

OPTIONS (install BigBlueButton):

  --version, -v <version>           Install given version of BigBlueButton (e.g. 'focal-250') (required)

  --hostname, -s <hostname>          Configure server with <hostname>
  --letsencrypt-email, -e <email>             Email for Let's Encrypt certbot

  --lets-encrypt-manual-challenge, -x                     Use Let's Encrypt certbot with manual dns challenges

  --install-api-demos, -a                     Install BBB API demos
  --install-greenlight, -g                     Install Greenlight
  --use-coturn, -c <hostname>:<secret> Configure with coturn server at <hostname> using <secret>

  -m <link_path>         Create a Symbolic link from /var/bigbluebutton to <link_path>

  --apt-proxy, -p <host>              Use apt-get proxy at <host>
  --apt-repository, -r <host>              Use alternative apt repository (such as packages-eu.bigbluebutton.org)

  --use-provided-ssl-certificates, -d                     Skip SSL certificates request (use provided certificates from mounted volume)
  --install-firewall, -w                     Install UFW firewall

  --help, -h                     Print help

OPTIONS (install coturn only):

  --install-coturn, -c <hostname>:<secret> Setup a coturn server with <hostname> and <secret> (required)
  --letsencrypt-email, -e <email>             Configure email for Let's Encrypt certbot (required)

OPTIONS (install Let's Encrypt certificate only):

  --hostname, -s <hostname>          Configure server with <hostname> (required)
  --letsencrypt-email, -e <email>             Configure email for Let's Encrypt certbot (required)
  -l                     Install Let's Encrypt certificate (required)
  --lets-encrypt-manual-challenge, -x                     Use Let's Encrypt certbot with manual DNS challenges (optional)

debuglevel avatar Jun 17 '22 09:06 debuglevel