linuxserver/diskover

​linuxserver/diskover​
​​
​ ​
​ ​
​ ​
​ ​
​ ​
​ ​
​ ​
​ ​
​ ​
​​
​diskover is an open source file system indexer that uses Elasticsearch to index and manage data across heterogeneous storage systems.
Supported Architectures
Our images support multiple architectures such as x86-64, arm64 and armhf. We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
Simply pulling lscr.io/linuxserver/diskover should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
The architectures supported by this image are:
Architecture
Tag
x86-64
amd64-latest
arm64
arm64v8-latest
armhf
arm32v7-latest
Application Setup
This application is dependent on an ElasticSearch instance. Please see the example compose file for additional information.
The default username is diskover with the password of darkdata, access the container at http://<host-ip>/. The UI may be unusable until a valid index has been created.
The default diskover-web Constants.php file located at /config/diskover-web.conf.d/Constants.php will need to be edited to allow diskover-web to communicate with the ElasticSearch container. The following entries will need to be edited:
const ES_HOST = elasticsearch
const ES_PORT = 9200
The application doesn't start an index by default. A crontab is created inside of the /config directory and can be set up to run automated indexes of /data. Changes to this crontab file require a restart to apply. You can also manually run an index by executing /app/diskover/diskover.py either in interactive or detached mode:
docker exec -u abc -d diskover python3 /app/diskover/diskover.py -i diskover-my_index_name /data Will run an index in the background
docker exec -u abc -it diskover python3 /app/diskover/diskover.py -i diskover-my_index_name /data Will run an index in the foreground
Usage
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
docker-compose (recommended, click here for more info)
1
version: '2'
2
services:
3
  diskover:
4
    image: lscr.io/linuxserver/diskover
5
    container_name: diskover
6
    environment:
7
      - PUID=1000
8
      - PGID=1000
9
      - TZ=America/New_York
10
      - ES_HOST=elasticsearch
11
      - ES_PORT=9200
12
    volumes:
13
      - /path/to/diskover/config:/config
14
      - /path/to/diskover/data:/data
15
    ports:
16
      - 80:80
17
    mem_limit: 4096m
18
    restart: unless-stopped
19
    depends_on:
20
      - elasticsearch
21
  elasticsearch:
22
    container_name: elasticsearch
23
    image: docker.elastic.co/elasticsearch/elasticsearch:7.10.2
24
    environment:
25
      - discovery.type=single-node
26
      - xpack.security.enabled=true
27
      - bootstrap.memory_lock=true
28
      - "ES_JAVA_OPTS=-Xms1g -Xmx1g"
29
    ulimits:
30
      memlock:
31
        soft: -1
32
        hard: -1
33
    volumes:
34
      - /path/to/esdata:/usr/share/elasticsearch/data
35
    ports:
36
      - 9200:9200
37
    depends_on:
38
      - elasticsearch-helper
39
    restart: unless-stopped
40
  elasticsearch-helper:
41
    image: alpine
42
    command: sh -c "sysctl -w vm.max_map_count=262144"
43
    privileged: true
Copied!
docker cli (click here for more info)
1
docker run -d \
2
  --name=diskover \
3
  -e PUID=1000 \
4
  -e PGID=1000 \
5
  -e TZ=America/New_York \
6
  -e ES_HOST=elasticsearch \
7
  -e ES_PORT=9200 \
8
  -e ES_USER=elastic \
9
  -e ES_PASS=changeme \
10
  -p 80:80 \
11
  -v /path/to/diskover/config:/config \
12
  -v /path/to/diskover/data:/data \
13
  --restart unless-stopped \
14
  lscr.io/linuxserver/diskover
Copied!
Parameters
Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.
Ports (-p)
Parameter
Function
80
diskover Web UI
Environment Variables (-e)
Env
Function
PUID=1000
for UserID - see below for explanation
PGID=1000
for GroupID - see below for explanation
TZ=America/New_York
Specify a timezone to use EG America/New_York
ES_HOST=elasticsearch
ElasticSearch host (optional)
ES_PORT=9200
ElasticSearch port (optional)
ES_USER=elastic
ElasticSearch username (optional)
ES_PASS=changeme
ElasticSearch password (optional)
Volume Mappings (-v)
Volume
Function
/config
Persistent config files
/data
Default mount point to crawl
Miscellaneous Options
Environment variables from files (Docker secrets)
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
1
-e FILE__PASSWORD=/run/secrets/mysecretpassword
Copied!
Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword file.
Umask for running applications
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.
User / Group Identifiers
When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
In this instance PUID=1000 and PGID=1000, to find yours use id user as below:
1
  $ id username
2
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
Copied!
Docker Mods
​​
​ ​
​​
We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
Support Info
Shell access whilst the container is running:
docker exec -it diskover /bin/bash
To monitor the logs of the container in realtime:
docker logs -f diskover
Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' diskover
Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/diskover
Versions
03.11.21: - Added more support for potential config files.
31.10.21: - Added xpack.security variable to ElasticSearch; added instructions to edit Constants.php in diskover; corrected command needed to manually generate an index in diskover
11.10.21: - Updated to diskover-community v2.
19.11.20: - Fix pip packages.
19.12.19: - Rebasing to alpine 3.11.
28.06.19: - Rebasing to alpine 3.10.
12.04.19: - Rebase to Alpine 3.9.
23.03.19: - Switching to new Base images, shift to arm32v7 tag.
01.11.18: - Initial Release.