Skip to content

安装部署

本文档详细介绍 IPAM 系统的各种安装部署方式。

系统要求

最低配置

组件要求
CPU2核
内存4GB
磁盘20GB
网络内网访问

推荐配置

组件要求
CPU4核+
内存8GB+
磁盘50GB+ SSD
网络千兆以太网

下载程序

服务端下载

平台架构下载链接
Linuxamd64server_linux_amd64
Linuxarm64server_linux_arm64
Windowsamd64server_windows_amd64.exe
macOSamd64server_darwin_amd64
macOSarm64server_darwin_arm64

探针客户端下载

平台架构下载链接
Linuxamd64probe_linux_amd64
Linuxarm64probe_linux_arm64
Windowsamd64probe_windows_amd64.exe

部署方式

1. 二进制部署(推荐)

下载并安装

bash
# 创建安装目录
mkdir -p /opt/ipam
cd /opt/ipam

# 下载服务端(以 Linux amd64 为例)
wget https://download.liumou.site/ipam/server_linux_amd64 -O ipam-server
chmod +x ipam-server

# 生成配置文件模板
./ipam-server -g

# 编辑配置文件
vi config.toml

部署目录结构

/opt/ipam/
├── ipam-server          # 后端可执行文件
├── ipam-probe           # 探针客户端(可选)
├── config.toml          # 配置文件
└── logs/                # 日志目录

启动服务

bash
# 直接启动
./ipam-server

# 或使用 systemd 管理(见下文)

2. Docker 部署

2.1 一体化部署(推荐)

适合快速体验或小规模部署,前端文件嵌入在后端服务中,仅需一个容器。

yaml
services:
  db:
    image: mariadb:11
    environment:
      MYSQL_ROOT_PASSWORD: root_password
      MYSQL_DATABASE: ipam
      MYSQL_USER: ipam_user
      MYSQL_PASSWORD: ipam_password
    volumes:
      - db_data:/var/lib/mysql
    healthcheck:
      test: ["CMD", "healthcheck.sh", "--su-mysql", "--connect", "--innodb_initialized"]
      interval: 10s
      timeout: 5s
      retries: 5
      start_period: 30s
    networks:
      - ipam-network

  ipam:
    image: ccr.ccs.tencentyun.com/ipam-go/ipam:latest
    ports:
      - "${IPAM_PORT:-8080}:12389"
    volumes:
      - /etc/machine-id:/etc/machine-id:ro
      - ./config:/app/config
      - ./backup:/app/backup
      - ./logs:/app/logs
    environment:
      - DB_TYPE=mysql
      - DB_HOST=db
      - DB_PORT=3306
      - DB_USER=ipam_user
      - DB_PASSWORD=ipam_password
      - DB_NAME=ipam
      - JWT_SECRET=your_jwt_secret_change_me
    depends_on:
      db:
        condition: service_healthy
    networks:
      - ipam-network

volumes:
  db_data:

networks:
  ipam-network:
    name: ipam-network
    driver: bridge

启动:

bash
docker compose up -d

访问 http://localhost:8080 即可进入系统。

内置 Nginx 监听 80 端口,通过 IPAM_PORT 映射到宿主机(默认 8080)。 后端 Go 服务监听 127.0.0.1:12389,由同一容器内的 Nginx 反向代理。

2.2 前后端分离部署(高级)

适合生产环境,前端(Nginx + Vue 3)和后端(Go API)分别独立容器运行, 支持独立扩缩容和 network_mode: host

提供四种数据库版本选择:

数据库配置文件宿主端口
MySQLdocker-compose/seperate/docker-compose.mysql.yml前端 12380 / 后端 12389
MariaDBdocker-compose/seperate/docker-compose.mariadb.yml前端 12380 / 后端 12389
PostgreSQLdocker-compose/seperate/docker-compose.postgres.yml前端 12380 / 后端 12389
外部数据库docker-compose/seperate/docker-compose.external-db.yml前端 12380 / 后端 12389
bash
# MySQL 分离部署
docker compose -f docker-compose/seperate/docker-compose.mysql.yml up -d

# 外部数据库(通过 .env 文件配置 DB_TYPE 等参数)
docker compose --env-file .env \
  -f docker-compose/seperate/docker-compose.external-db.yml up -d

前后端分离版的前端 Nginx 默认监听 12380 端口(非 80), 后端 Go 服务默认监听 12389 端口。使用 network_mode: host 时无需端口映射即可直接访问。

前端 Nginx 模板支持 BACKEND_HOSTBACKEND_PORT 环境变量配置后端代理地址:

  • 默认值:BACKEND_HOST=ipam-backendBACKEND_PORT=12389
  • host 网络模式:设置 BACKEND_HOST=localhost
  • 可在 docker-composeenvironment.env 文件或 env.sh 中配置

镜像地址:

组件镜像
一体化ccr.ccs.tencentyun.com/ipam-go/ipam:latest
分离版后端ccr.ccs.tencentyun.com/ipam-go/backend:latest
分离版前端ccr.ccs.tencentyun.com/ipam-go/frontend:latest

3. systemd 服务部署

下载程序

bash
mkdir -p /opt/ipam
cd /opt/ipam

# 下载服务端
wget https://download.liumou.site/ipam/server_linux_amd64 -O ipam-server
chmod +x ipam-server

# 生成配置文件模板
./ipam-server -g

# 编辑配置文件
vi config.toml

创建服务文件

