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的核心，提供核心功能。
• 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：如使用独立数据库实例：
  • 确保以下OpenWISP容器可访问数据库实例：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. 将chromedriver解压到$PATH中的目录（例如：/usr/bin/）。

   • 设置geckodriver：

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

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

3. （可选）配置：打开tests/config.json并按需求配置变量，选项如下：

      driver                 : Selenium驱动名称，"chromium"或"firefox"
      logs                   : 发生错误时打印容器日志
      logs_file              : 保存测试日志的文件位置
      headless               : 以无头模式运行Selenium 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：停止服务器上的Make容器。
• 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，运行测试用例但不停止容器，便于调试和分析失败容器的日志。