openwisp/openwisp-websocket

Docker-OpenWISP

https://github.com/openwisp/docker-openwisp/workflows/Automation%20Tests/badge.svg](https://github.com/openwisp/docker-openwisp/actions?query=workflow%3A%22Automation+Tests%22) ![GitLab容器仓库]([] ![Gitter]([] ![支持]([***]

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

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

可用镜像

* 大致会提供相同的功能，但并非精确的一对一映射。

部署

快速设置

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

如果您已创建 .env 文件 来配置实例，则可以将其与脚本一起使用，否则...

它会询问6个应用配置问题，其中4个是域名。 仪表板、API、Radius和Open可以设置在不同的域名上，请确保您输入的域名指向您的服务器。其余2个问题是地址，分别用于站点管理员***（Django用于发送应用邮件）和Let's Encrypt（由 certbot 用于通过此地址签发HTTPS证书）。

开始使用，请运行以下命令：

bash
   curl -L https://tiny.cc/autoinstall-ow-docker -o setup.sh
   sudo bash setup.sh

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

Compose部署

Docker Compose设置 适用于单服务器部署需求。它更快捷，且不需要太多关于OpenWISP和网络的预先知识。

Kubernetes部署

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

• 裸金属
• 谷歌云

定制

工作区设置

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包进行构建，然后在 .build.env 文件中以 <variable>=<value> 格式设置变量。多个变量应换行分隔。可更改的变量如下：

• 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-controller源，您的 .build.env 应如下所示：

DJANGO_SOURCE=django==2.1
OPENWISP_CONTROLLER_SOURCE=https://github.com/<username>/openwisp-api/tarball/master

禁用服务

目前，这只是暂定指南。可能存在错误。请在 Gitter频道 报告错误。

• openwisp-dashboard：无法禁用openwisp-dashboard。它是OpenWISP的核心，执行核心功能。
• openwisp-api：无法禁用openwisp-api。它是与设备交互所必需的。
• openwisp-websocket：移除此容器会导致系统无法更新移动设备的实时位置。

如果要禁用某个服务，只需移除该服务的容器即可，但某些镜像需要额外步骤：

• openwisp-network-topology：将 USE_OPENWISP_TOPOLOGY 变量设置为 False。
• openwisp-firmware-upgrader：将 USE_OPENWISP_FIRMWARE 变量设置为 False。
• openwisp-radius：将 USE_OPENWISP_RADIUS 变量设置为 False。
• openwisp-postgres：如果使用独立数据库实例：
  • 确保以下OpenWISP容器可以访问数据库实例：openvpn、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：
  • 确保OpenWISP容器可以访问您的SMTP实例。
  • 更改 邮件配置变量 以指向您的实例。

运行测试

您可以使用 geckodriver（Firefox）或 chromedriver（Chromium）运行测试。Chromium是首选，因为它还会检查控制台日志错误。

1. 为Selenium设置驱动：

   • 设置chromedriver

     1. 安装：sudo apt --yes install chromium
     2. 检查版本：chromium --version
     3. 安装对应版本的驱动：https://chromedriver.chromium.org/downloads
     4. 将chromedriver提取到 $PATH 中的某个目录（例如：/usr/bin/）。

   • 设置geckodriver

     1. 安装：sudo apt --yes install firefox
     2. 检查版本：firefox --version
     3. 安装对应版本的驱动：https://github.com/mozilla/geckodriver/releases
     4. 将geckodriver提取到 $PATH 中的某个目录（例如：/usr/bin/）。

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

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

   yaml
      driver                 : 用于测试的驱动名称，"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，运行测试用例，但测试后不停止容器，这可能便于调试和分析失败容器的日志。