diff --git a/readme-vars.yml b/readme-vars.yml index c370d71..9dcf2c5 100644 --- a/readme-vars.yml +++ b/readme-vars.yml @@ -6,27 +6,24 @@ project_url: "https://github.com/diskoverdata/diskover-community" project_logo: "https://raw.githubusercontent.com/diskoverdata/diskover-community/master/diskover-web/public/images/diskover.png" project_blurb: "[{{ project_name }}]({{ project_url }}) is an open source file system indexer that uses Elasticsearch to index and manage data across heterogeneous storage systems." project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}" - # supported architectures available_architectures: - - { arch: "{{ arch_x86_64 }}", tag: "amd64-latest"} - - { arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"} - + - {arch: "{{ arch_x86_64 }}", tag: "amd64-latest"} + - {arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"} # container parameters common_param_env_vars_enabled: true #PGID, PUID, etc param_container_name: "{{ project_name }}" param_usage_include_vols: true param_volumes: - - { vol_path: "/config", vol_host_path: "/path/to/{{ project_name }}/config", desc: "Persistent config files" } - - { vol_path: "/data", vol_host_path: "/path/to/{{ project_name }}/data", desc: "Default mount point to crawl" } + - {vol_path: "/config", vol_host_path: "/path/to/{{ project_name }}/config", desc: "Persistent config files"} + - {vol_path: "/data", vol_host_path: "/path/to/{{ project_name }}/data", desc: "Default mount point to crawl"} param_usage_include_ports: true param_ports: - - { external_port: "80", internal_port: "80", port_desc: "diskover Web UI" } + - {external_port: "80", internal_port: "80", port_desc: "diskover Web UI"} param_usage_include_env: true param_env_vars: - - { env_var: "ES_HOST", env_value: "elasticsearch", desc: "ElasticSearch host (optional)"} - - { env_var: "ES_PORT", env_value: "9200", desc: "ElasticSearch port (optional)"} - + - {env_var: "ES_HOST", env_value: "elasticsearch", desc: "ElasticSearch host (optional)"} + - {env_var: "ES_PORT", env_value: "9200", desc: "ElasticSearch port (optional)"} custom_compose: | version: '2' services: @@ -71,7 +68,6 @@ custom_compose: | image: alpine command: sh -c "sysctl -w vm.max_map_count=262144" privileged: true - # application setup block app_setup_block_enabled: true app_setup_block: | @@ -87,23 +83,78 @@ app_setup_block: | * `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 - +# init diagram +init_diagram: | + "diskover:latest": { + docker-mods + base { + fix-attr +\nlegacy cont-init + } + docker-mods -> base + legacy-services + custom services + init-services -> legacy-services + init-services -> custom services + custom services -> legacy-services + legacy-services -> ci-service-check + init-migrations -> init-adduser + init-nginx-end -> init-config + init-os-end -> init-config + init-config -> init-config-end + init-diskover-config -> init-config-end + init-os-end -> init-crontab-config + init-mods-end -> init-custom-files + init-eol-check -> init-diskover-config + base -> init-envfile + init-nginx-end -> init-eol-check + init-os-end -> init-folders + init-php -> init-keygen + base -> init-migrations + base -> init-mods + init-config-end -> init-mods + init-version-checks -> init-mods + init-mods -> init-mods-end + init-mods-package-install -> init-mods-end + init-mods -> init-mods-package-install + init-samples -> init-nginx + init-permissions -> init-nginx-end + base -> init-os-end + init-adduser -> init-os-end + init-envfile -> init-os-end + init-migrations -> init-os-end + init-keygen -> init-permissions + init-nginx -> init-php + init-folders -> init-samples + init-custom-files -> init-services + init-mods-end -> init-services + init-config-end -> init-version-checks + init-services -> svc-cron + svc-cron -> legacy-services + init-services -> svc-nginx + svc-nginx -> legacy-services + init-services -> svc-php-fpm + svc-php-fpm -> legacy-services + } + Base Images: { + "baseimage-alpine-nginx:3.20" <- "baseimage-alpine:3.20" + } + "diskover:latest" <- Base Images # changelog changelogs: - - { date: "06.09.24:", desc: "Rebase to Alpine 3.20. Existing users should update their nginx confs to avoid http2 deprecation warnings." } - - { date: "06.03.24:", desc: "Existing users should update: site-confs/default.conf - Cleanup default site conf." } - - { date: "06.03.24:", desc: "Rebase to Alpine 3.19 with php 8.3."} - - { date: "25.05.23:", desc: "Rebase to Alpine 3.18, deprecate armhf." } - - { date: "13.04.23:", desc: "Move ssl.conf include to default.conf." } - - { date: "02.03.23:", desc: "Set permissions on crontabs during init." } - - { date: "20.08.22:", desc: "Rebasing to alpine 3.17 with php8.1. Restructure nginx configs ([see changes announcement](https://info.linuxserver.io/issues/2022-08-20-nginx-base))." } - - { date: "25.02.22:", desc: "Add php7-sqlite3 to support rc4 release." } - - { date: "03.11.21:", desc: "Added more support for potential config files." } - - { date: "31.10.21:", desc: "Added xpack.security variable to ElasticSearch; added instructions to edit Constants.php in diskover; corrected command needed to manually generate an index in diskover" } - - { date: "11.10.21:", desc: "Updated to diskover-community v2." } - - { date: "19.11.20:", desc: "Fix pip packages." } - - { date: "19.12.19:", desc: "Rebasing to alpine 3.11." } - - { date: "28.06.19:", desc: "Rebasing to alpine 3.10." } - - { date: "12.04.19:", desc: "Rebase to Alpine 3.9." } - - { date: "23.03.19:", desc: "Switching to new Base images, shift to arm32v7 tag." } - - { date: "01.11.18:", desc: "Initial Release." } + - {date: "06.09.24:", desc: "Rebase to Alpine 3.20. Existing users should update their nginx confs to avoid http2 deprecation warnings."} + - {date: "06.03.24:", desc: "Existing users should update: site-confs/default.conf - Cleanup default site conf."} + - {date: "06.03.24:", desc: "Rebase to Alpine 3.19 with php 8.3."} + - {date: "25.05.23:", desc: "Rebase to Alpine 3.18, deprecate armhf."} + - {date: "13.04.23:", desc: "Move ssl.conf include to default.conf."} + - {date: "02.03.23:", desc: "Set permissions on crontabs during init."} + - {date: "20.08.22:", desc: "Rebasing to alpine 3.17 with php8.1. Restructure nginx configs ([see changes announcement](https://info.linuxserver.io/issues/2022-08-20-nginx-base))."} + - {date: "25.02.22:", desc: "Add php7-sqlite3 to support rc4 release."} + - {date: "03.11.21:", desc: "Added more support for potential config files."} + - {date: "31.10.21:", desc: "Added xpack.security variable to ElasticSearch; added instructions to edit Constants.php in diskover; corrected command needed to manually generate an index in diskover"} + - {date: "11.10.21:", desc: "Updated to diskover-community v2."} + - {date: "19.11.20:", desc: "Fix pip packages."} + - {date: "19.12.19:", desc: "Rebasing to alpine 3.11."} + - {date: "28.06.19:", desc: "Rebasing to alpine 3.10."} + - {date: "12.04.19:", desc: "Rebase to Alpine 3.9."} + - {date: "23.03.19:", desc: "Switching to new Base images, shift to arm32v7 tag."} + - {date: "01.11.18:", desc: "Initial Release."}