Diskover (stack)
Open-source file indexer, search engine, data analytics and management platform powered by Elasticsearch.
Services
elasticsearch
Configuration
Imageelasticsearch:7.17.10/usr/share/elasticsearch/data : /portainer/Files/AppData/Config/diskover/es_datadiscovery.type=single-nodexpack.security.enabled=falseES_JAVA_OPTS=-Xms512m -Xmx512munless-stoppedImage details
diskover
Configuration
Imagelinuxserver/diskover:latest8884:80/data : /mnt/MYSMBMOUNT/config : /portainer/Files/AppData/Config/diskover/dataPUID=1000PGID=1000TZ=Europe/Athensunless-stoppedImage details
Standalone Install
Select an install method, to see config/commands for deploying Diskover (stack)
Install on Portainer
Import all app templates into your Portainer instance, for easy 1-click deploys
- Ensure both Docker and Portainer are installed, and up-to-date
- Log into your Portainer web UI
- Under Settings → App Templates, paste the below URL
- Head to Home → App Templates, and the list of apps will show up
- Select Diskover (stack), fill in any config options, and hit Deploy
Template Import URL
https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me
Original stackfile
The compose file this template deploys, straight from its repo:
#PREREQUISITES
#Run below commands BEFORE DEPLOYING
#sudo chown -R 1000:1000 /portainer/Files/AppData/Config/diskover/es_data
#sudo sysctl -w vm.max_map_count=262144
#----------#
#Run initial crawl after deploy with: python3 /app/diskover/diskover.py /data
services:
elasticsearch:
image: elasticsearch:7.17.10
container_name: elasticsearch # Must be this!
user: "1000:1000"
environment:
- discovery.type=single-node
- xpack.security.enabled=false
- "ES_JAVA_OPTS=-Xms512m -Xmx512m"
volumes:
- /portainer/Files/AppData/Config/diskover/es_data:/usr/share/elasticsearch/data
restart: unless-stopped
diskover:
image: linuxserver/diskover:latest
container_name: diskover
ports:
- "8884:80"
volumes:
- /mnt/MYSMBMOUNT:/data:ro
- /portainer/Files/AppData/Config/diskover/data:/config
environment:
- PUID=1000
- PGID=1000
- TZ=Europe/Athens
depends_on:
- elasticsearch
restart: unless-stopped
Or deploy it directly from the source:
git clone https://github.com/xneo1/portainer_templates
cd portainer_templates
docker compose -f Template/Stack/diskover.yml up -dMore install options in our documentation.
Container Documentation
elasticsearch Documentation
Elasticsearch is a powerful open source search and analytics engine that makes data easy to explore.
diskover Documentation
Serve Diskover (stack) 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-stack.example.com to http://diskover:80
Add this to your Caddyfile
diskover-stack.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 <container> - Exit codes help too:
137means killed, usually out of memory.126or127means the command inside the image is broken.
Port already in use
If deployment fails with "Bind for 0.0.0.0:8884 failed: port is already allocated", something else on your server is using that port.
- Find what's using it:
sudo ss -tlnp | grep :8884 - Stop the other service, or pick a different host port. In
8884:80only 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:8884. 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 8884
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 /portainer/Files/AppData/Config/diskover/es_data(and the same for the other mapped folders) - Or set the
PUIDandPGIDvariables (defaults 1000:1000) to match your own user, found withid $USER
Image won't pull
Test the pull directly on the host: docker pull elasticsearch:7.17.10
- "manifest unknown" means the tag no longer exists.
- "toomanyrequests" is the Docker Hub rate limit. Log in with
docker loginto 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.
- 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 <container> --format '{{.State.ExitCode}}' - Still stuck? Redeploy once with the restart policy set to
noso the failure stays visible.
Stack won't deploy
Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.
- YAML only accepts spaces for indentation, a single tab breaks the whole file.
Raise an issue
Found something which isn't working as it should? Here's how to report it.
- Bug within the app: Open an issue within diskover's repo
- Template not working: Open an issue on xneo1/portainer_templates
- This website not working: Open an issue on lissy93/portainer-templates
A Compose stack
Diskover (stack) is a Compose stack, a set of containers (2 of them) defined in one file and brought up together by Portainer, then started and stopped as a single app.
The services
This stack is built from 2 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:
elasticsearchrunselasticsearch:7.17.10diskoverrunslinuxserver/diskover:latest, starts after elasticsearch
Ports
A port is the door the app answers on. A mapping like 8884:80 means it's reachable on port 8884 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:8884 in a browser. It opens:
8884:80, likely the web interface
Volumes
A volume is where Diskover (stack) keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:
/usr/share/elasticsearch/datafrom/portainer/Files/AppData/Config/diskover/es_dataon the host/datafrom/mnt/MYSMBMOUNTon the host/configfrom/portainer/Files/AppData/Config/diskover/dataon the host
Environment variables
Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Diskover (stack) takes 6 of them, all with defaults you can leave alone or tweak:
discovery.type, defaults tosingle-nodexpack.security.enabled, defaults tofalseES_JAVA_OPTS, defaults to-Xms512m -Xmx512mPUID, defaults to1000PGID, defaults to1000TZ, defaults toEurope/Athens
Restart policy
The restart policy here is unless-stopped, so Docker restarts Diskover (stack) after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).
Users and permissions
The PUID and PGID settings tell it which user and group to act as on your host. Point them at your own account (find yours with id $USER) so the files it writes into your mounted folders come out owned by you rather than root.
Networking
Portainer puts these services on one shared private network, so they can find each other by name (like elasticsearch) while only the ports above are open to you.
Platform
The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.
Portainer app templates
Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Diskover (stack) up. Add the template list to Portainer once, then deploying Diskover (stack) is a click rather than a wall of config.