Portainer Templates logo

Portainer Templates

Diskover (container) Diskover (container)

StorageMonitoring

Diskover is an open source file system indexer that uses Elasticsearch to index and manage data across heterogeneous storage systems.

Image details

Pulls: 6.1M
Architectures: amd64, arm64
Image size: 48 MB
Latest: 2.3.5
User: linuxserver
Created: Nov 12, 2018
Updated: 18 days ago
Status: active

Source details

Stars: 2k
Forks: 184
Language: PHP
License: Apache-2.0
Updated: 3 months ago

Configuration

Type
Container
Platform
linux
Image
linuxserver/diskover:latest
Ports
80:80/tcp
Volumes
/config : /srv/lsio/diskover/config/data : /srv/lsio/diskover/data
Env vars
PUID=1000PGID=1000TZ=Etc/UTCES_HOST=elasticsearchES_PORT=9200
Restart
unless-stopped

Template by technorabilia

Notes

Portainer App Templates by Technorabilia, based on data provided by LinuxServer.io.

Ensure to create the following volume directories on the host file system, or modify the paths in the volume mapping section under the advanced options below, as needed.

mkdir -p /srv/lsio/diskover/config
mkdir -p /srv/lsio/diskover/data

Installation

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select the app you wish to deploy, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo

docker run -d --name Diskover \
  -p 80:80/tcp \
  -e 'PUID=1000' \
  -e 'PGID=1000' \
  -e 'TZ=Etc/UTC' \
  -e 'ES_HOST=elasticsearch' \
  -e 'ES_PORT=9200' \
  -v /srv/lsio/diskover/config:/config \
  -v /srv/lsio/diskover/data:/data \
  --restart=unless-stopped \
  linuxserver/diskover:latest

Save this file as compose.yaml and run docker compose up -d
Use this only as a guide.

services:
  diskover-container:
    image: linuxserver/diskover:latest
    ports:
      - 80:80/tcp
    volumes:
      - /srv/lsio/diskover/config:/config
      - /srv/lsio/diskover/data:/data
    environment:
      PUID: '1000'
      PGID: '1000'
      TZ: Etc/UTC
      ES_HOST: elasticsearch
      ES_PORT: '9200'
    restart: unless-stopped

Save this file as diskover-container-stack.yml, then from a manager node, run docker stack deploy -c diskover-container-stack.yml diskover-container

version: '3.8'
services:
  diskover-container:
    image: linuxserver/diskover:latest
    ports:
      - 80:80/tcp
    volumes:
      - /srv/lsio/diskover/config:/config
      - /srv/lsio/diskover/data:/data
    environment:
      PUID: '1000'
      PGID: '1000'
      TZ: Etc/UTC
      ES_HOST: elasticsearch
      ES_PORT: '9200'
    deploy:
      restart_policy:
        condition: any

Save each file below into a folder, then run kubectl apply -f .
Written for k3s, but works on any cluster: bind mounts use hostPath, named volumes get a persistent volume claim, and ports are exposed via a LoadBalancer service.

diskover-container-deployment.yaml

apiVersion: apps/v1
kind: Deployment
metadata:
  name: diskover-container
  labels:
    app: diskover-container
spec:
  replicas: 1
  selector:
    matchLabels:
      app: diskover-container
  template:
    metadata:
      labels:
        app: diskover-container
    spec:
      containers:
        - name: diskover-container
          image: linuxserver/diskover:latest
          env:
            - name: PUID
              value: '1000'
            - name: PGID
              value: '1000'
            - name: TZ
              value: Etc/UTC
            - name: ES_HOST
              value: elasticsearch
            - name: ES_PORT
              value: '9200'
          ports:
            - containerPort: 80
              protocol: TCP
          volumeMounts:
            - name: diskover-container-data-0
              mountPath: /config
            - name: diskover-container-data-1
              mountPath: /data
      volumes:
        - name: diskover-container-data-0
          hostPath:
            path: /srv/lsio/diskover/config
        - name: diskover-container-data-1
          hostPath:
            path: /srv/lsio/diskover/data

diskover-container-service.yaml

apiVersion: v1
kind: Service
metadata:
  name: diskover-container
spec:
  type: LoadBalancer
  selector:
    app: diskover-container
  ports:
    - name: 80-tcp
      port: 80
      targetPort: 80
      protocol: TCP

Save this file as ~/.config/containers/systemd/diskover-container.container

[Unit]
Description=Diskover (container)

[Container]
Image=linuxserver/diskover:latest
ContainerName=diskover-container
PublishPort=80:80/tcp
Environment=PUID=1000
Environment=PGID=1000
Environment=TZ=Etc/UTC
Environment=ES_HOST=elasticsearch
Environment=ES_PORT=9200
Volume=/srv/lsio/diskover/config:/config
Volume=/srv/lsio/diskover/data:/data

[Service]
Restart=always

[Install]
WantedBy=default.target

Then reload systemd and start the service:

systemctl --user daemon-reload
systemctl --user start diskover-container

For a system-wide service, use /etc/containers/systemd/ and drop --user.

For more installation options, see the Documentation in our GitHub repo

For app-specific guidance, check Diskover (container)'s own repo at diskoverdata/diskover-community

linuxserver.io
Blog Discord Discourse GitHub Open Collective
The LinuxServer.io team brings you another container release featuring:
  • regular and timely application updates
  • easy user mappings (PGID, PUID)
  • custom base image with s6 overlay
  • weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
  • regular security updates

Find us at:
  • Blog - all the things you can do with our containers including How-To guides, opinions and much more!
  • Discord - realtime support / chat with the community and the team.
  • Discourse - post on our community forum.
  • GitHub - view the source for all of our repositories.
  • Open Collective - please consider helping us by either donating or contributing to our budget

