eLabFTW(电子实验记录本)的安装与使用

eLabFTW Install and Using

不断更新的开源网页版电子实验记录本，随时记录实验不必再重复整理数据

1. 背景

eLabFTW 是一款面向科研团队的电子实验记录本管理软件。

它能让您轻松存储和整理研究实验数据。它还配备了一个数据库，可以存储任何类型的对象（例如抗体、质粒、细胞系、样品盒等）。多个研究团队可以共享同一台服务器。这意味着 eLabFTW 可以安装在研究所层面，让所有团队成员在同一地点工作。全球许多研究机构都采用了这种方式。对于希望提高流程可追溯性和可重复性的公司而言，它也是一个绝佳的解决方案。

特点：

  • 实验记录本
  • 资源数据库（实验室试剂、设备、存储、细胞系、化学产品等……）
  • 可信时间戳
  • 区块链时间戳
  • 日志管理

2. 工作原理

eLabFTW 设计为安装在服务器上，团队成员可以通过浏览器登录。

eLabFTW

eLabFTW

3. 安装

LabFTW 可以轻松安装在任何 GNU/Linux 服务器上。它至少需要 512 MB 内存（建议 1 GB）和 300 MB 磁盘空间。安装通过 Docker 完成，因此服务器上需要安装 Docker。由于它运行在 Docker 容器中，因此无需在服务器上安装 PHP、Web 服务器或 MySQL。所有组件都由容器提供，因此不同的版本和扩展名无关紧要。这使得版本升级更加便捷

Important

为了确保数据不会丢失，制定自动备份策略是必不可少的

eLabFTW 是一个基于网络的电子实验笔记本 (ELN)，您可以为您的团队或组织自行托管

eLabFTW is supported only on GNU/Linux, and only in containers.

  • 运行 nginx+php-fpm 和 eLabFTW 的 Web 应用程序容器
  • A MySQL database service 数据库服务
  • 用于应用程序数据和上传的持久存储

3.1 预准备

在安装之前确保环境的准确

  • 64位的 GUN/Linux OS
  • 容器(Docker, Podman, Kubernetes–k8s)
  • 任何其他与 OCI 兼容的容器引擎

On Ubuntu, Docker installed via snap is known to cause issues

因为 Snap 版本 Docker 有很多兼容问题： - 权限问题 - volume 挂载异常 - socket 路径不同 - compose 识别失败 - container 网络问题

标准的安装是包含MySQL的，所以不需要单独安装mysql-server

3.2 安装

elabctl 是一个可以帮助您管理 eLabFTW 安装的工具。虽然并非必须安装，但它非常方便，因此建议安装（而且它只是一个 bash 脚本，没什么特别的）。

  1. 安装elabctl
# get the program and make it executable
curl -sL https://get.elabftw.net -o elabctl && chmod +x elabctl
# add it to a directory in your $PATH
sudo mv elabctl /usr/local/bin/

此处会下载一个名为elabctl的脚本，并将其添加到/usr/local/bin/目录中，以便在终端中全局使用

Note

如果你不想安装elabctl，你可以使用以下命令获取 Docker Compose 配置文件：

curl -so docker-compose.yml "https://get.elabftw.net/?config"
  1. 终端输入elabctl install，进入交互界面

elab1

  1. 提醒configuration file被创建在/etc/elabftw.yml文件中，同时MySQL，备份在 /var/backups/elabftw中，上传的文件保存在/var/elabftw/web中

  2. 询问你安装是Server或个人电脑，如果你有IP地址和域名便直接可以安装Server，否则安装个人电脑。这里先选择安装在本地电脑，会提醒密码输入，然后开始下载

  3. 开始Grabbing the docker-compose configuration file,等待安装完成

3.3 启动

使用命令进行查看配置文件\etc\elabftw.yml，然后启动elabctl

elabctl start
# same as: docker compose -f /etc/elabftw.yml up -d

如果权限出现问题了，记得加sudo,后续开始下载docker所需要的库

elab默认启动的是443端口，如果你运行ngix，记得修改端口，修改路径在\etc\elabftw.yml

  • 找到ports部分
  • 将冒号左边的数字（宿主机端口）改为你想要的空闲端口，例如 8443。冒号右边的数字（容器内部端口）不要动，必须保持为 443

安装数据库 elabctl initialize

4. 设置

当完成安装之后，会提醒https://192.168.1.4:8443/register.php#进行登陆团队建立,邮箱账户注册和密码登陆

必须要使用https，否则会报错400 Bad Request: The plain HTTP request was sent to HTTPS port

elablogin

Note

如果你填了 https://127.0.0.1 但没勾选“跳过证书验证”，Nginx 会去验证 frps 的证书。因为 frps 通常使用自签名证书，Nginx 认为不安全，拒绝连接，同样报 502。