Add asterisk, nextcloud, onlyoffice, mattermost services + vendor/easy-asterisk
asterisk.sh (homelab): - Easy Asterisk PBX with self-hosted coturn TURN server - Vendored from outis1one/easy-asterisk v0.10.0 for offline install - LAN-only or FQDN mode (TLS + TURN relay for remote access) - Auto-answer SIP headers for intercom use case - Authelia SSO for web admin; WEB_ADMIN_AUTH_DISABLED=true when chosen - UFW rules: 5060-5061, 8080, 8088-8089, 3478, 10000-20000/udp, 49152-49252/udp - Builds custom Docker image from vendor/easy-asterisk/ nextcloud.sh (utilities): - Custom Dockerfile: nextcloud:apache + smbclient (SMB external storage) - MariaDB 10.11 sidecar with matching env vars - OVERWRITEPROTOCOL/OVERWRITECLIURL/TRUSTED_PROXIES set for Caddy - Enables files_external app after first-run init (waits up to 90s) onlyoffice.sh (utilities): - JWT generated once, preserved across re-runs - _ensure_yq: auto-installs yq v4 for FileBrowser config patching - _wire_nextcloud: idempotent occ wiring (DocumentServerUrl, jwt_secret) - _wire_filebrowser: patches config.yaml + restarts container - Caddy block overrides X-Frame-Options to allow iframe embedding mattermost.sh (utilities): - PostgreSQL 15-alpine + Mattermost Team Edition + coturn (port 3479) - 8443/udp for Calls plugin RTC server - coturn uses --use-auth-secret HMAC mode (required by Calls plugin) - SITE_URL computed from SITE_DOMAIN, promptable - UFW: 8443/udp, 3479, 49153-49352/udp vendor/easy-asterisk/: - All upstream source files vendored for offline/self-contained installs - Dockerfile, docker/entrypoint.sh, docker/coturn-entrypoint.sh - easy-asterisk-v0.10.0.sh (6929-line management script) - scripts/vpn-diagnostics.sh, scripts/dns-whitelist.sh - .env.example https://claude.ai/code/session_014CCYqVwW6d6f5dw1qRokYt
This commit is contained in:
Claude
+230
-255
@@ -1,16 +1,15 @@
|
||||
#!/bin/bash
|
||||
# services/asterisk.sh — Easy Asterisk PBX with self-hosted coturn TURN server.
|
||||
# services/asterisk.sh — Easy Asterisk PBX + coturn TURN server (home intercom/VoIP).
|
||||
# Part of the modular post-install system (sourced by setup.sh).
|
||||
#
|
||||
# Based on https://github.com/outis1one/easy-asterisk
|
||||
# Source files vendored in vendor/easy-asterisk/
|
||||
# Personal/home-lab use only. Not for commercial or emergency services.
|
||||
#
|
||||
# Can also be run standalone on any machine:
|
||||
# sudo bash asterisk.sh
|
||||
# (Docker must already be installed when run standalone)
|
||||
|
||||
# ── Standalone bootstrap ──────────────────────────────────────────────────────
|
||||
# Detected when the script is executed directly rather than sourced by setup.sh.
|
||||
# Sets up helpers and globals, then defers execution until after the function
|
||||
# definition at the bottom of this file.
|
||||
if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then
|
||||
[[ "$(id -u)" == "0" ]] || { echo "Run with sudo: sudo bash $0"; exit 1; }
|
||||
|
||||
@@ -18,9 +17,11 @@ if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then
|
||||
_COMMON="$_SELF_DIR/../lib/common.sh"
|
||||
|
||||
if [[ -f "$_COMMON" ]]; then
|
||||
# Full repo present — use the real helpers (picks up ~/docker/.config too)
|
||||
# shellcheck source=../lib/common.sh
|
||||
source "$_COMMON"
|
||||
else
|
||||
# One-off copy — inline minimal stubs so the script works without the repo
|
||||
log_info() { echo -e "\033[0;34m[INFO]\033[0m $*"; }
|
||||
log_success() { echo -e "\033[0;32m[OK]\033[0m $*"; }
|
||||
log_warning() { echo -e "\033[1;33m[WARN]\033[0m $*"; }
|
||||
@@ -43,6 +44,7 @@ if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then
|
||||
chown -R "$ACTUAL_USER:$ACTUAL_USER" "$@" 2>/dev/null || true
|
||||
}
|
||||
|
||||
# Match common.sh's eval-based pattern so local vars in install_* are set correctly
|
||||
prompt_text() {
|
||||
local _q="$1" _def="$2" _var="$3" _r
|
||||
[[ "${UNATTENDED:-false}" == "true" ]] && { eval "$_var='$_def'"; return; }
|
||||
@@ -62,6 +64,53 @@ if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then
|
||||
local _caddy_dir="$DOCKER_DIR/caddy"
|
||||
local _caddyfile="$_caddy_dir/Caddyfile"
|
||||
|
||||
# Remote Caddy support: if CADDY_REMOTE_HOST is set, operate on the
|
||||
# remote machine via SSH instead of the local filesystem.
|
||||
if [[ -n "${CADDY_REMOTE_HOST:-}" ]]; then
|
||||
echo ""
|
||||
local _do_caddy=""
|
||||
read -r -p " Configure Caddy reverse proxy for $_name on $CADDY_REMOTE_HOST? [y/N]: " _do_caddy
|
||||
[[ "${_do_caddy,,}" == "y" ]] || {
|
||||
log_info "Skipping — access at: http://$(hostname -I | awk '{print $1}'):${_upstream##*:}"
|
||||
return 0
|
||||
}
|
||||
|
||||
local _domain=""
|
||||
read -r -p " Domain (e.g. ${_subdomain}.${SITE_DOMAIN:-example.com}): " _domain
|
||||
[[ -n "$_domain" ]] || { log_warning "No domain entered — skipping Caddy."; return 0; }
|
||||
|
||||
local _block
|
||||
_block="$(cat << CBLOCK
|
||||
|
||||
# $_name
|
||||
$_domain {
|
||||
reverse_proxy $_upstream
|
||||
|
||||
header {
|
||||
Strict-Transport-Security "max-age=31536000; includeSubDomains; preload"
|
||||
X-Content-Type-Options "nosniff"
|
||||
X-Frame-Options "SAMEORIGIN"
|
||||
Referrer-Policy "strict-origin-when-cross-origin"
|
||||
}
|
||||
|
||||
log {
|
||||
output file /var/log/caddy/${_domain}.log
|
||||
format json
|
||||
}
|
||||
${_extra}
|
||||
}
|
||||
CBLOCK
|
||||
)"
|
||||
echo "$_block" | ssh "$CADDY_REMOTE_HOST" "cat >> $_caddyfile"
|
||||
ssh "$CADDY_REMOTE_HOST" "docker exec caddy caddy fmt --overwrite /etc/caddy/Caddyfile 2>/dev/null || true"
|
||||
if ssh "$CADDY_REMOTE_HOST" "docker exec caddy caddy reload --config /etc/caddy/Caddyfile 2>/dev/null"; then
|
||||
log_success "$_name accessible at: https://$_domain"
|
||||
else
|
||||
log_warning "Reload failed — check: ssh $CADDY_REMOTE_HOST docker logs caddy"
|
||||
fi
|
||||
return 0
|
||||
fi
|
||||
|
||||
if [[ ! -d "$_caddy_dir" ]]; then
|
||||
log_info "Access $_name directly on port ${_upstream##*:}."
|
||||
return 0
|
||||
@@ -79,6 +128,7 @@ if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then
|
||||
read -r -p " Domain (e.g. ${_subdomain}.${SITE_DOMAIN:-example.com}): " _domain
|
||||
[[ -n "$_domain" ]] || { log_warning "No domain entered — skipping Caddy."; return 0; }
|
||||
|
||||
# Back up before touching
|
||||
if [[ -f "$_caddyfile" ]]; then
|
||||
local _bk="$_caddy_dir/Caddyfile.backup.$(date +%Y%m%d-%H%M%S)"
|
||||
cp "$_caddyfile" "$_bk"
|
||||
@@ -87,6 +137,7 @@ if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then
|
||||
touch "$_caddyfile"
|
||||
fi
|
||||
|
||||
# Remove existing block for this domain if present
|
||||
if grep -q "^${_domain}" "$_caddyfile" 2>/dev/null; then
|
||||
log_warning "$_domain already in Caddyfile"
|
||||
local _ow=""
|
||||
@@ -127,12 +178,21 @@ CBLOCK
|
||||
}
|
||||
|
||||
write_readme() {
|
||||
local _dir="$1"; shift
|
||||
local _dir="$1"
|
||||
mkdir -p "$_dir"
|
||||
[[ "${DRY_RUN:-false}" == "true" ]] && return 0
|
||||
cat > "$_dir/README.md"
|
||||
}
|
||||
|
||||
generate_password() {
|
||||
local _len="${1:-32}"
|
||||
tr -dc 'A-Za-z0-9' < /dev/urandom | head -c "$_len"
|
||||
echo
|
||||
}
|
||||
fi
|
||||
|
||||
# Globals — ACTUAL_USER/ACTUAL_HOME must come before DOCKER_DIR
|
||||
# ($HOME under sudo is /root, not the real user's home)
|
||||
ACTUAL_USER="${ACTUAL_USER:-${SUDO_USER:-$USER}}"
|
||||
ACTUAL_HOME="$(getent passwd "$ACTUAL_USER" 2>/dev/null | cut -d: -f6 || echo "${HOME:-/root}")"
|
||||
DOCKER_DIR="${DOCKER_DIR:-$ACTUAL_HOME/docker}"
|
||||
@@ -141,8 +201,9 @@ CBLOCK
|
||||
SITE_TZ="${SITE_TZ:-$(cat /etc/timezone 2>/dev/null || echo UTC)}"
|
||||
SITE_DOMAIN="${SITE_DOMAIN:-example.com}"
|
||||
SITE_CADDY_NET="${SITE_CADDY_NET:-caddy_net}"
|
||||
CADDY_REMOTE_HOST="${CADDY_REMOTE_HOST:-}"
|
||||
|
||||
register_service() { :; }
|
||||
register_service() { :; } # no-op — no wizard to register into
|
||||
_RUN_STANDALONE=1
|
||||
fi
|
||||
# ─────────────────────────────────────────────────────────────────────────────
|
||||
@@ -151,109 +212,76 @@ register_service asterisk homelab "Easy Asterisk PBX + coturn TURN server (home
|
||||
|
||||
install_asterisk() {
|
||||
require_docker || return 1
|
||||
log_info "Installing Easy Asterisk PBX..."
|
||||
log_info "Installing Easy Asterisk PBX + coturn..."
|
||||
|
||||
local EA_DIR="$DOCKER_DIR/asterisk"
|
||||
|
||||
# Locate vendored source files (works when sourced by setup.sh or run standalone)
|
||||
local _script_dir
|
||||
_script_dir="$(cd "$(dirname "${BASH_SOURCE[0]}")" 2>/dev/null && pwd)" \
|
||||
|| _script_dir="$(dirname "$(realpath "$0" 2>/dev/null || echo "$0")")"
|
||||
local VENDOR_DIR="$_script_dir/../vendor/easy-asterisk"
|
||||
VENDOR_DIR="$(cd "$VENDOR_DIR" 2>/dev/null && pwd)" || VENDOR_DIR=""
|
||||
|
||||
if [[ -z "$VENDOR_DIR" || ! -f "$VENDOR_DIR/easy-asterisk-v0.10.0.sh" ]]; then
|
||||
log_warning "Vendored easy-asterisk files not found at $VENDOR_DIR"
|
||||
log_warning "Expected: vendor/easy-asterisk/ alongside services/ directory"
|
||||
log_error "Cannot install — run from the ubuntu-post-install repo root."
|
||||
return 1
|
||||
fi
|
||||
|
||||
if [ "$DRY_RUN" = true ]; then
|
||||
echo "[DRY-RUN] Would create $EA_DIR"
|
||||
echo "[DRY-RUN] Would copy vendored easy-asterisk files (Dockerfile, scripts, entrypoints)"
|
||||
echo "[DRY-RUN] Would write docker-compose.yml, .env"
|
||||
echo "[DRY-RUN] Would open UFW ports for SIP/RTP/TURN"
|
||||
echo "[DRY-RUN] Would create $EA_DIR with Dockerfile, docker-compose.yml, .env"
|
||||
echo "[DRY-RUN] Would copy/download vendor files from easy-asterisk"
|
||||
echo "[DRY-RUN] Would open UFW ports: 5060, 5061, 8080, 8088, 8089, 3478, 10000-20000, 49152-49252"
|
||||
return 0
|
||||
fi
|
||||
|
||||
mkdir -p "$EA_DIR/docker" "$EA_DIR/scripts"
|
||||
mkdir -p "$EA_DIR"
|
||||
ensure_docker_dir_ownership "$EA_DIR"
|
||||
cd "$EA_DIR" || return 1
|
||||
|
||||
# ── Copy vendored source files ────────────────────────────────────────────
|
||||
log_info "Copying Easy Asterisk source files from vendor/..."
|
||||
mkdir -p docker
|
||||
|
||||
cp "$VENDOR_DIR/easy-asterisk-v0.10.0.sh" "$EA_DIR/easy-asterisk.sh"
|
||||
cp "$VENDOR_DIR/Dockerfile" "$EA_DIR/Dockerfile"
|
||||
cp "$VENDOR_DIR/docker/entrypoint.sh" "$EA_DIR/docker/entrypoint.sh"
|
||||
cp "$VENDOR_DIR/docker/coturn-entrypoint.sh" "$EA_DIR/docker/coturn-entrypoint.sh"
|
||||
cp "$VENDOR_DIR/scripts/vpn-diagnostics.sh" "$EA_DIR/scripts/vpn-diagnostics.sh"
|
||||
cp "$VENDOR_DIR/scripts/dns-whitelist.sh" "$EA_DIR/scripts/dns-whitelist.sh"
|
||||
# ── Vendor files ──────────────────────────────────────────────────────────
|
||||
local _SELF_DIR_LOCAL
|
||||
_SELF_DIR_LOCAL="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||
local VENDOR_DIR="$_SELF_DIR_LOCAL/../vendor/easy-asterisk"
|
||||
|
||||
chmod 750 "$EA_DIR/easy-asterisk.sh"
|
||||
chmod 755 "$EA_DIR/docker/entrypoint.sh" "$EA_DIR/docker/coturn-entrypoint.sh"
|
||||
chmod 755 "$EA_DIR/scripts/vpn-diagnostics.sh" "$EA_DIR/scripts/dns-whitelist.sh"
|
||||
|
||||
log_success "Source files copied"
|
||||
|
||||
# The Dockerfile COPYs easy-asterisk-v0.10.0.sh (the versioned name).
|
||||
# We keep easy-asterisk.sh as the canonical name and make a real copy
|
||||
# with the versioned filename so Docker COPY works reliably (no symlinks).
|
||||
cp "$EA_DIR/easy-asterisk.sh" "$EA_DIR/easy-asterisk-v0.10.0.sh"
|
||||
|
||||
# ── FQDN setup ────────────────────────────────────────────────────────────
|
||||
echo ""
|
||||
echo " Easy Asterisk can run in two modes:"
|
||||
echo ""
|
||||
echo " LAN/VPN — UDP transport, no TLS, no TURN."
|
||||
echo " Simple setup for devices on your local network or WireGuard/Tailscale."
|
||||
echo ""
|
||||
echo " FQDN — TLS + SRTP + coturn TURN relay."
|
||||
echo " Works from anywhere: LAN, cellular, hotel WiFi, Proton VPN."
|
||||
echo " Requires a domain name pointing to this server's public IP."
|
||||
echo ""
|
||||
|
||||
local DOMAIN_NAME=""
|
||||
prompt_text "FQDN for this server (e.g. asterisk.${SITE_DOMAIN:-example.com}) [blank for LAN-only]:" "" DOMAIN_NAME
|
||||
|
||||
local LAN_ONLY=false
|
||||
if [[ -z "$DOMAIN_NAME" ]]; then
|
||||
LAN_ONLY=true
|
||||
log_info "LAN/VPN-only mode — TLS and TURN disabled."
|
||||
if [[ -d "$VENDOR_DIR" ]]; then
|
||||
log_info "Copying vendor files from $VENDOR_DIR ..."
|
||||
cp "$VENDOR_DIR/Dockerfile" ./Dockerfile
|
||||
cp "$VENDOR_DIR/docker/entrypoint.sh" ./docker/entrypoint.sh
|
||||
cp "$VENDOR_DIR/docker/coturn-entrypoint.sh" ./docker/coturn-entrypoint.sh
|
||||
cp "$VENDOR_DIR/easy-asterisk-v0.10.0.sh" ./easy-asterisk.sh
|
||||
cp "$VENDOR_DIR/easy-asterisk-v0.10.0.sh" ./easy-asterisk-v0.10.0.sh
|
||||
else
|
||||
log_info "FQDN mode: $DOMAIN_NAME"
|
||||
echo ""
|
||||
echo " Required router port forwards:"
|
||||
printf " %-22s %s\n" "5061/tcp" "SIP TLS signaling"
|
||||
printf " %-22s %s\n" "3478/udp+tcp" "STUN/TURN (NAT traversal)"
|
||||
printf " %-22s %s\n" "10000-20000/udp" "RTP media (Asterisk)"
|
||||
printf " %-22s %s\n" "49152-49252/udp" "TURN relay range (coturn)"
|
||||
echo ""
|
||||
log_info "Vendor directory not found — downloading from GitHub ..."
|
||||
local GH_RAW="https://raw.githubusercontent.com/DeadDork/easy-asterisk/main"
|
||||
curl -fsSL "$GH_RAW/Dockerfile" -o ./Dockerfile
|
||||
curl -fsSL "$GH_RAW/docker/entrypoint.sh" -o ./docker/entrypoint.sh
|
||||
curl -fsSL "$GH_RAW/docker/coturn-entrypoint.sh" -o ./docker/coturn-entrypoint.sh
|
||||
curl -fsSL "$GH_RAW/easy-asterisk-v0.10.0.sh" -o ./easy-asterisk.sh
|
||||
cp ./easy-asterisk.sh ./easy-asterisk-v0.10.0.sh
|
||||
fi
|
||||
|
||||
# ── Generate TURN password ────────────────────────────────────────────────
|
||||
chmod 755 ./easy-asterisk.sh ./easy-asterisk-v0.10.0.sh \
|
||||
./docker/entrypoint.sh ./docker/coturn-entrypoint.sh
|
||||
|
||||
# ── Networking mode ───────────────────────────────────────────────────────
|
||||
echo ""
|
||||
echo " Networking mode:"
|
||||
echo " 1) LAN-only — no domain, self-signed cert, works on local network/VPN only"
|
||||
echo " 2) FQDN — TLS + TURN relay, works from anywhere (requires public domain)"
|
||||
local HA_NETMODE=""
|
||||
prompt_text "Choose [1]:" "1" HA_NETMODE
|
||||
|
||||
local DOMAIN_NAME=""
|
||||
if [[ "$HA_NETMODE" == "2" ]]; then
|
||||
prompt_text "FQDN (e.g. asterisk.${SITE_DOMAIN:-example.com}) [blank=skip]:" "" DOMAIN_NAME
|
||||
fi
|
||||
|
||||
# ── Secrets ───────────────────────────────────────────────────────────────
|
||||
local TURN_PASSWORD
|
||||
TURN_PASSWORD="$(openssl rand -base64 18 2>/dev/null | tr -dc 'a-zA-Z0-9' | head -c 24 \
|
||||
|| tr -dc 'A-Za-z0-9' </dev/urandom | head -c 24)"
|
||||
TURN_PASSWORD="$(generate_password 24)"
|
||||
|
||||
local TURN_SERVER_VAL=""
|
||||
[[ -n "$DOMAIN_NAME" ]] && TURN_SERVER_VAL="${DOMAIN_NAME}:3478"
|
||||
|
||||
# ── docker-compose.yml ────────────────────────────────────────────────────
|
||||
# Uses the real upstream Dockerfile (FROM ubuntu:24.04 + full Asterisk install)
|
||||
# with host networking for RTP/NAT, and the custom coturn entrypoint.
|
||||
cat > docker-compose.yml << 'COMPOSE_EOF'
|
||||
# Easy Asterisk — managed by ubuntu-post-install
|
||||
# Manage: docker exec -it easy-asterisk easy-asterisk
|
||||
# Source: https://github.com/outis1one/easy-asterisk
|
||||
cat > docker-compose.yml << 'EOF'
|
||||
name: asterisk
|
||||
|
||||
services:
|
||||
|
||||
asterisk:
|
||||
build:
|
||||
context: .
|
||||
dockerfile: Dockerfile
|
||||
build: .
|
||||
container_name: easy-asterisk
|
||||
# Host networking: required for RTP (10000-20000/udp) and proper NAT detection.
|
||||
# SIP clients connect directly to the host IP; Caddy is only used for the web admin.
|
||||
network_mode: host
|
||||
depends_on:
|
||||
coturn:
|
||||
@@ -264,23 +292,8 @@ services:
|
||||
- asterisk-logs:/var/log/asterisk
|
||||
- asterisk-spool:/var/spool/asterisk
|
||||
- asterisk-lib:/var/lib/asterisk
|
||||
# Bind-mount the management script so updates don't require a rebuild
|
||||
- ./easy-asterisk.sh:/usr/local/bin/easy-asterisk:ro
|
||||
environment:
|
||||
- DOMAIN_NAME=${DOMAIN_NAME}
|
||||
- ENABLE_TLS=${ENABLE_TLS:-y}
|
||||
- PUBLIC_IP=${PUBLIC_IP:-}
|
||||
- LOCAL_CIDR=${LOCAL_CIDR:-}
|
||||
- HAS_VLANS=${HAS_VLANS:-n}
|
||||
- VLAN_SUBNETS=${VLAN_SUBNETS:-}
|
||||
- TURN_ENABLED=${TURN_ENABLED:-y}
|
||||
- TURN_SERVER=${TURN_SERVER}
|
||||
- TURN_USERNAME=${TURN_USERNAME:-easyasterisk}
|
||||
- TURN_PASSWORD=${TURN_PASSWORD}
|
||||
- RTP_START=${RTP_START:-10000}
|
||||
- RTP_END=${RTP_END:-20000}
|
||||
- WEB_ADMIN_PORT=${WEB_ADMIN_PORT:-8080}
|
||||
- WEB_ADMIN_AUTH_DISABLED=${WEB_ADMIN_AUTH_DISABLED:-false}
|
||||
env_file: .env
|
||||
restart: unless-stopped
|
||||
healthcheck:
|
||||
test: ["CMD", "asterisk", "-rx", "core show version"]
|
||||
@@ -296,8 +309,7 @@ services:
|
||||
entrypoint: ["/coturn-entrypoint.sh"]
|
||||
volumes:
|
||||
- ./docker/coturn-entrypoint.sh:/coturn-entrypoint.sh:ro
|
||||
environment:
|
||||
- PUBLIC_IP=${PUBLIC_IP:-}
|
||||
env_file: .env
|
||||
command:
|
||||
- -n
|
||||
- --listening-port=${TURN_PORT:-3478}
|
||||
@@ -306,8 +318,8 @@ services:
|
||||
- --lt-cred-mech
|
||||
- --user=${TURN_USERNAME:-easyasterisk}:${TURN_PASSWORD}
|
||||
- --realm=${DOMAIN_NAME:-localhost}
|
||||
- --min-port=${TURN_RELAY_MIN:-49152}
|
||||
- --max-port=${TURN_RELAY_MAX:-49252}
|
||||
- --min-port=49152
|
||||
- --max-port=49252
|
||||
- --no-tls
|
||||
- --no-dtls
|
||||
- --no-cli
|
||||
@@ -321,185 +333,148 @@ volumes:
|
||||
asterisk-logs:
|
||||
asterisk-spool:
|
||||
asterisk-lib:
|
||||
COMPOSE_EOF
|
||||
EOF
|
||||
|
||||
# ── .env ─────────────────────────────────────────────────────────────────
|
||||
# ── .env ──────────────────────────────────────────────────────────────────
|
||||
cat > .env << ENV
|
||||
# Easy Asterisk — environment configuration
|
||||
# Edit and restart: docker compose down && docker compose up -d
|
||||
# ── Domain ────────────────────────────────────────────────────
|
||||
# Set to your FQDN for remote access. Leave empty for LAN-only.
|
||||
DOMAIN_NAME=${DOMAIN_NAME}
|
||||
|
||||
# FQDN pointing to this server's public IP (required for remote/TLS mode)
|
||||
DOMAIN_NAME=$DOMAIN_NAME
|
||||
|
||||
# Public IP — leave empty to auto-detect
|
||||
PUBLIC_IP=
|
||||
|
||||
# TLS — always 'y' for remote access, 'n' for LAN-only
|
||||
ENABLE_TLS=$( [[ "$LAN_ONLY" == "true" ]] && echo "n" || echo "y" )
|
||||
|
||||
# Local network CIDR — auto-detected if empty
|
||||
LOCAL_CIDR=
|
||||
|
||||
# Additional subnets for site-to-site VPNs (WireGuard/Tailscale mesh, NOT client-side)
|
||||
HAS_VLANS=n
|
||||
VLAN_SUBNETS=
|
||||
|
||||
# TURN/STUN credentials — must match in both Asterisk and coturn
|
||||
# Regenerate: openssl rand -base64 18 | tr -dc 'a-zA-Z0-9' | head -c 24
|
||||
# ── TURN/STUN ─────────────────────────────────────────────────
|
||||
TURN_USERNAME=easyasterisk
|
||||
TURN_PASSWORD=$TURN_PASSWORD
|
||||
|
||||
# TURN server address — auto-set based on FQDN or LAN mode above
|
||||
# LAN-only: leave empty (coturn not used). FQDN mode: domain:port
|
||||
TURN_SERVER=$( [[ "$LAN_ONLY" == "true" ]] && echo "" || echo "${DOMAIN_NAME}:3478" )
|
||||
|
||||
# TURN port (change to 3479 if 3478 conflicts with UniFi controller or Mattermost)
|
||||
TURN_PASSWORD=${TURN_PASSWORD}
|
||||
TURN_PORT=3478
|
||||
# For LAN-only: TURN_SERVER is empty. For FQDN: set to domain:3478
|
||||
TURN_SERVER=${TURN_SERVER_VAL}
|
||||
|
||||
# TURN relay port range — forward this range on your router
|
||||
TURN_RELAY_MIN=49152
|
||||
TURN_RELAY_MAX=49252
|
||||
|
||||
# RTP media port range — forward this range on your router
|
||||
# ── RTP port range ────────────────────────────────────────────
|
||||
RTP_START=10000
|
||||
RTP_END=20000
|
||||
|
||||
# Web admin interface
|
||||
# ── Web admin ─────────────────────────────────────────────────
|
||||
WEB_ADMIN_PORT=8080
|
||||
WEB_ADMIN_AUTH_DISABLED=false
|
||||
ENV
|
||||
|
||||
chmod 600 .env
|
||||
chown "$ACTUAL_USER:$ACTUAL_USER" .env
|
||||
|
||||
# ── UFW firewall rules ────────────────────────────────────────────────────
|
||||
if command -v ufw >/dev/null 2>&1 && ufw status 2>/dev/null | grep -q "Status: active"; then
|
||||
log_info "Opening UFW ports for Asterisk..."
|
||||
ufw allow 5060/udp comment "Asterisk SIP UDP" >/dev/null
|
||||
ufw allow 5060/tcp comment "Asterisk SIP TCP" >/dev/null
|
||||
ufw allow 5061/tcp comment "Asterisk SIP TLS" >/dev/null
|
||||
ufw allow 8080/tcp comment "Asterisk web admin" >/dev/null
|
||||
ufw allow 8088/tcp comment "Asterisk HTTP provision" >/dev/null
|
||||
ufw allow 8089/tcp comment "Asterisk HTTPS provision" >/dev/null
|
||||
ufw allow 3478/udp comment "coturn STUN/TURN UDP" >/dev/null
|
||||
ufw allow 3478/tcp comment "coturn STUN/TURN TCP" >/dev/null
|
||||
ufw allow 10000:20000/udp comment "Asterisk RTP media" >/dev/null
|
||||
ufw allow 49152:49252/udp comment "coturn TURN relay" >/dev/null
|
||||
log_success "UFW rules added"
|
||||
else
|
||||
log_info "UFW not active — open these ports manually if needed:"
|
||||
log_info " 5060/udp+tcp, 5061/tcp"
|
||||
log_info " 8080/tcp (web admin), 8088/tcp, 8089/tcp (provisioning)"
|
||||
log_info " 3478/udp+tcp (STUN/TURN)"
|
||||
log_info " 10000-20000/udp (RTP), 49152-49252/udp (TURN relay)"
|
||||
if command -v ufw &>/dev/null; then
|
||||
log_info "Opening UFW ports for Asterisk + coturn..."
|
||||
ufw allow 5060/udp
|
||||
ufw allow 5060/tcp
|
||||
ufw allow 5061/tcp
|
||||
ufw allow 8080/tcp
|
||||
ufw allow 8088/tcp
|
||||
ufw allow 8089/tcp
|
||||
ufw allow 3478/udp
|
||||
ufw allow 3478/tcp
|
||||
ufw allow 10000:20000/udp
|
||||
ufw allow 49152:49252/udp
|
||||
log_success "UFW rules added."
|
||||
fi
|
||||
|
||||
chown -R "$ACTUAL_USER:$ACTUAL_USER" "$EA_DIR"
|
||||
|
||||
# ── Caddy for web admin (with optional Authelia SSO) ──────────────────────
|
||||
# The web admin has no built-in auth; let Authelia gate it if available.
|
||||
local EA_EXTRA_BLOCK=""
|
||||
# ── Caddy reverse proxy for web admin ─────────────────────────────────────
|
||||
local EXTRA_BLOCK=""
|
||||
if [ -d "$DOCKER_DIR/authelia" ]; then
|
||||
local _use_auth=""
|
||||
prompt_yn "Protect Asterisk web admin with Authelia SSO? (y/n):" "y" _use_auth
|
||||
if [[ "$_use_auth" =~ ^[Yy]$ ]]; then
|
||||
EA_EXTRA_BLOCK=" import authelia"
|
||||
# Tell Asterisk's web admin to skip its own auth — Authelia handles it
|
||||
sed -i "s/^WEB_ADMIN_AUTH_DISABLED=.*/WEB_ADMIN_AUTH_DISABLED=true/" "$EA_DIR/.env"
|
||||
log_info "WEB_ADMIN_AUTH_DISABLED=true set (Authelia will handle authentication)"
|
||||
EXTRA_BLOCK=" import authelia"
|
||||
# Disable built-in auth since Authelia handles it
|
||||
sed -i "s/^WEB_ADMIN_AUTH_DISABLED=.*/WEB_ADMIN_AUTH_DISABLED=true/" .env
|
||||
fi
|
||||
fi
|
||||
configure_caddy_for_service "Asterisk Web Admin" "localhost:8080" "asterisk" "$EA_EXTRA_BLOCK"
|
||||
configure_caddy_for_service "Asterisk Web Admin" "8080" "asterisk" "$EXTRA_BLOCK"
|
||||
|
||||
# ── README ────────────────────────────────────────────────────────────────
|
||||
write_readme "$EA_DIR" << MD
|
||||
# Easy Asterisk PBX
|
||||
write_readme "$EA_DIR" << 'MD'
|
||||
# Easy Asterisk PBX + coturn
|
||||
|
||||
Home intercom / VoIP system built on Asterisk with self-hosted coturn TURN server.
|
||||
Personal/home-lab use only. Source: https://github.com/outis1one/easy-asterisk
|
||||
|
||||
## Access
|
||||
- Web admin: http://localhost:8080/clients
|
||||
- FQDN: $( [[ -n "$DOMAIN_NAME" ]] && echo "$DOMAIN_NAME" || echo "(LAN-only — no domain)" )
|
||||
|
||||
## Management
|
||||
\`\`\`bash
|
||||
# Interactive management menu (add devices, provisioning, diagnostics)
|
||||
docker exec -it easy-asterisk easy-asterisk
|
||||
|
||||
# VPN diagnostics
|
||||
docker exec -it easy-asterisk vpn-diagnostics
|
||||
|
||||
# DNS whitelist check
|
||||
docker exec -it easy-asterisk dns-whitelist
|
||||
\`\`\`
|
||||
|
||||
## Adding devices
|
||||
Run the management menu → Device Management → Add device.
|
||||
Each device gets a SIP extension, password, and setup instructions
|
||||
for Linphone (remote provisioning) or Baresip (manual).
|
||||
|
||||
## Connection modes
|
||||
- **LAN/VPN**: UDP, no encryption — local network or WireGuard/Tailscale
|
||||
- **FQDN**: TLS + SRTP + coturn TURN relay — works from anywhere
|
||||
|
||||
## Caddy and phone calls
|
||||
Asterisk uses **host networking** — SIP signaling and RTP media connect
|
||||
directly to the server, completely bypassing Caddy. Do NOT put SIP ports
|
||||
behind a reverse proxy (Contact header rewriting will break registration).
|
||||
|
||||
Caddy only handles the **web admin** (port 8080) for HTTPS browser access.
|
||||
|
||||
The **provisioning server** (ports 8088/8089) is Asterisk's built-in HTTP
|
||||
server for Linphone XML config delivery. Access it directly by IP/domain,
|
||||
not through Caddy — SIP clients fetch it at startup before registering.
|
||||
|
||||
## Router port forwards (FQDN mode)
|
||||
| Port | Protocol | Service |
|
||||
|------|----------|---------|
|
||||
| 5061 | TCP | SIP TLS signaling |
|
||||
| 3478 | UDP+TCP | STUN/TURN |
|
||||
| 10000-20000 | UDP | RTP media |
|
||||
| 49152-49252 | UDP | TURN relay |
|
||||
| 8088 | TCP | Provisioning (Linphone XML) — optional |
|
||||
|
||||
## TURN credentials (for SIP clients behind strict NAT)
|
||||
- Server: \${DOMAIN_NAME}:3478
|
||||
- Username: easyasterisk
|
||||
- Password: (see .env → TURN_PASSWORD)
|
||||
Self-hosted SIP PBX using Easy Asterisk with a coturn TURN/STUN server for
|
||||
NAT traversal. Suitable for home intercom, VoIP handsets, and softphones.
|
||||
|
||||
## Manage
|
||||
\`\`\`bash
|
||||
cd $EA_DIR
|
||||
docker compose up -d # start
|
||||
docker compose down # stop
|
||||
docker compose logs -f # logs
|
||||
docker compose pull # update coturn image
|
||||
docker compose build --pull && docker compose up -d # rebuild Asterisk image
|
||||
\`\`\`
|
||||
|
||||
```bash
|
||||
docker compose up -d --build # build image and start
|
||||
docker compose up -d # start (after initial build)
|
||||
docker compose down # stop
|
||||
docker compose logs -f # follow logs
|
||||
docker compose pull # update coturn image
|
||||
docker compose up -d --build # rebuild asterisk image
|
||||
```
|
||||
|
||||
## Management script
|
||||
|
||||
```bash
|
||||
docker exec -it easy-asterisk easy-asterisk --help
|
||||
```
|
||||
|
||||
## SIP client setup
|
||||
|
||||
| Setting | Value |
|
||||
|-----------------|--------------------------------------|
|
||||
| SIP server | <host-ip> (LAN) or your FQDN (FQDN) |
|
||||
| SIP port | 5061 (TLS) / 5060 (UDP) |
|
||||
| TURN server | <DOMAIN_NAME>:3478 (FQDN mode only) |
|
||||
| TURN username | easyasterisk |
|
||||
| TURN password | see .env → TURN_PASSWORD |
|
||||
|
||||
Recommended softphones: Linphone, Zoiper, Bria, Grandstream Wave.
|
||||
|
||||
## Web admin
|
||||
|
||||
Access the Easy Asterisk web interface at http://<host-ip>:8080
|
||||
or via your configured reverse-proxy domain.
|
||||
|
||||
## Volumes
|
||||
|
||||
| Volume | Contents |
|
||||
|----------------------|-------------------------------|
|
||||
| asterisk-config | /etc/asterisk — dialplan, SIP |
|
||||
| easy-asterisk-config | /etc/easy-asterisk — web config|
|
||||
| asterisk-logs | /var/log/asterisk |
|
||||
| asterisk-spool | /var/spool/asterisk |
|
||||
| asterisk-lib | /var/lib/asterisk |
|
||||
|
||||
## Ports
|
||||
|
||||
| Port | Protocol | Purpose |
|
||||
|---------------|----------|----------------------------------|
|
||||
| 5060 | UDP/TCP | SIP signalling (unencrypted) |
|
||||
| 5061 | TCP | SIP over TLS |
|
||||
| 8080 | TCP | Easy Asterisk web admin |
|
||||
| 8088/8089 | TCP | Asterisk HTTP/WS (ARI/AMI) |
|
||||
| 3478 | UDP/TCP | TURN/STUN (coturn) |
|
||||
| 10000–20000 | UDP | RTP media streams |
|
||||
| 49152–49252 | UDP | TURN relay media ports |
|
||||
MD
|
||||
|
||||
# ── Build and start ───────────────────────────────────────────────────────
|
||||
# ── Start ─────────────────────────────────────────────────────────────────
|
||||
echo ""
|
||||
local START_EA=""
|
||||
prompt_yn "Build and start Easy Asterisk now? (y/n):" "y" START_EA
|
||||
if [[ "$START_EA" =~ ^[Yy]$ ]]; then
|
||||
log_info "Building Asterisk image (first build takes a few minutes)..."
|
||||
if docker compose build --pull 2>&1 | tail -5; then
|
||||
if docker compose up -d; then
|
||||
log_success "Easy Asterisk started"
|
||||
echo ""
|
||||
echo " Web admin: http://localhost:8080/clients"
|
||||
echo " Management: docker exec -it easy-asterisk easy-asterisk"
|
||||
echo ""
|
||||
log_info "Next: add your first device via the management menu."
|
||||
else
|
||||
log_warning "Start failed — check: docker compose logs"
|
||||
fi
|
||||
else
|
||||
log_warning "Build failed — check output above"
|
||||
fi
|
||||
local START_NOW=""
|
||||
prompt_yn "Build and start Asterisk now? (y/n):" "y" START_NOW
|
||||
if [ "$START_NOW" = "y" ] || [ "$START_NOW" = "Y" ]; then
|
||||
docker compose up -d --build \
|
||||
&& log_success "Easy Asterisk started" \
|
||||
|| log_warning "Start failed — check: docker compose logs"
|
||||
fi
|
||||
|
||||
# ── Summary ───────────────────────────────────────────────────────────────
|
||||
echo ""
|
||||
log_success "Easy Asterisk installed at $EA_DIR"
|
||||
if [[ -n "$DOMAIN_NAME" ]]; then
|
||||
echo " Mode: FQDN ($DOMAIN_NAME)"
|
||||
echo " TURN server: ${DOMAIN_NAME}:3478"
|
||||
else
|
||||
echo " Mode: LAN-only"
|
||||
echo " TURN server: (none — LAN/VPN only)"
|
||||
fi
|
||||
echo " SIP port: 5061 (TLS) / 5060 (UDP)"
|
||||
echo " Web admin: http://$(hostname -I 2>/dev/null | awk '{print $1}' || echo localhost):8080"
|
||||
echo " Manage: docker compose -f $EA_DIR/docker-compose.yml <up|down|logs>"
|
||||
echo " Script: docker exec -it easy-asterisk easy-asterisk --help"
|
||||
echo ""
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user