Skip to content

translaster/asterisk-guide

 
 

Repository files navigation

Asterisk Guide — 2nd Edition

Build book

The open source of Asterisk Guide by Flavio E. Gonçalves — a systematic guide to building an IP PBX with Asterisk 22 LTS. The Markdown source and the lab are free; the paper book (Amazon KDP) and the VoIP School Blackbelt training are the supported products.

Download the book

The book is free to download. Tagged releases (v*) attach:

  • asterisk-guide-sponsored.pdf and .epub — the free, sponsored English editions. This is the verified, current download. Sponsored by SipPulse — the SIP authority behind 200+ operators — plus per-lab sponsors.

Only the sponsored editions are published here. The clean, ad-free interior (asterisk-guide.pdf/.epub/.tex) is built for the paid Amazon paperback/Kindle and is not distributed on GitHub — so nobody picks an ad-free copy sitting next to the sponsored one.

Grab them from Releases, or build any branch from Actions → latest run → Artifacts.

Translated editions (preview — off by default)

The book also builds in 9 more languages (pt, es, fr, de, it, hi, zh, ja, ar) — machine-translated with Gemini, figures kept in English. Arabic (ar) is typeset right-to-left. These are gated off until the translations are verified: CI builds and releases them only when the repo variable BUILD_TRANSLATIONS is set to true (and the GEMINI_API_KEY secret exists). Until then, every release is English only. Build one locally any time with BOOK_LANG=pt bash book/build.sh (sponsored PDF + EPUB).

Build locally

# needs: pandoc + a LaTeX engine (xelatex)
bash book/build.sh        # → build/asterisk-guide.{pdf,epub,tex}

Repository layout

src/chapters/   the book, one Markdown file per chapter (single source of truth)
src/images/     figures
src/extract.py  the original PDF→Markdown recovery pipeline
book/           Pandoc build (metadata.yaml, build.sh)
lab/            reproducible Asterisk 22 Docker lab used to verify every example
docs/adr/       architecture/decision records
CONTEXT.md      canonical glossary (terminology used across the book)
PLAN-2ND-EDITION.md   the modernization plan & roadmap
.github/workflows/build-book.yml   CI: build PDF/EPUB/LaTeX on every PR, release on tags

Contributing

Open a PR. CI rebuilds the book and attaches the rendered PDF/EPUB/LaTeX as artifacts so the change can be reviewed as the finished book, not just the diff. Examples are expected to be verified against the Asterisk 22 lab in lab/.

License

Everything in this repository is licensed CC BY-NC-SA 4.0 (see LICENSE) — free to read, share, and adapt for non-commercial purposes with attribution. The paper book (Amazon KDP) and the VoIP School Blackbelt training are the author's commercial products.

About

Asterisk Guide (2nd ed.) — build an IP PBX with Asterisk 22 LTS, PJSIP-first. Free book in 9 languages, a reproducible Docker lab, a hands-on lab guide, and Slidev decks.

Resources

License

Stars

0 stars

Watchers

0 watching

Forks

Packages

 
 
 

Contributors

Languages

  • Python 91.5%
  • Shell 3.1%
  • TeX 2.1%
  • Lua 1.3%
  • HTML 1.2%
  • Dockerfile 0.8%