记录一次搭建Matrix，使用Ansible搭建Synapse服务端+Element Web/Cinny客户端

1. Ansible

• 一个开源的自动化工具，用于配置管理、应用部署、云服务编排等 IT 自动化任务
• 使用 Python 开发，采用 YAML 语法编写任务

2. Inventory (清单)

• 定义要管理的主机列表和主机组
• 可以是静态文件(通常是 /etc/ansible/hosts)或动态生成
• 支持定义主机变量和组变量

3. Playbook (剧本)

• Ansible 的配置、部署和编排语言
• 使用 YAML 格式编写
• 描述了一系列要在远程主机上执行的任务

4. Task (任务)

• Playbook 中的基本执行单元
• 定义一个具体的操作，如安装包、复制文件等
• 每个任务会调用一个 Ansible 模块

5. Module (模块)

• Ansible 的功能执行单元
• 内置了大量模块，如:
  • apt/yum: 包管理
  • copy: 文件复制
  • service: 服务管理
  • template: 模板处理

6. Role (角色)

• 将 Playbook 组织成可重用的组件
• 包含完成特定功能所需的所有文件和配置
• 标准结构包含: tasks、handlers、files、templates、vars、defaults、meta

7. Handler (处理器)

• 特殊的任务，只在被通知时执行
• 通常用于服务重启等操作
• 由 task 通过 notify 触发

8. Variable (变量)

• 可在 Playbook 中使用的动态值
• 来源多样: inventory、playbook、role、命令行等
• 支持不同优先级和作用域

9. Fact (事实)

• 通过 ansible 自动收集的目标主机信息
• 包括操作系统、硬件、网络等系统信息
• 可在 Playbook 中使用这些信息做条件判断

10. Control Node (控制节点)

• 安装 Ansible 的主机
• 负责执行自动化任务
• 通过 SSH 连接管理其他节点

11. Managed Node (被管理节点)

• 被 Ansible 管理的远程主机
• 一般只需要支持 SSH 和 Python
• 不需要安装专门的客户端软件

12. 插件 (Plugin)

• 扩展 Ansible 功能的组件
• 类型包括:
  • Connection: 连接插件
  • Callback: 回调插件
  • Filter: 过滤器插件
  • 等等

13. Collection (集合)

• Ansible 内容的分发格式
• 包含 playbook、角色、模块和插件
• 可通过 ansible-galaxy 管理

14. Vault (保险库)

• 用于加密敏感数据
• 可加密整个文件或单个变量
• 保护密码、密钥等敏感信息

如果ssh key还有密码，使用ssh-agent来管理密钥和密码：

# 启动ssh-agent
eval $(ssh-agent)

# 添加密钥到ssh-agent
ssh-add ~/.ssh/matrix_server_key

# 此时会要求输入一次密码，之后就不需要再输入了
# 将ssh-agent启动命令添加到~/.bashrc：
echo 'eval $(ssh-agent) > /dev/null' >> ~/.bashrc

如果重启服务器后需要重新执行:

ssh-add ~/.ssh/matrix_server_key

限制上传大小

# 限制最大上传大小之类，还可以添加数据库备份等设置
matrix_synapse_max_upload_size_mb: 10

管理机器人,我使用pantalaimon不能正常运行，不知道为什么

matrix_bot_draupnir_enabled: true
matrix_bot_draupnir_access_token: "修改"  # 在无痕浏览器打开element web获取后，不要登出，直接关闭窗口
matrix_bot_draupnir_management_room: "修改"

chatgpt机器人baibot

matrix_bot_baibot_enabled: true
matrix_bot_baibot_config_user_password: '生成强密码'
matrix_bot_baibot_config_user_encryption_recovery_passphrase: '编写'
matrix_bot_baibot_config_persistence_session_encryption_key: '生成强密码'
matrix_bot_baibot_config_persistence_config_encryption_key: '生成强密码'
matrix_admin: '@l1angth6:{{ matrix_domain }}'

Matrix Corporal,用来限制用户权限，比如创建房间。

Matrix Corporal添加允许私聊管理员配置，未测试

1. 备份脚本 (backup_matrix.sh)

这个脚本会将 Inventory 配置、SSH 密钥 和 Vault 密码文件 打包成一个带有日期的压缩包。

#!/bin/bash

# --- 配置部分 ---
BACKUP_DIR="$HOME/matrix_backups"     # 备份存放目录
PROJECT_DIR="$HOME/matrix-docker-ansible-deploy" # 项目所在目录
DATE=$(date +%Y%m%d_%H%M%S)           # 时间戳
OUTPUT_FILE="$BACKUP_DIR/matrix_ansible_backup_$DATE.tar.gz"