bash
sudo tee /etc/systemd/system/ipam.service > /dev/null <<EOF
[Unit]
Description=IPAM Server
After=network.target mysql.service

[Service]
Type=simple
User=ipam
Group=ipam
WorkingDirectory=/opt/ipam
ExecStart=/opt/ipam/ipam-server
Restart=on-failure
RestartSec=5
StandardOutput=journal
StandardError=journal

[Install]
WantedBy=multi-user.target
EOF

启动服务

bash
# 创建用户
sudo useradd -r -s /bin/false ipam

# 设置权限
sudo chown -R ipam:ipam /opt/ipam

# 启动服务
sudo systemctl daemon-reload
sudo systemctl enable ipam
sudo systemctl start ipam

# 查看状态
sudo systemctl status ipam

Nginx 反向代理

配置示例

nginx
server {
    listen 80;
    server_name ipam.example.com;
    
    # 重定向到 HTTPS
    return 301 https://$server_name$request_uri;
}

server {
    listen 443 ssl http2;
    server_name ipam.example.com;
    
    # SSL 证书
    ssl_certificate /path/to/cert.pem;
    ssl_certificate_key /path/to/key.pem;
    
    # 前端静态文件(已嵌入到服务端,直接代理到后端)
    location / {
        proxy_pass http://localhost:12389;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection 'upgrade';
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_cache_bypass $http_upgrade;
    }
    
    # API 代理
    location /api {
        proxy_pass http://localhost:12389;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection 'upgrade';
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_cache_bypass $http_upgrade;
    }
}

数据库配置

MySQL/MariaDB

sql
-- 创建数据库
CREATE DATABASE ipam CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;

-- 创建用户
CREATE USER 'ipam_user'@'%' IDENTIFIED BY 'strong_password';

-- 授权
GRANT ALL PRIVILEGES ON ipam.* TO 'ipam_user'@'%';

FLUSH PRIVILEGES;

性能优化

ini
# my.cnf
[mysqld]
character-set-server=utf8mb4
collation-server=utf8mb4_unicode_ci
max_connections=200
innodb_buffer_pool_size=512M
innodb_log_file_size=128M
query_cache_type=1
query_cache_size=64M

探针客户端部署

下载探针

bash
cd /opt/ipam

# 下载探针客户端(以 Linux amd64 为例)
wget https://download.liumou.site/ipam/probe_linux_amd64 -O ipam-probe
chmod +x ipam-probe

创建 systemd 服务

bash
sudo tee /etc/systemd/system/ipam-probe.service > /dev/null <<EOF
[Unit]
Description=IPAM Probe
After=network.target

[Service]
Type=simple
ExecStart=/opt/ipam/ipam-probe -server http://localhost:8080 -apikey YOUR_API_KEY -subnet 192.168.1.0/24
Restart=on-failure
RestartSec=10

[Install]
WantedBy=multi-user.target
EOF

# 启动服务
sudo systemctl daemon-reload
sudo systemctl enable ipam-probe
sudo systemctl start ipam-probe

备份策略

自动备份脚本

bash
#!/bin/bash
# backup.sh

BACKUP_DIR="/backup/ipam"
DATE=$(date +%Y%m%d_%H%M%S)
DB_NAME="ipam"
DB_USER="ipam_user"
DB_PASS="password"

# 创建备份目录
mkdir -p $BACKUP_DIR

# 备份数据库
mysqldump -u$DB_USER -p$DB_PASS $DB_NAME > $BACKUP_DIR/ipam_db_$DATE.sql

# 备份配置文件
tar czf $BACKUP_DIR/ipam_config_$DATE.tar.gz /opt/ipam/config.toml

# 保留最近 30 天的备份
find $BACKUP_DIR -name "*.sql" -mtime +30 -delete
find $BACKUP_DIR -name "*.tar.gz" -mtime +30 -delete

定时任务

bash
# 每天凌晨 2 点执行备份
0 2 * * * /opt/ipam/backup.sh >> /var/log/ipam_backup.log 2>&1

监控与日志

日志配置

toml
[monitoring]
enabled = true
interval = 30
gateway_timeout = 5
ip_timeout = 3
max_concurrent = 100
enable_host_scanning = false  # 分布式部署时保持 false

日志轮转

bash
# /etc/logrotate.d/ipam
/opt/ipam/logs/*.log {
    daily
    rotate 30
    compress
    delaycompress
    missingok
    notifempty
    create 0644 ipam ipam
}

安全建议

  1. 修改默认密码:首次登录后立即修改所有默认账户密码
  2. 使用 HTTPS:生产环境必须使用 HTTPS
  3. 防火墙配置:仅开放必要的端口
  4. 定期更新:及时更新系统和依赖
  5. 访问控制:限制管理后台访问IP
  6. 审计日志:启用操作审计功能

故障排查

服务无法启动

bash
# 检查日志
journalctl -u ipam -f

# 检查端口占用
netstat -tlnp | grep 8080

# 检查配置文件
cat /opt/ipam/config.toml

数据库连接失败

bash
# 测试数据库连接
mysql -u ipam_user -p -h localhost ipam

# 检查数据库服务
systemctl status mysql

探针无法连接

bash
# 检查探针日志
journalctl -u ipam-probe -f

# 验证 API 密钥
curl -H "X-API-Key: YOUR_API_KEY" http://localhost:8080/api/probe/validate-api-key

# 检查网络连通性
ping ipam-server

基于 MIT 许可发布