linuxserver/diskover

Scarf.io pulls GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry Quay.io Docker Pulls Docker Stars Jenkins Build LSIO CI
diskover is an open source file system indexer that uses Elasticsearch to index and manage data across heterogeneous storage systems.
diskover

Supported Architectures

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:latest 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 | Available | Tag | | :----: | :----: | ---- | | x86-64 | ✅ | amd64-\ | | arm64 | ✅ | arm64v8-\ |

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.
>!NOTE >Unless a parameter is flagged as 'optional', it is mandatory and a value must be provided.

docker-compose (recommended, click here for more info)

version: '2'
services:
  diskover:
    image: lscr.io/linuxserver/diskover
    container_name: diskover
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=America/New_York
      - ES_HOST=elasticsearch
      - ES_PORT=9200
    volumes:
      - /path/to/diskover/config:/config
      - /path/to/diskover/data:/data
    ports:
      - 80:80
    mem_limit: 4096m
    restart: unless-stopped
    depends_on:
      - elasticsearch
  elasticsearch:
    container_name: elasticsearch
    image: docker.elastic.co/elasticsearch/elasticsearch:7.17.22
    environment:
      - discovery.type=single-node
      - xpack.security.enabled=false
      - bootstrap.memory_lock=true
      - "ES_JAVA_OPTS=-Xms1g -Xmx1g"
    ulimits:
      memlock:
        soft: -1
        hard: -1
    volumes:
      - /path/to/esdata:/usr/share/elasticsearch/data
    ports:
      - 9200:9200
    depends_on:
      - elasticsearch-helper
    restart: unless-stopped
  elasticsearch-helper:
    image: alpine
    command: sh -c "sysctl -w vm.max_map_count=262144"
    privileged: true

docker cli (click here for more info)

docker run -d \
  --name=diskover \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -e ES_HOST=elasticsearch \
  -e ES_PORT=9200 \
  -p 80:80 \
  -v /path/to/diskover/config:/config \
  -v /path/to/diskover/data:/data \
  --restart unless-stopped \
  lscr.io/linuxserver/diskover:latest

Parameters

Containers 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.
| Parameter | Function | | :----: | --- | | -p 80:80 | diskover Web UI | | -e PUID=1000 | for UserID - see below for explanation | | -e PGID=1000 | for GroupID - see below for explanation | | -e TZ=Etc/UTC | specify a timezone to use, see this list. | | -e ES_HOST=elasticsearch | ElasticSearch host (optional) | | -e ES_PORT=9200 | ElasticSearch port (optional) | | -v /config | Persistent config files | | -v /data | Default mount point to crawl |

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.
As an example:
-e FILE__MYVAR=/run/secrets/mysecretvariable

Will set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable 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 your_user as below:
id your_user

Example output:
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

Docker Mods

Docker Mods Docker Universal 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:
```bash
docker exec -it diskover /bin/bash
```
  • To monitor the logs of the container in realtime:
```bash
docker logs -f diskover
```
  • Container version number:
```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' diskover
```
  • Image version number:
```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/diskover:latest
```

Updating Info

Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.
Below are the instructions for updating containers:

Via Docker Compose

  • Update images:
* All images:

    ```bash
    docker-compose pull
    ```

* Single image:

    ```bash
    docker-compose pull diskover
    ```
  • Update containers:
* All containers:

    ```bash
    docker-compose up -d
    ```

* Single container:

    ```bash
    docker-compose up -d diskover
    ```
  • You can also remove the old dangling images:
```bash
docker image prune
```

Via Docker Run

  • Update the image:
```bash
docker pull lscr.io/linuxserver/diskover:latest
```
  • Stop the running container:
```bash
docker stop diskover
```
  • Delete the container:
```bash
docker rm diskover
```
  • Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)
  • You can also remove the old dangling images:
```bash
docker image prune
```

Image Update Notifications - Diun (Docker Image Update Notifier)

>!TIP >We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.

Building locally

If you want to make local modifications to these images for development purposes or just to customize the logic:
git clone https://github.com/linuxserver/docker-diskover.git
cd docker-diskover
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/diskover:latest .

The ARM variants can be built on x8664 hardware and vice versa using lscr.io/linuxserver/qemu-static
docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.

Versions

  • 06.09.24: - Rebase to Alpine 3.20. Existing users should update their nginx confs to avoid http2 deprecation warnings.
  • 06.03.24: - Existing users should update: site-confs/default.conf - Cleanup default site conf.
  • 06.03.24: - Rebase to Alpine 3.19 with php 8.3.
  • 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
  • 13.04.23: - Move ssl.conf include to default.conf.
  • 02.03.23: - Set permissions on crontabs during init.
  • 20.08.22: - Rebasing to alpine 3.17 with php8.1. Restructure nginx configs (see changes announcement).
  • 25.02.22: - Add php7-sqlite3 to support rc4 release.
  • 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.

Serve Diskover (container) on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying diskover-container.example.com to http://Diskover:80

Add this to your Caddyfile

diskover-container.example.com {
	reverse_proxy http://Diskover:80
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs Diskover
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:80 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :80
  • Stop the other service, or pick a different host port. In 80:80 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:80. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, Diskover can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 80

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 1000:1000 /srv/lsio/diskover/config (and the same for the other mapped folders)
  • Or set the PUID and PGID variables (defaults 1000:1000) to match your own user, found with id $USER

Image won't pull

Test the pull directly on the host: docker pull linuxserver/diskover:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • This image supports: amd64, arm64
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect Diskover --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

Similar apps