# --- 准备工作 ---
mkdir -p "$BACKUP_DIR"
echo "正在开始备份..."

# --- 核心备份命令 ---
# 说明：
# 1. matrix项目下的 inventory 文件夹 (服务器配置)
# 2. .ssh 目录下的特定密钥 matrix_server_key 和 config (如果存在)
# 3. .vault_pass 文件 (密码文件)
# 4. ansible.cfg

tar -czvf "$OUTPUT_FILE" \
    -C "$HOME" "matrix-docker-ansible-deploy/inventory" \
    -C "$HOME" ".ssh/matrix_server_key" 2>/dev/null \
    -C "$HOME" ".ssh/matrix_server_key.pub" 2>/dev/null \
    -C "$HOME" ".ssh/config" 2>/dev/null \
    -C "$HOME" ".vault_pass" 2>/dev/null \
    -C "$HOME" "matrix-docker-ansible-deploy/ansible.cfg" 2>/dev/null || true

# 检查结果
if [ -f "$OUTPUT_FILE" ]; then
    echo "------------------------------------------------"
    echo "✅ 备份成功！"
    echo "文件位置: $OUTPUT_FILE"
    echo "包含密钥: matrix_server_key (如果存在)"
    echo "------------------------------------------------"
else
    echo "❌ 备份失败，可能是没有找到文件。"
fi

2. 恢复脚本 (restore_matrix.sh)

这个脚本用于在新 VPS 上运行。它会自动拉取最新的项目代码（如果还没拉取），解压配置文件，并自动修复 SSH 密钥权限。

#!/bin/bash

# 检查参数
if [ -z "$1" ]; then
    echo "❌ 错误: 请指定备份文件路径。"
    echo "用法: ./restore_matrix_ansible.sh <备份文件.tar.gz>"
    exit 1
fi

BACKUP_FILE="$1"
PROJECT_DIR="$HOME/matrix-docker-ansible-deploy"

# ==========================================
# 1. 交互式环境检测与安装
# ==========================================
echo "🔍 正在检查环境依赖..."

# 定义需要检查的工具
NEEDED_CMDS="git python3 pip3 ansible sshpass"
MISSING_CMDS=""

for cmd in $NEEDED_CMDS; do
    if ! command -v "$cmd" &> /dev/null; then
        MISSING_CMDS="$MISSING_CMDS $cmd"
    fi
done

if [ -n "$MISSING_CMDS" ]; then
    echo "⚠️  检测到缺少以下工具:$MISSING_CMDS"
    read -p "❓ 是否尝试自动安装这些工具 (apt/pip)? [y/N] " response
    if [[ "$response" =~ ^[yY]$ ]]; then
        echo "⬇️  正在安装基础工具..."
        apt update
        apt install -y git python3 python3-pip sshpass
        
        # 检查 Ansible 是否安装 (有时 apt 源里的 ansible 版本太老，推荐 pip，但也可用 apt)
        if ! command -v ansible &> /dev/null; then
             echo "⬇️  正在通过 apt 安装 Ansible..."
             apt install -y ansible
        fi
        
        # 再次检查
        if ! command -v git &> /dev/null; then
            echo "❌ 安装失败，请手动安装 git 后重试。"
            exit 1
        fi
    else
        echo "❌ 用户取消安装，脚本退出。"
        exit 1
    fi
else
    echo "✅ 所有基础依赖检查通过。"
fi

# ==========================================
# 2. 拉取项目代码 (版本处理)
# ==========================================
if [ ! -d "$PROJECT_DIR" ]; then
    echo "⬇️  正在克隆最新版 Matrix Ansible 代码..."
    git clone https://github.com/spantaleev/matrix-docker-ansible-deploy.git "$PROJECT_DIR"
    echo "ℹ️  注意：已拉取最新版代码。如果因版本差异导致运行报错，请查阅项目 Changelog。"
else
    echo "📂 项目目录已存在，跳过克隆。"
fi

# ==========================================
# 3. 解压与恢复
# ==========================================
echo "📦 正在解压备份文件..."
TEMP_DIR=$(mktemp -d)
tar -xzvf "$BACKUP_FILE" -C "$TEMP_DIR" > /dev/null 2>&1

