Initial setup for imgproxy ddev add-on

README.md

@@ -1,53 +1,29 @@
-[![tests](https://github.com/ddev/ddev-addon-template/actions/workflows/tests.yml/badge.svg)](https://github.com/ddev/ddev-addon-template/actions/workflows/tests.yml) ![project is maintained](https://img.shields.io/maintenance/yes/2024.svg)
+# DDEV imgproxy
 
-# ddev-addon-template <!-- omit in toc -->
+## What is this?
 
-* [What is ddev-addon-template?](#what-is-ddev-addon-template)
-* [Components of the repository](#components-of-the-repository)
-* [Getting started](#getting-started)
-* [How to debug in Github Actions](./README_DEBUG.md)
+This repository allows you to quickly install an [imgproxy](https://imgproxy.net/) server into a [DDEV](https://ddev.readthedocs.io) project using the instructions below.
 
-## What is ddev-addon-template?
+## Installation
 
-This repository is a template for providing [DDEV](https://ddev.readthedocs.io) add-ons and services.
+Uses [imgproxy official image](https://hub.docker.com/r/darthsim/imgproxy/)
 
-In DDEV addons can be installed from the command line using the `ddev add-on get` command (or `ddev get` for versions of DDEV prior to v1.23.5), for example, `ddev add-on get ddev/ddev-redis` or `ddev add-on get ddev/ddev-solr`.
 
-This repository is a quick way to get started. You can create a new repo from this one by clicking the template button in the top right corner of the page.
+```sh
+ddev add-on get barbieswimcrew/ddev-imgproxy && ddev restart
+```
 
-![template button](images/template-button.png)
+For earlier versions of DDEV run
 
-## Components of the repository
+```sh
+ddev get barbieswimcrew/ddev-imgproxy && ddev restart
+```
 
-* The fundamental contents of the add-on service or other component. For example, in this template there is a [docker-compose.addon-template.yaml](docker-compose.addon-template.yaml) file.
-* An [install.yaml](install.yaml) file that describes how to install the service or other component.
-* A test suite in [test.bats](tests/test.bats) that makes sure the service continues to work as expected.
-* [Github actions setup](.github/workflows/tests.yml) so that the tests run automatically when you push to the repository.
 
-## Getting started
+Navigating http://localhost:8081 should display the imgproxy default landingpage.
 
-1. Choose a good descriptive name for your add-on. It should probably start with "ddev-" and include the basic service or functionality. If it's particular to a specific CMS, perhaps `ddev-<CMS>-servicename`.
-2. Create the new template repository by using the template button.
-3. Globally replace "addon-template" with the name of your add-on.
-4. Add the files that need to be added to a DDEV project to the repository. For example, you might replace `docker-compose.addon-template.yaml` with the `docker-compose.*.yaml` for your recipe.
-5. Update the `install.yaml` to give the necessary instructions for installing the add-on:
+## Explanation
 
-   * The fundamental line is the `project_files` directive, a list of files to be copied from this repo into the project `.ddev` directory.
-   * You can optionally add files to the `global_files` directive as well, which will cause files to be placed in the global `.ddev` directory, `~/.ddev`.
-   * Finally, `pre_install_commands` and `post_install_commands` are supported. These can use the host-side environment variables documented [in DDEV docs](https://ddev.readthedocs.io/en/stable/users/extend/custom-commands/#environment-variables-provided).
+This recipe for [DDEV](https://ddev.readthedocs.io) installs a [.ddev/docker-compose.imgproxy.yaml](docker-compose.imgproxy.yaml) using the `darthsim/imgproxy` Docker image.
 
-6. Update `tests/test.bats` to provide a reasonable test for your repository. Tests will run automatically on every push to the repository, and periodically each night. Please make sure to address test failures when they happen. Others will be depending on you. Bats is a testing framework that just uses Bash. To run a Bats test locally, you have to [install bats-core](https://bats-core.readthedocs.io/en/stable/installation.html) first. Then you download your add-on, and finally run `bats ./tests/test.bats` within the root of the uncompressed directory. To learn more about Bats see the [documentation](https://bats-core.readthedocs.io/en/stable/).
-7. When everything is working, including the tests, you can push the repository to GitHub.
-8. Create a [release](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository) on GitHub.
-9. Test manually with `ddev add-on get <owner/repo>`.
-10. You can test PRs with `ddev add-on get https://github.com/<user>/<repo>/tarball/<branch>`
-11. Update the `README.md` to describe the add-on, how to use it, and how to contribute. If there are any manual actions that have to be taken, please explain them. If it requires special configuration of the using project, please explain how to do those. Examples in [ddev/ddev-solr](https://github.com/ddev/ddev-solr), [ddev/ddev-memcached](https://github.com/ddev/ddev-memcached), and (advanced) [ddev-platformsh](https://github.com/ddev/ddev-platformsh).
-12. Update the `README.md` header in Title Case format, for example, use `# DDEV Redis`, not `# ddev-redis`.
-13. Add a good short description to your repo, and add the [topic](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics) "ddev-get". It will immediately be added to the list provided by `ddev add-on list --all`.
-14. When it has matured you will hopefully want to have it become an "official" maintained add-on. Open an issue in the [DDEV queue](https://github.com/ddev/ddev/issues) for that.
-
-Add-ons were covered in [DDEV Add-ons: Creating, maintaining, testing](https://www.youtube.com/watch?v=TmXqQe48iqE) (part of the [DDEV Contributor Live Training](https://ddev.com/blog/contributor-training)).
-
-Note that more advanced techniques are discussed in [Advanced Add-On Techniques](https://ddev.com/blog/advanced-add-on-contributor-training/) and [DDEV docs](https://ddev.readthedocs.io/en/stable/users/extend/additional-services/).
-
-**Contributed and maintained by `@CONTRIBUTOR`**
+**Contributed and maintained by [@barbieswimcrew](https://github.com/barbieswimcrew)**

docker-compose.imgproxy.yaml

@@ -0,0 +1,20 @@
+#ddev-generated
+services:
+    imgproxy:
+        container_name: ddev-${DDEV_SITENAME}-imgproxy
+        hostname: ${DDEV_SITENAME}-imgproxy
+        image: darthsim/imgproxy:latest
+        labels:
+            com.ddev.site-name: ${DDEV_SITENAME}
+            com.ddev.approot: $DDEV_APPROOT
+        networks: [default, ddev_default]
+        environment:
+            IMGPROXY_BASE_URL: http://web:80
+            IMGPROXY_ALLOW_ORIGIN: "*"
+        ports:
+            - "8081:8080"
+        volumes:
+            - "imgproxy-cache:/imgproxy/cache"
+
+volumes:
+    imgproxy-cache:

install.yaml

@@ -1,118 +1,3 @@
-# Details about the install.yaml file are at https://ddev.readthedocs.io/en/stable/users/extend/additional-services/#sections-and-features-of-ddev-get-add-on-installyaml
-
-name: addon-template
-
-# pre_install_actions - list of actions to run before installing the addon.
-# Examples would be removing an extraneous docker volume,
-# or doing a sanity check for requirements.
-# DDEV environment variables can be interpolated into these actions
-# pre_install_actions are executed in the context of the target project's root directory.
-pre_install_actions:
-  # - |
-  #   #ddev-description:Check architecture type for incompatible arm64 type
-  #   if [ "$(uname -m)" = "arm64" -o "$(uname -m)" = "aarch64" ]; then
-  #     echo "This package does not work on arm64 (Apple Silicon) machines";
-  #     exit 1;
-  #   fi
-
-  # - "docker volume rm ddev-${DDEV_PROJECT}_solr 2>/dev/null || true"
-
-  # You can also check for client DDEV version with ddev_version_constraint (see below).
-  # - |
-  #   #ddev-description:Checking DDEV version
-  #   if ! ( ddev debug capabilities 2>/dev/null | grep corepack >/dev/null 2>&1 ) ; then
-  #     echo "This add-on requires DDEV v1.23+ or higher, please upgrade." && exit 2
-  #   fi
-
-  # - 'echo "what is your platform.sh token" && read x'
-
-  # This item shows templating using DDEV environment variables.
-  # - |
-  #   #ddev-description:Touch a file to create it
-  #   touch ${DDEV_APPROOT}/.ddev/somefile.${DDEV_PROJECT_TYPE}.${DDEV_DOCROOT}.txt
-
-  # This item shows complex go templating possibilities based on yaml_read_files
-  # - |
-  #   #ddev-description:Create a config.platformsh.yaml
-  #   cat <<EOF >${DDEV_APPROOT}/.ddev/config.platformsh.yaml
-  #   php_version: {{ trimPrefix "php:" .platformapp.type }}
-  #   database:
-  #     type: {{ regexReplaceAll ":.*$" .services.db.type "" }}
-  #     version: {{ regexReplaceAll "^.*:" .services.db.type "" }}
-
-  #   docroot: {{ dig "web" "locations" "/" "root" "notfound" .platformapp }}
-  #   {{- if eq .platformapp.build.flavor "composer" }}
-  #   hooks:
-  #     post-start:
-  #       - composer: install
-  #   {{- if .platformapp.hooks.deploy }}
-  #       - exec: "{{ trimAll "\n" .platformapp.hooks.deploy | splitList "\n" | join ` && ` }}"
-  #   {{- end }}
-  #   {{- end }}
-
-  #   EOF
-
-# list of files and directories listed that are copied into project .ddev directory
-# Each file should contain #ddev-generated so it can be replaced by a later `ddev add-on get`
-# if it hasn't been modified by the user.
-# DDEV environment variables can be interpolated into these filenames
-# If you use directories, they must be directories that are managed
-# by this add-on, or removal could remove things that are not owned by it
+name: imgproxy
 project_files:
-  - docker-compose.addon-template.yaml
-  # - commands/web/add-on-command
-  # - commands/host/add-on-command-host
-  # - web-build/Dockerfile.addon-template
-  # - some-directory/file1.txt
-  # - some-directory/file2.txt
-  # - extra_files_dir_created_by_this_template/
-  # - somefile.sh
-
-# List of files and directories that are copied into the global .ddev directory
-# DDEV environment variables can be interpolated into these filenames
-# Note that if these files are used by a team, you will need to automate their installation
-# by adding `ddev add-on get` to your workflow to ensure that everyone has them.
-# Otherwise, use 'project_files' to commit them to the repository.
-global_files:
-  # - commands/web/add-on-command
-  # - homeadditions/some-file.txt
-
-# Version constraint for DDEV that will be validated against the running DDEV executable
-# and prevent add-on from being installed if it doesn't validate.
-# See https://github.com/Masterminds/semver#checking-version-constraints for constraint rules.
-# Available with DDEV v1.23.4+, and works only for DDEV v1.23.4+ binaries
-# example: ddev_version_constraint: '>= v1.23.4'
-ddev_version_constraint: ''
-
-# List of add-on names that this add-on depends on
-dependencies:
-  # - redis
-
-# DDEV environment variables can be interpolated into these actions.
-# post_install_actions are executed in the context of the target project's .ddev directory.
-post_install_actions:
-  # - chmod +x ~/.ddev/commands/web/somecommand
-  # - touch ${DDEV_APPROOT}/somefile.${GOOS}.${DDEV_WEBSERVER}
-  # - perl -pi -e 's/oldstring/newstring/g' ${DDEV_APPROOT}/.ddev/docker-compose.addon-template.yaml
-
-# Shell actions that can be done during removal of the add-on.
-# Files listed in project_files section will be automatically removed here if they contain #ddev-generated line.
-# removal_actions are executed in the context of the target project's .ddev directory.
-removal_actions:
-  # - rm ~/.ddev/commands/web/somecommand
-  # - |
-  #   if [ -f ${DDEV_APPROOT}/.ddev/docker-compose.addon-template_extras.yaml ]; then
-  #     if grep -q '#ddev-generated' ${DDEV_APPROOT}/.ddev/docker-compose.addon-template_extras.yaml; then
-  #       rm -f ${DDEV_APPROOT}/.ddev/docker-compose.addon-template_extras.yaml
-  #     else
-  #       echo "Unwilling to remove '${DDEV_APPROOT}/.ddev/docker-compose.addon-template_extras.yaml' because it does not have #ddev-generated in it; you can manually delete it if it is safe to delete."
-  #     fi
-  #   fi
-
-# Advanced usage - YAML files can be read in and then used as go template actions
-# in pre_install_actions and post_install_actions
-# See example in
-# https://github.com/ddev/ddev/blob/master/cmd/ddev/cmd/testdata/TestCmdAddonComplex/recipe/install.yaml
-yaml_read_files:
-  # someyaml: someyaml.yaml
-  # otheryaml: someotheryaml.yaml
+  - docker-compose.imgproxy.yaml

tests/test.bats

@@ -1,9 +1,9 @@
 setup() {
   set -eu -o pipefail
   export DIR="$( cd "$( dirname "$BATS_TEST_FILENAME" )" >/dev/null 2>&1 && pwd )/.."
-  export TESTDIR=~/tmp/test-addon-template
+  export TESTDIR=~/tmp/test-imgproxy
   mkdir -p $TESTDIR
-  export PROJNAME=test-addon-template
+  export PROJNAME=test-imgproxy
   export DDEV_NONINTERACTIVE=true
   ddev delete -Oy ${PROJNAME} >/dev/null 2>&1 || true
   cd "${TESTDIR}"
@@ -12,9 +12,7 @@ setup() {
 }
 
 health_checks() {
-  # Do something useful here that verifies the add-on
-  # ddev exec "curl -s elasticsearch:9200" | grep "${PROJNAME}-elasticsearch"
-  ddev exec "curl -s https://localhost:443/"
+  ddev exec "curl -s http://imgproxy:8080"
 }
 
 teardown() {
@@ -37,8 +35,8 @@ teardown() {
 @test "install from release" {
   set -eu -o pipefail
   cd ${TESTDIR} || ( printf "unable to cd to ${TESTDIR}\n" && exit 1 )
-  echo "# ddev add-on get ddev/ddev-addon-template with project ${PROJNAME} in ${TESTDIR} ($(pwd))" >&3
-  ddev add-on get ddev/ddev-addon-template
+  echo "# ddev add-on get barbieswimcrew/ddev-imgproxy with project ${PROJNAME} in ${TESTDIR} ($(pwd))" >&3
+  ddev add-on get barbieswimcrew/ddev-imgproxy
   ddev restart >/dev/null
   health_checks
 }