linuxserver/diskover

[!TIP]

前半部分是翻译官方的文档，最后一部分是我的简单试用（个别软件会深度试用），如果对Docker已经有一定的了解了，可以直接跳转到最后面 翻译之外 这部分来查看。

diskover → https://github.com/shirosaidev/diskover

GitHub → https://github.com/linuxserver/docker-diskover

Docker Hub → https://hub.docker.com/r/linuxserver/diskover

diskover 是一个文件系统搜寻器和磁盘空间管理软件。它使用 Elasticsearch 在跨异构存储系统中索引和管理数据。

支持的系统架构

得益于docker的跨平台属性，我们的镜像也支持多架构（如，x86-64、arm64、armhf）。

直接拉取 ghcr.io/linuxserver/diskover 应该就可以自动获取适合你系统架构的版本，当然你也可以通过 tag 获取特定的版本。

架构 Tag
x86-64 amd64-latest
arm64 arm64v8-latest
armhf arm32v7-latest

拉取镜像

  1. docker pull ghcr.io/linuxserver/diskover

使用方法

以下是一些简单的示例。

docker-compose（推荐）

兼容docker-compose v2

  1. version: '2'
  2. services:
  3.   diskover:
  4.     image: linuxserver/diskover
  5.     container_name: diskover
  6.     environment:
  7.       - PUID=1000
  8.       - PGID=1000
  9.       - TZ=Europe/London
  10.       - REDIS_HOST=redis
  11.       - REDIS_PORT=6379
  12.       - ES_HOST=elasticsearch
  13.       - ES_PORT=9200
  14.       - ES_USER=elastic
  15.       - ES_PASS=changeme
  16.       - RUN_ON_START=true
  17.       - USE_CRON=true
  18.     volumes:
  19.       - /path/to/diskover/config:/config
  20.       - /path/to/diskover/data:/data
  21.     ports:
  22.       - 80:80
  23.       - 9181:9181
  24.       - 9999:9999
  25.     mem_limit: 4096m
  26.     restart: unless-stopped
  27.     depends_on:
  28.       - elasticsearch
  29.       - redis
  30.   elasticsearch:
  31.     container_name: elasticsearch
  32.     image: docker.elastic.co/elasticsearch/elasticsearch:5.6.9
  33.     volumes:
  34.       - ${DOCKER_HOME}/elasticsearch/data:/usr/share/elasticsearch/data
  35.     environment:
  36.       - bootstrap.memory_lock=true
  37.       - "ES_JAVA_OPTS=-Xms2048m -Xmx2048m"
  38.     ulimits:
  39.       memlock:
  40.         soft: -1
  41.         hard: -1
  42.   redis:
  43.     container_name: redis
  44.     image: redis:alpine
  45.     volumes:
  46.       - ${HOME}/docker/redis:/data

docker cli

  1. docker run -d \
  2.   --name=diskover \
  3.   -e PUID=1000 \
  4.   -e PGID=1000 \
  5.   -e TZ=Europe/London \
  6.   -e REDIS_HOST=redis \
  7.   -e REDIS_PORT=6379 \
  8.   -e ES_HOST=elasticsearch \
  9.   -e ES_PORT=9200 \
  10.   -e ES_USER=elastic \
  11.   -e ES_PASS=changeme \
  12.   -e INDEX_NAME=diskover- \
  13.   -e DISKOVER_OPTS= \
  14.   -e WORKER_OPTS= \
  15.   -e RUN_ON_START=true \
  16.   -e USE_CRON=true \
  17.   -p 80:80 \
  18.   -p 9181:9181 \
  19.   -p 9999:9999 \
  20.   -v /path/to/diskover/config:/config \
  21.   -v /path/to/diskover/data:/data \
  22.   --restart unless-stopped \
  23.   linuxserver/diskover

参数

Docker镜像在使用的时候需要配置一些参数，这些参数使用 : 分隔，分别表示 宿主机:容器内。例如 -p 8080:80 指的是将容器内的80端口映射到宿主机上的8080端口，即通过宿主机网络访问的话，访问8080端口即是访问容器内的80端口。

端口（-p）