# --- 恢复 Inventory (智能查找路径) ---
echo "⚙️  正在恢复配置文件..."
# 无论备份时带不带项目文件夹，都能找到 host_vars 的上级目录
SOURCE_INVENTORY=$(find "$TEMP_DIR" -type d -name "host_vars" | head -n 1 | xargs dirname)

if [ -n "$SOURCE_INVENTORY" ] && [ -d "$SOURCE_INVENTORY" ]; then
    # 先清空目标 inventory，防止旧文件干扰
    # rm -rf "$PROJECT_DIR/inventory/*" 
    # (注：保留上面注释，建议覆盖而不是清空，以免误删 sample 文件)
    
    cp -r "$SOURCE_INVENTORY/"* "$PROJECT_DIR/inventory/"
    echo "✅ 配置已恢复。"
else
    echo "❌ 错误: 备份文件中未找到 inventory 数据！"
fi

# --- 恢复 Vault 密码 ---
if [ -f "$TEMP_DIR/.vault_pass" ]; then
    cp "$TEMP_DIR/.vault_pass" "$HOME/.vault_pass"
    echo "✅ Vault 密码已恢复。"
fi

# --- 恢复 Ansible 配置 ---
if [ -f "$TEMP_DIR/matrix-docker-ansible-deploy/ansible.cfg" ]; then
    cp "$TEMP_DIR/matrix-docker-ansible-deploy/ansible.cfg" "$PROJECT_DIR/ansible.cfg"
fi

# ==========================================
# 4. 恢复 SSH 密钥并强制修正权限
# ==========================================
echo "🔑 正在恢复 SSH 密钥..."
mkdir -p "$HOME/.ssh"

# 强制修正目录权限
chmod 700 "$HOME/.ssh"

KEY_RESTORED=false

# 恢复 matrix_server_key
if [ -f "$TEMP_DIR/.ssh/matrix_server_key" ]; then
    cp "$TEMP_DIR/.ssh/matrix_server_key"* "$HOME/.ssh/"
    
    # 强制修正文件权限 (回应你的问题1)
    chmod 600 "$HOME/.ssh/matrix_server_key"
    [ -f "$HOME/.ssh/matrix_server_key.pub" ] && chmod 644 "$HOME/.ssh/matrix_server_key.pub"
    
    KEY_RESTORED=true
    echo "✅ matrix_server_key 权限已修正为 600。"
fi

# 恢复 config
if [ -f "$TEMP_DIR/.ssh/config" ]; then
    cp "$TEMP_DIR/.ssh/config" "$HOME/.ssh/"
    chmod 644 "$HOME/.ssh/config"
    echo "✅ SSH config 已恢复。"
fi

# 兜底检查 id_ed25519 (以防万一备份的是默认名)
if [ -f "$TEMP_DIR/.ssh/id_ed25519" ]; then
    cp "$TEMP_DIR/.ssh/id_ed25519"* "$HOME/.ssh/"
    chmod 600 "$HOME/.ssh/id_ed25519"
    chmod 644 "$HOME/.ssh/id_ed25519.pub"
fi

if [ "$KEY_RESTORED" = false ]; then
    echo "⚠️  提示: 未在备份中找到 'matrix_server_key'。如果您使用密码或默认密钥登录，请忽略。"
fi

# ==========================================
# 5. 清理
# ==========================================
rm -rf "$TEMP_DIR"

echo "------------------------------------------------"
echo "🎉 迁移环境准备完成！"
echo "1. 进入目录: cd $PROJECT_DIR"
echo "2. 测试连接: ansible -i inventory/hosts all -m ping"
echo "------------------------------------------------"

如何使用

第一步：在旧 VPS 上备份

1. 创建并保存脚本：nano backup_matrix.sh # (粘贴上面的备份脚本内容，保存退出) chmod +x backup_matrix.sh
2. 运行脚本：./backup_matrix.sh
3. 它会生成类似 ~/matrix_backups/matrix_ansible_backup_20260201_120000.tar.gz 的文件。

第二步：转移文件

使用 scp 或 SFTP 将生成的 .tar.gz 文件下载到你电脑，再上传到新 VPS 的用户主目录（例如 /root/ 或 /home/username/）。

第三步：在新 VPS 上恢复

1. 创建并保存恢复脚本：nano restore_matrix.sh # (粘贴上面的恢复脚本内容，保存退出) chmod +x restore_matrix.sh
2. 运行脚本（后面跟上你的压缩包文件名）：./restore_matrix.sh matrix_ansible_backup_20260201_120000.tar.gz
3. 测试：ansible -i inventory/hosts all -m ping