Docker-OpenWISP

![自动化测试]([] ![GitLab容器仓库]([] ![Gitter]([] ![支持]([] ![GitHub许可证]([***]

本仓库包含OpenWISP的***Docker镜像，设计考虑了水平扩展、易于复制的部署和用户自定义需求。

!kubernetes Kubernetes部署的示例文件位于deployment-examples/kubernetes/目录中。

可用镜像

* 大致相同的功能可用，但并非精确一对一映射。

部署

快速设置

可使用auto-install.sh脚本在服务器上快速安装OpenWISP简单实例。

如果已创建.env文件配置实例，可与脚本一起使用；否则，脚本会引导配置。

脚本会提出6个应用配置问题，其中4个是域名：仪表板、API、Radius和Open可设置在不同域名，请确保输入的域名指向您的服务器。其余2个问题是电子邮件地址**，分别用于站点管理员**（Django用于发送应用邮件）和Let's Encrypt（certbot用于颁发HTTPS证书的联系地址）。

开始安装，运行以下命令：

   curl -L [***] -o setup.sh
   sudo bash setup.sh

注意：安装时遇到错误？请阅读FAQ。

Docker Compose

Docker Compose设置适用于单服务器部署需求，更快捷且对OpenWISP和网络知识要求较低。

Kubernetes

Kubernetes部署较复杂，需具备Linux系统、Kubernetes、Docker和OpenWISP的相关知识，但可为大型网络提供扩展性。

• 裸金属
• Google Cloud

自定义

工作台设置

1. 安装Docker和Docker Compose。
2. 在仓库根目录运行make develop，容器就绪后，可通过模块域名访问测试。

注意事项：

• 默认用户名和密码为admin。
• 默认域名：dashboard.openwisp.org、api.openwisp.org和radius.openwisp.org。
• 若要访问仪表板，可能需将.env中设置的OpenWISP域名添加到hosts文件，例如：bash -c 'echo "127.0.0.1 dashboard.openwisp.org api.openwisp.org radius.openwisp.org" >> /etc/hosts'
• 每次修改后需重新执行步骤2以重建镜像。
• 如需清理docker-openwisp生成的所有内容，可使用Makefile选项。

更改Python包

可通过在仓库根目录创建.build.env文件自定义Python包，文件格式为<变量>=<值>，多行分隔。支持的变量如下：

• OPENWISP_MONITORING_SOURCE
• OPENWISP_FIRMWARE_SOURCE
• OPENWISP_CONTROLLER_SOURCE
• OPENWISP_NOTIFICATION_SOURCE
• OPENWISP_TOPOLOGY_SOURCE
• OPENWISP_RADIUS_SOURCE
• OPENWISP_USERS_SOURCE
• OPENWISP_UTILS_SOURCE
• DJANGO_SOURCE
• DJANGO_NETJSONCONFIG_SOURCE
• DJANGO_X509_SOURCE

例如，若要自定义Django和OpenWISP控制器源，.build.env内容如下：

DJANGO_SOURCE=django==2.1
OPENWISP_CONTROLLER_SOURCE=[***]<用户名>/openwisp-api/tarball/master

禁用服务

当前为临时指南，可能存在错误。如有问题，请在Gitter频道报告。

• openwisp-dashboard：核心服务，不可禁用，提供核心功能。
• openwisp-api：不可禁用，用于与设备交互。
• openwisp-websocket：移除后无法更新移动设备的实时位置。

禁用服务通常可直接移除对应容器，但部分服务需额外步骤：

• openwisp-network-topology：设置USE_OPENWISP_TOPOLOGY=False。
• openwisp-firmware-upgrader：设置USE_OPENWISP_FIRMWARE=False。
• openwisp-monitoring：设置USE_OPENWISP_MONITORING=False。
• openwisp-radius：设置USE_OPENWISP_RADIUS=False。
• openwisp-postgres：若使用独立数据库实例：
  • 确保数据库可被以下容器访问：open***、freeradius、celerybeat、celery、websocket、radius、api、dashboard。
  • 确保数据库支持GeoDjango（PostgreSQL需安装PostGIS）。
  • 修改数据库配置变量指向实例，若使用SSL，需设置DB_SSLMODE、DB_SSLKEY、DB_SSLCERT、DB_SSLROOTCERT。
  • 若使用SSL，需挂载包含证书和密钥的卷到所有连接数据库的容器，并确保私钥权限为600且属主为root:root。
  • 在数据库中创建名为<DB_NAME>的数据库。
• openwisp-postfix：
  • 确保SMTP实例可被OpenWISP容器访问。
  • 修改电子邮件配置变量指向实例。

运行测试

可使用geckodriver（Firefox）或chromedriver（Chromium）运行测试，推荐Chromium，因其可检查控制台日志错误。

1. 设置Selenium驱动：

   • 设置chromedriver：

     1. 安装：sudo apt --yes install chromium
     2. 检查版本：chromium --version
     3. 安装对应版本驱动：[***]
     4. 解压驱动至$PATH目录（如/usr/bin/）。

   • 设置geckodriver：

     1. 安装：sudo apt --yes install firefox
     2. 检查版本：firefox --version
     3. 安装对应版本驱动：[***]
     4. 解压驱动至$PATH目录（如/usr/bin/）。

2. 安装Selenium：python3 -m pip install selenium

3. （可选）配置：编辑tests/config.json设置变量，选项如下：

      driver                 : 测试驱动名称，"chromium"或"firefox"
      logs                   : 错误时打印容器日志
      logs_file              : 测试日志保存路径
      headless               : 无头模式运行Chrome驱动
      load_init_data         : 数据库创建后是否运行tests/data.py（仅需一次）
      app_url                : 管理仪表板URL
      username               : 管理仪表板登录用户名
      password               : 管理仪表板登录密码
      services_max_retries   : 服务运行检查最大重试次数
      services_delay_retries : 服务运行检查重试间隔（秒）
   

4. 运行测试：make runtests

Makefile选项

常用选项：

• start<USER=docker-username> <TAG=image-tag>：在服务器启动OpenWISP容器。
• pull<USER=docker-username> <TAG=image-tag>：从仓库拉取镜像。
• stop：停止服务器上的容器。
• develop：捆绑构建镜像和运行容器的所有命令。
• runtests：运行测试以确保所有服务正常工作。
• clean：彻底清除与docker-openwisp相关的容器、镜像、卷和网络。

其他选项：

• publish <USER=docker-username> <TAG=image-tag>：构建、测试并发布镜像。
• python-build：生成随机Django密钥并设置到.env文件。
• nfs-build：构建openwisp-nfs服务器镜像。
• base-build：构建openwisp-base基础镜像（供其他OpenWISP镜像使用）。
• compose-build：（默认）构建开发用OpenWISP镜像。
• develop-runtests：类似runtests，但测试后不停止容器，便于调试和分析失败容器日志。