Add Docker Compose and Traefik configuration for Pangolin stack

This commit is contained in:
Peter Wood
2025-05-28 15:39:11 -04:00
parent f6dc32d427
commit e409bffbe5
5 changed files with 531 additions and 0 deletions

372
pangolin/add_domain.sh Executable file
View File

@@ -0,0 +1,372 @@
#!/bin/bash
# Script to add domains to Pangolin's config.yml file with validation and automatic restart
# Usage: ./add_domain.sh domain_name cert_resolver
# Set constants
readonly CONFIG_FILE="./config/config.yml"
readonly BACKUP_FILE="./config/config.yml.bak"
readonly DEFAULT_CERT_RESOLVER="letsencrypt"
# Colors for terminal output
readonly RED='\033[0;31m'
readonly GREEN='\033[0;32m'
readonly YELLOW='\033[0;33m'
readonly BLUE='\033[0;34m'
readonly NC='\033[0m' # No Color
# Logging functions
log_info() {
echo -e "${BLUE}[INFO]${NC} $1"
}
log_success() {
echo -e "${GREEN}[SUCCESS]${NC} $1"
}
log_warning() {
echo -e "${YELLOW}[WARNING]${NC} $1"
}
log_error() {
echo -e "${RED}[ERROR]${NC} $1"
}
# Function to check if a command exists
command_exists() {
command -v "$1" &> /dev/null
}
# Function to validate domain name format
validate_domain_format() {
local domain="$1"
# Check if the domain matches a basic domain format
if ! [[ "$domain" =~ ^[a-zA-Z0-9][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]\.[a-zA-Z]{2,}(\.[a-zA-Z]{2,})?$ ]]; then
log_error "Invalid domain format. Please enter a valid domain like 'example.com'"
return 1
fi
return 0
}
# Function to check DNS resolution - optimized to try tools in order of preference
check_dns_resolution() {
local domain="$1"
local ip=""
log_info "Checking if domain '$domain' is properly configured in DNS..."
# Use the best available DNS checking tool
if command_exists dig; then
ip=$(dig +short "$domain" A | head -1)
elif command_exists nslookup; then
ip=$(nslookup "$domain" | grep 'Address:' | tail -1 | awk '{print $2}')
elif command_exists host; then
log_warning "'dig' and 'nslookup' not found, using basic 'host' command which may be less reliable."
ip=$(host "$domain" | grep 'has address' | head -1 | awk '{print $4}')
else
log_warning "No DNS resolution tools found (dig, nslookup, or host). Skipping DNS check."
return 0
fi
if [[ -z "$ip" || ! "$ip" =~ ^[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
log_warning "Domain '$domain' does not resolve to an IP address."
log_warning "The domain should have an A or AAAA record pointing to your server IP address."
# Ask user if they want to proceed despite DNS warning
read -p "Do you want to proceed anyway? (y/n): " proceed
if [[ ! "$proceed" =~ ^[Yy]$ ]]; then
log_error "Operation canceled. Please configure DNS properly and try again."
return 1
fi
else
log_success "Domain '$domain' resolves to IP: $ip"
fi
return 0
}
# Function to validate a domain (format and DNS)
validate_domain() {
local domain="$1"
if ! validate_domain_format "$domain"; then
return 1
fi
if ! check_dns_resolution "$domain"; then
return 1
fi
return 0
}
# Function to check if the Pangolin stack is running
is_stack_running() {
docker compose ps | grep -q 'pangolin'
}
# Function to wait for stack to be ready - extracted to avoid code duplication
wait_for_stack() {
local timeout=30
local counter=0
log_info "Waiting for stack to be ready..."
while ((counter < timeout)); do
if docker compose ps | grep -q 'pangolin' && docker compose ps | grep -q -v 'starting'; then
log_success "Pangolin stack is ready!"
return 0
fi
echo -n "."
sleep 2
((counter+=1))
done
log_error "Timeout waiting for stack to be ready. Please check your logs."
return 1
}
# Function to restart the Pangolin stack
restart_stack() {
log_info "Restarting Pangolin stack..."
if is_stack_running; then
docker compose down
sleep 2
docker compose up -d
wait_for_stack
else
log_info "Pangolin stack wasn't running. Starting it now..."
docker compose up -d
wait_for_stack
fi
}
# Function to check if the domain already exists in the config
domain_exists() {
local domain="$1"
grep -q "base_domain: \"$domain\"" "$CONFIG_FILE"
}
# Function to get the next domain number
get_next_domain_number() {
local highest_num=0
# Find the highest domain number
while read -r line; do
if [[ "$line" =~ domain([0-9]+): ]]; then
num="${BASH_REMATCH[1]}"
if ((num > highest_num)); then
highest_num=$num
fi
fi
done < <(grep "^ domain[0-9]\+:" "$CONFIG_FILE")
echo $((highest_num + 1))
}
# Function to fix misplaced domains
fix_misplaced_domains() {
log_info "Checking for misplaced domain entries..."
# Check for misplaced domain entries outside the domains section
local misplaced=$(grep -n "domain[0-9]\+:" "$CONFIG_FILE" | grep -v "^[0-9]\+:domains:" | grep -v "^[0-9]\+: domain[0-9]\+:")
if [ -n "$misplaced" ]; then
log_warning "Found misplaced domain entries outside the domains section:"
echo "$misplaced"
# Ask user if they want to fix the misplaced domains
read -p "Do you want to fix these misplaced domains? (y/n): " fix_domains
if [[ "$fix_domains" =~ ^[Yy]$ ]]; then
log_info "Creating a fixed config file..."
# Extract all domain entries from the misplaced location
local extracted_domains=$(awk '
/^[[:space:]]+domain[0-9]+:/ && !/^[[:space:]]+domain[0-9]+:.*domains:/ {
in_domain = 1
domain_name = $0
print domain_name
next
}
in_domain == 1 && /^[[:space:]]+base_domain:/ {
base_domain = $0
print base_domain
next
}
in_domain == 1 && /^[[:space:]]+cert_resolver:/ {
cert_resolver = $0
print cert_resolver
in_domain = 0
next
}' "$CONFIG_FILE")
if [ -n "$extracted_domains" ]; then
log_info "Extracted domains:"
echo "$extracted_domains"
# Remove misplaced domains from the config
sed -i '/^[[:space:]]\+domain[0-9]\+:/,/^[[:space:]]\+cert_resolver:.*$/d' "$CONFIG_FILE"
# Check if domains section exists
if grep -q "^domains:" "$CONFIG_FILE"; then
log_info "Adding extracted domains to the domains section..."
# Find the end of the domains section
local domains_end=$(awk '/^domains:/{in_domains=1} in_domains==1 && /^[a-zA-Z][^:]*:/ && !/^domains:/{print NR-1; exit}' "$CONFIG_FILE")
if [ -z "$domains_end" ]; then
domains_end=$(wc -l < "$CONFIG_FILE")
fi
# Insert the extracted domains at the end of the domains section
sed -i "${domains_end}a\\$(echo "$extracted_domains" | sed 's/^/ /')" "$CONFIG_FILE"
else
log_info "Creating domains section with extracted domains..."
# Find a good spot to insert the domains section (after app section)
local app_end=$(awk '/^app:/{in_app=1} in_app==1 && /^[a-zA-Z][^:]*:/ && !/^app:/{print NR-1; exit}' "$CONFIG_FILE")
if [ -z "$app_end" ]; then
app_end=1
fi
# Insert the domains section with the extracted domains
sed -i "${app_end}a\\domains:\\$(echo "$extracted_domains" | sed 's/^/ /')" "$CONFIG_FILE"
fi
log_success "Fixed misplaced domains."
fi
fi
else
log_info "No misplaced domains found."
fi
}
# Function to add domain to config
add_domain_to_config() {
local domain="$1"
local cert_resolver="$2"
local next_domain_num
# Fix any misplaced domains first
fix_misplaced_domains
# Check if domains section already exists
if grep -q "^domains:" "$CONFIG_FILE"; then
log_info "Domains section exists. Finding the last domain entry..."
# Find the next domain number
next_domain_num=$(get_next_domain_number)
log_info "Using domain$next_domain_num for new entry"
# Find the end of the domains section
local domains_end=$(awk '/^domains:/{in_domains=1} in_domains==1 && /^[a-zA-Z][^:]*:/ && !/^domains:/{print NR-1; exit}' "$CONFIG_FILE")
if [ -z "$domains_end" ]; then
log_info "No next section found after domains, adding to end of file"
domains_end=$(wc -l < "$CONFIG_FILE")
fi
# Use sed to insert the new domain entry at the correct position
sed -i "${domains_end}i\\ domain${next_domain_num}:\\n base_domain: \"${domain}\"\\n cert_resolver: \"${cert_resolver}\"" "$CONFIG_FILE"
else
# Domains section does not exist, need to add it
log_info "Domains section does not exist. Creating it..."
# Find the line where the app section ends
local app_end=$(awk '/^app:/{app=1} app==1 && /^[a-zA-Z][^:]*:/{if($0 !~ /^app:/) {print NR-1; exit}}' "$CONFIG_FILE")
if [ -z "$app_end" ]; then
log_info "Could not find end of app section, adding domains after first blank line"
# Find first blank line
local blank_line=$(grep -n "^$" "$CONFIG_FILE" | head -1 | cut -d: -f1)
if [ -z "$blank_line" ]; then
log_info "No blank line found, adding domains at end of file"
app_end=$(wc -l < "$CONFIG_FILE")
else
log_info "Found blank line at $blank_line, adding domains after it"
app_end=$blank_line
fi
fi
# Use sed to insert the domains section
sed -i "${app_end}a\\\\ndomains:\\n domain1:\\n base_domain: \"${domain}\"\\n cert_resolver: \"${cert_resolver}\"" "$CONFIG_FILE"
next_domain_num=1
fi
# Verify the change was made
log_info "Checking if domain was added:"
grep -A2 -n "domain${next_domain_num}:" "$CONFIG_FILE"
if grep -q "domain${next_domain_num}:" "$CONFIG_FILE" && \
grep -q "base_domain: \"${domain}\"" "$CONFIG_FILE" && \
grep -q "cert_resolver: \"${cert_resolver}\"" "$CONFIG_FILE"; then
log_success "Added domain$next_domain_num: $domain with cert_resolver: $cert_resolver"
return 0
else
log_error "Failed to add domain $domain. Please check the config file manually."
return 1
fi
}
# Main execution starts here
# Check if arguments are provided
if [ $# -lt 1 ]; then
log_error "Missing required arguments."
echo -e "${BLUE}Usage: $0 domain_name [cert_resolver]${NC}"
echo -e "${BLUE}Example: $0 example.com letsencrypt${NC}"
exit 1
fi
# Set domain name from first argument
DOMAIN_NAME=$1
# Set cert resolver from second argument or default
CERT_RESOLVER=${2:-$DEFAULT_CERT_RESOLVER}
# Validate domain
if ! validate_domain "$DOMAIN_NAME"; then
exit 1
fi
# Check if config file exists
if [ ! -f "$CONFIG_FILE" ]; then
log_error "Config file not found at $CONFIG_FILE"
exit 1
fi
# Create backup of config file
cp "$CONFIG_FILE" "$BACKUP_FILE"
log_success "Created backup at $BACKUP_FILE"
# Check if the domain already exists in the config
if domain_exists "$DOMAIN_NAME"; then
log_error "Domain '$DOMAIN_NAME' already exists in the config."
exit 1
fi
# Add domain to config
if ! add_domain_to_config "$DOMAIN_NAME" "$CERT_RESOLVER"; then
log_error "Failed to add domain to config. Reverting changes..."
cp "$BACKUP_FILE" "$CONFIG_FILE"
exit 1
fi
# Ask for confirmation before restarting the stack
log_info "Configuration has been updated."
read -p "Do you want to restart the Pangolin stack now? (y/n): " restart_confirm
if [[ "$restart_confirm" =~ ^[Yy]$ ]]; then
restart_stack
else
log_warning "Stack not restarted. Remember to restart manually for changes to take effect:"
log_info "docker compose down && docker compose up -d"
fi
log_success "Domain $DOMAIN_NAME has been successfully added to the configuration."