docker-documentation/docs/images/docker-diskover.md

351 wiersze
14 KiB
Markdown
Czysty Zwykły widok Historia

2021-02-16 10:34:46 +00:00
---
title: diskover
---
2023-10-07 16:31:37 +00:00
<!-- DO NOT EDIT THIS FILE MANUALLY -->
<!-- Please read https://github.com/linuxserver/docker-diskover/blob/master/.github/CONTRIBUTING.md -->
2020-07-03 22:33:50 +00:00
# [linuxserver/diskover](https://github.com/linuxserver/docker-diskover)
2021-12-21 10:36:10 +00:00
[![Scarf.io pulls](https://scarf.sh/installs-badge/linuxserver-ci/linuxserver%2Fdiskover?color=94398d&label-color=555555&logo-color=ffffff&style=for-the-badge&package-type=docker)](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Fdiskover)
2020-07-03 22:33:50 +00:00
[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-diskover.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-diskover)
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-diskover.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-diskover/releases)
[![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github)](https://github.com/linuxserver/docker-diskover/packages)
2020-12-19 06:19:27 +00:00
[![GitLab Container Registry](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab)](https://gitlab.com/linuxserver.io/docker-diskover/container_registry)
2021-10-05 10:34:19 +00:00
[![Quay.io](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/diskover)
2020-07-03 22:33:50 +00:00
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/diskover.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/diskover)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/diskover.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/diskover)
[![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-diskover%2Fjob%2Fmaster%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-diskover/job/master/)
2020-11-04 19:46:00 +00:00
[![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2Fdiskover%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/diskover/latest/index.html)
2019-02-08 23:34:37 +00:00
2021-10-16 17:49:41 +00:00
[diskover](https://github.com/diskoverdata/diskover-community) is an open source file system indexer that uses Elasticsearch to index and manage data across heterogeneous storage systems.
2019-02-08 23:34:37 +00:00
2023-10-07 16:31:37 +00:00
[![diskover](https://raw.githubusercontent.com/diskoverdata/diskover-community/master/diskover-web/public/images/diskover.png)](https://github.com/diskoverdata/diskover-community)
2019-02-08 23:34:37 +00:00
## Supported Architectures
2022-05-03 10:40:23 +00:00
We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
2019-02-08 23:34:37 +00:00
2022-05-03 10:40:23 +00:00
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.
2019-02-08 23:34:37 +00:00
The architectures supported by this image are:
2022-05-03 10:40:23 +00:00
| Architecture | Available | Tag |
| :----: | :----: | ---- |
| x86-64 | ✅ | amd64-\<version tag\> |
| arm64 | ✅ | arm64v8-\<version tag\> |
2023-05-31 12:23:12 +00:00
| armhf | ❌ | |
2019-02-08 23:34:37 +00:00
2021-04-20 10:38:13 +00:00
## Application Setup
2021-10-16 17:49:41 +00:00
This application is dependent on an ElasticSearch instance. Please see the example compose file for additional information.
2021-04-20 10:38:13 +00:00
2021-11-09 20:42:40 +00:00
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.
2021-04-20 10:38:13 +00:00
2021-11-01 12:39:09 +00:00
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`
2021-10-16 17:49:41 +00:00
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:
2021-04-20 10:38:13 +00:00
2021-11-01 12:39:09 +00:00
* `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
2020-07-03 22:33:50 +00:00
2019-02-08 23:34:37 +00:00
## Usage
2021-07-06 10:35:33 +00:00
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
2019-02-08 23:34:37 +00:00
2021-07-06 10:35:33 +00:00
### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
2019-02-08 23:34:37 +00:00
```yaml
version: '2'
services:
diskover:
2021-11-22 10:09:36 +00:00
image: lscr.io/linuxserver/diskover
2019-02-08 23:34:37 +00:00
container_name: diskover
environment:
- PUID=1000
- PGID=1000
2021-10-16 17:49:41 +00:00
- TZ=America/New_York
2019-02-08 23:34:37 +00:00
- ES_HOST=elasticsearch
- ES_PORT=9200
volumes:
2020-05-16 00:36:06 +00:00
- /path/to/diskover/config:/config
- /path/to/diskover/data:/data
2019-02-08 23:34:37 +00:00
ports:
- 80:80
mem_limit: 4096m
restart: unless-stopped
depends_on:
- elasticsearch
elasticsearch:
container_name: elasticsearch
2021-10-16 17:49:41 +00:00
image: docker.elastic.co/elasticsearch/elasticsearch:7.10.2
2019-02-08 23:34:37 +00:00
environment:
2021-10-16 17:49:41 +00:00
- discovery.type=single-node
2021-11-01 12:39:09 +00:00
- xpack.security.enabled=true
2019-02-08 23:34:37 +00:00
- bootstrap.memory_lock=true
2021-10-16 17:49:41 +00:00
- "ES_JAVA_OPTS=-Xms1g -Xmx1g"
2019-02-08 23:34:37 +00:00
ulimits:
memlock:
soft: -1
hard: -1
volumes:
2021-10-16 17:49:41 +00:00
- /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
2019-02-08 23:34:37 +00:00
```
2021-07-06 10:35:33 +00:00
### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))
2020-10-02 22:34:19 +00:00
2021-04-20 10:38:13 +00:00
```bash
2020-10-02 22:34:19 +00:00
docker run -d \
--name=diskover \
-e PUID=1000 \
-e PGID=1000 \
2023-02-11 01:28:21 +00:00
-e TZ=Etc/UTC \
2020-10-02 22:34:19 +00:00
-e ES_HOST=elasticsearch \
-e ES_PORT=9200 \
-e ES_USER=elastic \
-e ES_PASS=changeme \
-p 80:80 \
-v /path/to/diskover/config:/config \
-v /path/to/diskover/data:/data \
--restart unless-stopped \
2022-05-03 10:40:23 +00:00
lscr.io/linuxserver/diskover:latest
2020-10-02 22:34:19 +00:00
```
2019-02-08 23:34:37 +00:00
## Parameters
2023-10-07 16:31:37 +00:00
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.
2019-02-08 23:34:37 +00:00
2020-07-03 22:33:50 +00:00
### Ports (`-p`)
2019-02-08 23:34:37 +00:00
| Parameter | Function |
2020-07-03 22:33:50 +00:00
| :----: | --- |
2019-02-08 23:34:37 +00:00
| `80` | diskover Web UI |
2020-07-03 22:33:50 +00:00
### Environment Variables (`-e`)
2019-02-08 23:34:37 +00:00
| Env | Function |
2020-07-03 22:33:50 +00:00
| :----: | --- |
2019-03-01 23:33:46 +00:00
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
2023-02-11 01:28:21 +00:00
| `TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
2020-07-03 22:33:50 +00:00
| `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`)
2019-02-08 23:34:37 +00:00
| Volume | Function |
2020-07-03 22:33:50 +00:00
| :----: | --- |
2019-02-08 23:34:37 +00:00
| `/config` | Persistent config files |
| `/data` | Default mount point to crawl |
2021-10-05 10:34:19 +00:00
#### Miscellaneous Options
| Parameter | Function |
| :-----: | --- |
2020-07-03 22:33:50 +00:00
## Environment variables from files (Docker secrets)
2020-05-29 22:34:02 +00:00
You can set any environment variable from a file by using a special prepend `FILE__`.
As an example:
2021-04-20 10:38:13 +00:00
```bash
2023-10-07 16:31:37 +00:00
-e FILE__MYVAR=/run/secrets/mysecretvariable
2020-05-29 22:34:02 +00:00
```
2023-10-07 16:31:37 +00:00
Will set the environment variable `MYVAR` based on the contents of the `/run/secrets/mysecretvariable` file.
2020-05-29 22:34:02 +00:00
## Umask for running applications
2020-07-03 22:33:50 +00:00
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](https://en.wikipedia.org/wiki/Umask) before asking for support.
2019-02-08 23:34:37 +00:00
## User / Group Identifiers
2020-07-03 22:33:50 +00:00
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`.
2019-02-08 23:34:37 +00:00
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
2023-10-07 16:31:37 +00:00
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id your_user` as below:
2019-02-08 23:34:37 +00:00
2021-04-20 10:38:13 +00:00
```bash
2023-10-07 16:31:37 +00:00
id your_user
```
Example output:
```text
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)
2019-02-08 23:34:37 +00:00
```
2020-04-08 10:44:07 +00:00
## Docker Mods
2021-04-20 10:38:13 +00:00
2020-10-02 22:34:19 +00:00
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=diskover&query=%24.mods%5B%27diskover%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=diskover "view available mods for this container.") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
2020-04-08 10:44:07 +00:00
2020-10-02 22:34:19 +00:00
We publish various [Docker Mods](https://github.com/linuxserver/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.
2020-04-08 10:44:07 +00:00
2019-02-08 23:34:37 +00:00
## Support Info
2019-09-06 22:33:57 +00:00
* Shell access whilst the container is running:
2023-10-07 16:31:37 +00:00
```bash
docker exec -it diskover /bin/bash
```
2019-09-06 22:33:57 +00:00
* To monitor the logs of the container in realtime:
2023-10-07 16:31:37 +00:00
```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 (ie. nextcloud, plex), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#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
```
### Via Watchtower auto-updater (only use if you don't remember the original parameters)
* Pull the latest image at its tag and replace it with the same env variables in one run:
```bash
docker run --rm \
-v /var/run/docker.sock:/var/run/docker.sock \
containrrr/watchtower \
--run-once diskover
```
* You can also remove the old dangling images: `docker image prune`
!!! warning
We do not endorse the use of Watchtower as a solution to automated updates of existing Docker containers. In fact we generally discourage automated updates. However, this is a useful tool for one-time manual updates of containers where you have forgotten the original parameters. In the long term, we highly recommend using [Docker Compose](https://docs.linuxserver.io/general/docker-compose).
### Image Update Notifications - Diun (Docker Image Update Notifier)
!!! tip
We recommend [Diun](https://crazymax.dev/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:
```bash
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 x86_64 hardware using `multiarch/qemu-user-static`
```bash
docker run --rm --privileged multiarch/qemu-user-static:register --reset
```
Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.
2019-02-08 23:34:37 +00:00
## Versions
2023-05-31 12:23:12 +00:00
* **25.05.23:** - Rebase to Alpine 3.18, deprecate armhf.
2023-04-17 17:30:34 +00:00
* **13.04.23:** - Move ssl.conf include to default.conf.
2023-03-03 00:03:52 +00:00
* **02.03.23:** - Set permissions on crontabs during init.
2023-02-11 01:28:21 +00:00
* **20.08.22:** - Rebasing to alpine 3.17 with php8.1. Restructure nginx configs ([see changes announcement](https://info.linuxserver.io/issues/2022-08-20-nginx-base)).
2022-02-25 15:05:28 +00:00
* **25.02.22:** - Add php7-sqlite3 to support rc4 release.
2021-11-03 23:25:56 +00:00
* **03.11.21:** - Added more support for potential config files.
2021-11-01 12:39:09 +00:00
* **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
2021-10-16 17:49:41 +00:00
* **11.10.21:** - Updated to diskover-community v2.
2020-11-28 03:56:14 +00:00
* **19.11.20:** - Fix pip packages.
2019-12-27 11:15:07 +00:00
* **19.12.19:** - Rebasing to alpine 3.11.
2019-08-18 23:39:12 +00:00
* **28.06.19:** - Rebasing to alpine 3.10.
2019-04-13 06:29:43 +00:00
* **12.04.19:** - Rebase to Alpine 3.9.
2019-03-24 19:44:58 +00:00
* **23.03.19:** - Switching to new Base images, shift to arm32v7 tag.
2019-02-08 23:34:37 +00:00
* **01.11.18:** - Initial Release.