port 说明
80 diskover Web界面
9181 rq-dashboard Web界面
9999 diskover socket服务器

环境变量（-e）

env 说明
PUID=1000 用户的 UID，详见下面的说明
PGID=1000 用户的 GID，详见下面的说明
TZ=Europe/London 设置时区，在国内的话可以使用 Asia/Shanghai
REDIS_HOST=redis Redis 地址（可选）
REDIS_PORT=6379 Redis 端口（可选）
ES_HOST=elasticsearch ElasticSearch 地址（可选）
ES_PORT=9200 ElasticSearch 端口（可选）
ES_USER=elastic ElasticSearch 用户名（可选）
ES_PASS=changeme ElasticSearch 密码（可选）
INDEX_NAME=diskover- 索引名称前缀（可选）
DISKOVER_OPTS= 传递给 diskover 搜寻器的参数（可选）
WORKER_OPTS= 传递给 diskover bots 启动器的参数（可选）
RUN_ON_START=true 容器启动时，启动搜寻器（可选）
USE_CRON=true 使 搜寻器 作为Cron启动（可选）

卷映射（-v）

volume 说明
/config 配置文件所在路径
/data 搜寻器的默认挂载点

从文件加载环境变量

可以使用前缀名为 FILE__ 的文件来加载环境变量。

例：

  1. -e FILE__PASSWORD=/run/secrets/mysecretpassword

将把 /run/secrets/mysecretpassword 文件中的内容作为 PASSWORD 变量的值。

运行程序的umask（文件掩码）

我们所有的镜像都可以使用 -e UMASK=022 来设置覆盖容器内服务的umask。关于Linux umask可以通过这里了解，或自行百度学习。

UID和GID

当使用 -v 映射卷的时候，宿主机和容器内会出现关于权限的问题，我们的镜像可以通过指定 PUID 和 GUID 来避免此类问题。

可以使用你目前正在使用的用户的UID和GID进行设置，这样就不会存在权限问题。

可以通过如下的方式查看当前用户的UID和GID：

  1.   $ id $user
  2.     uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

[!NOTE]

如果没特殊需求，可以将后续所有容器的id都设置为当前非root用户的id，这样会省去解决很多关于文件权限的问题（可以查看 什么是PUID和PGID 这篇文章了解更多）。当然，如果有特殊需要可以给不同的容器设置不同的id，即分配给不同的用户。使用 useradd 命令即可添加用户。通常来说，除root账户外，第一个建立的用户的UID和GID都是1000，然后递增生成。

安装说明

访问地址 http://ip

初始化将花费一段时间，如果打开页面无响应，请稍后刷新重试。

我们强烈建议使用 docker compose 进行部署，因为它需要链接到多个数据库后端。

如果你在宿主机上安装的 elasticsearch 和 redis，那么他们不支持设置自定义的uid和gid，他们将默认运行为：

  • Redis UID=999 GID=999
  • Elasticsearch UID=1000 GID=1000

ElasticSearch还需要主机上的sysctl设置才能正常运行。使用 sysctl -w vm.max_map_count=262144 会解决这个问题。要使此设置在重新启动后保持不变，请在 /etc/sysctl.conf 中设置此值。

如果仅是希望应用程序正常运行，则可以将它们安装到具有0777权限的文件夹中，否则，您将需要创建这些用户的主机级别并正确设置文件夹所有权。

上面 compose 的示例中，是指向单个目录的，并且你传递给diskover容器的UID和GID需要与该文件夹的所有权相匹配。如果这些是具有许多所有者的共享文件夹，则索引编制可能会失败。

在您的环境中特殊问题或设置，请参阅项目的Github页面。

支持

  • 进入容器：
    • docker exec -it diskover /bin/bash
  • 查看容器日志：
    • docker logs -f diskover
  • 查看容器版本号：
    • docker inspect -f '{% raw %}{{% endraw %}{ index .Config.Labels "build_version" }}' diskover
  • 查看镜像版本号：
    • docker inspect -f '{% raw %}{{% endraw %}{ index .Config.Labels "build_version" }}' ghcr.io/linuxserver/diskover

翻译之外

说实话……不知道这个东西咋用……