nervesjp/nerves

docker-nerves

概述和主要用途

Nerves 是一个基于函数式语言 Elixir 的新兴且出色的IoT框架。

本Dockerfile能让您通过最少步骤获取Nerves开发环境。该Docker解决方案具有以下优势：

• 若您是Nerves新手，可轻松尝试其开发；由于能提供统一环境，便于开展实操培训。
• 即便您已在使用Nerves，也能快速测试最新开发环境，且Docker不会影响您的主机环境。
• https://hub.docker.com/r/nervesjp/nerves 发布了预构建镜像，只需拉取即可立即试用（但可能并非始终为最新版本）。

您还可通过Visual Studio Code及其扩展获得更优的开发体验。 了解更多信息： https://github.com/NervesJP/nerves-devcontainer

核心功能和特性

• 快速部署：提供预构建镜像，无需手动配置即可快速启动开发环境
• 环境隔离：不干扰主机系统配置，安全测试不同版本环境
• 灵活性：支持本地构建和自定义镜像，满足个性化需求
• 兼容性：集成Nerves开发所需的全套工具链（Erlang/OTP、Elixir、Nerves组件等）

使用场景和适用范围

• Nerves新手入门学习和环境搭建
• 开发团队统一培训环境部署
• 已有Nerves用户测试新版本工具链
• 需要隔离开发环境的场景

详细使用方法和配置说明

快速开始

从 https://hub.docker.com/r/nervesjp/nerves

您可以使用预构建镜像尝试Nerves开发：

bash
$ docker pull nervesjp/nerves
$ docker run -it -w /workspace nervesjp/nerves
root@6e304327bd2e:/workspace#

从 https://github.com/NervesJP/docker-nerves

您可以本地构建Docker镜像并根据需求自定义：

bash
$ git clone https://github.com/NervesJP/docker-nerves
$ cd docker-nerves

$ docker build -t docker-nerves .

$ docker run -it -w /workspace docker-nerves
root@9bc88d0fc7b8:/workspace# pwd
/workspace

root@9bc88d0fc7b8:/workspace# echo ${HOME}
/root

root@9bc88d0fc7b8:/workspace# ls ~/.mix/*
/root/.mix/rebar  /root/.mix/rebar3

/root/.mix/archives:
hex-0.21.2  nerves_bootstrap-1.10.2

已安装的工具/版本说明

下表列出了Docker Hub上预构建镜像的工具版本。若您本地构建Docker容器，请通过括号中的方法检查版本。粗体表示与上一版本相比的更新。

使用技巧

本仓库旨在提供最小化和最通用的功能，您可根据需要自定义Dockerfile。如有通用有用的改进建议，欢迎通过Issue或PR提出。以下是一些使用Nerves Docker环境的便捷方法。Docker提供了许多CLI选项功能。

挂载主机卷

由于Docker镜像内的文件系统会在镜像重建/执行时消失，挂载主机卷来保存Nerves项目文件非常有用。-v ${PWD}:/workspace 可将主机当前目录挂载到Docker镜像中：

bash
$ docker run -it -w /workspace -v ${PWD}:/workspace docker-nerves

挂载Elixir/Nerves相关的配置目录（如 .hex/、.nerves/ 和 .ssh/）也很高效。以下示例将主机和镜像的 ${HOME} 中的配置文件进行绑定：

bash
$ docker run -it -w /workspace -v ${PWD}:/workspace \
  -v ~/.hex:/root/.hex -v ~/.nerves:/root/.nerves -v ~/.ssh:/root/.ssh docker-nerves

设置Nerves开发环境变量

如果您的Nerves目标设备已确定且固定，锁定环境变量 ${MIX_TARGET} 可提高开发效率。以下是运行Docker容器时设置为 rpi3 的示例：

bash
$ docker run -it -w /workspace -e MIX_TARGET=rpi3 docker-nerves

root@deda9932d7e3:/workspace# echo $MIX_TARGET
rpi3

如果需要设置多个变量（例如为vintage_net_wifi配置WiFi信息），--env-file 会很高效。您可以从本文的"连接到目标设备"部分了解详情：

bash
$ cat env.list
MIX_TARGET=rpi3
WIFI_SSID=xxxxxxxx
WIFI_PSK=yyyyyyyy

$ docker run -it -w /workspace --env-file env.list docker-nerves

root@cf815278594a:/workspace# echo $MIX_TARGET
rpi3

root@cf815278594a:/workspace# echo $WIFI_SSID
xxxxxxxx

root@cf815278594a:/workspace# echo $WIFI_PSK
yyyyyyyy

分支与发布/标签策略及与Docker Hub标签的关系

此https://github.com/NervesJP/docker-nerves%E4%B8%8Ehttps://hub.docker.com/r/nervesjp/nerves%E5%85%B3%E8%81%94%EF%BC%8C%E5%8F%AF%E8%87%AA%E5%8A%A8%E6%9E%84%E5%BB%BA%E9%95%9C%E5%83%8F%E3%80%82%E4%BB%A5%E4%B8%8B%E6%98%AF%E7%BB%B4%E6%8A%A4%E7%AD%96%E7%95%A5%E5%8F%8Ahttps://github.com/NervesJP/docker-nerves/branches/https://github.com/NervesJP/docker-nerves/releases%E4%B8%8Ehttps://hub.docker.com/r/nervesjp/nerves/tags%E7%9A%84%E5%AF%B9%E5%BA%94%E5%85%B3%E7%B3%BB%EF%BC%9A

• main：最新维护版本，对应Docker标签 :latest
• dev：Dockerfile改进开发中，对应Docker标签 :dev
• vX.Y：Dockerfile和预构建镜像的发布版本，包含从上一版本开始的功能改进（如工具版本更新），对应Docker标签 :X.Y
• doc：仅修改文档，不关联Docker标签

当前限制

将Nerves固件烧录到microSD卡

Docker有严格的策略以避免影响主机环境，且在Windows和macOS主机上，由于需要 hypervisor 级别的支持，无法将USB设备（或串口）直通到容器中。因此，无法从Docker镜像中执行 mix burn，因为没有权限以root用户访问主机的 /dev。

一种烧录Nerves固件的方法是直接在主机上使用 fwup（Nerves固件构建/烧录工具）：https://github.com/fhunleth/fwup

按照https://github.com/fhunleth/fwup#installing%E5%9C%A8%E4%B8%BB%E6%9C%BA%E4%B8%8A%E5%AE%89%E8%A3%85 fwup 后，请在主机终端（例如管理员权限的PowerShell、Terminal.app）中执行以下命令：

bash
$ cd <your_nerves_project_dir>
$ fwup _build/${MIX_TARGET}_dev/nerves/images/<project_name>.fw

若主机使用Linux，您可能可以通过 privileged 选项从Docker环境访问microSD。您可能需要根据实际情况使用不同的 /dev/ 地址：

bash
$ docker run -it -w /workspace -v ${PWD}:/workspace \
  -v /dev/sdb:/dev/sdb --privileged docker-nerves

如有更好的解决方案，欢迎告知！(https://github.com/NervesJP/docker-nerves/issues/1)

相关链接

• Elixir论坛主题：Nerves development environment with Docker (and VS Code) - Nerves Forum / Chat / Discussions - Elixir Programming Language Forum
• Qiita文章（日语）