First time setup

Author: github-actions[bot]

.github/PULL_REQUEST_TEMPLATE.md

@@ -13,7 +13,7 @@
 <!-- If this PR changes logic, consider adding additional steps or context to the instructions below. -->
 
 ```bash
-ddev add-on get https://github.com/ddev/ddev-addon-template/tarball/refs/pull/REPLACE_ME_WITH_THIS_PR_NUMBER/head
+ddev add-on get https://github.com/stasadev/ddev-redis-insight/tarball/refs/pull/REPLACE_ME_WITH_THIS_PR_NUMBER/head
 ddev restart
 ```
 

.github/scripts/first-time-setup.sh

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2025 [name of copyright owner]
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

.github/workflows/first-time-setup.yml

@@ -1,85 +1,48 @@
 [![add-on registry](https://img.shields.io/badge/DDEV-Add--on_Registry-blue)](https://addons.ddev.com)
-[![tests](https://github.com/ddev/ddev-addon-template/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/ddev/ddev-addon-template/actions/workflows/tests.yml?query=branch%3Amain)
-[![last commit](https://img.shields.io/github/last-commit/ddev/ddev-addon-template)](https://github.com/ddev/ddev-addon-template/commits)
-[![release](https://img.shields.io/github/v/release/ddev/ddev-addon-template)](https://github.com/ddev/ddev-addon-template/releases/latest)
+[![tests](https://github.com/stasadev/ddev-redis-insight/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/stasadev/ddev-redis-insight/actions/workflows/tests.yml?query=branch%3Amain)
+[![last commit](https://img.shields.io/github/last-commit/stasadev/ddev-redis-insight)](https://github.com/stasadev/ddev-redis-insight/commits)
+[![release](https://img.shields.io/github/v/release/stasadev/ddev-redis-insight)](https://github.com/stasadev/ddev-redis-insight/releases/latest)
 
-# DDEV Add-on Template <!-- omit in toc -->
+# DDEV Redis Insight
 
-* [What is DDEV Add-on Template?](#what-is-ddev-add-on-template)
-* [TL;DR](#tldr)
-* [Components of the repository](#components-of-the-repository)
-* [Getting started](#getting-started)
-* [How to debug in Github Actions](#how-to-debug-in-github-actions)
-* [Resources](#resources)
-* [Credits](#credits)
+## Overview
 
-## What is DDEV Add-on Template?
+This add-on integrates Redis Insight into your [DDEV](https://ddev.com/) project.
 
-This repository is a template for providing [DDEV](https://ddev.readthedocs.io) add-ons and services.
+## Installation
 
-In DDEV, add-ons can be installed from the command line using the `ddev add-on get` command, for example, `ddev add-on get ddev/ddev-redis` or `ddev add-on get ddev/ddev-solr`.
+```bash
+ddev add-on get stasadev/ddev-redis-insight
+ddev restart
+```
 
-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.
+After installation, make sure to commit the `.ddev` directory to version control.
 
-![template button](images/template-button.png)
+## Usage
 
-## TL;DR
+| Command | Description |
+| ------- | ----------- |
+| `ddev describe` | View service status and used ports for Redis Insight |
+| `ddev logs -s redis-insight` | Check Redis Insight logs |
 
-1. Click the green `Use this template button` (top right) > `Create a new repository`.
-2. Name your repository using the `ddev-` prefix (e.g. `ddev-foobar`).
-3. Add a meaningful description with relevant keywords for discoverability.
-4. Click `Create repository` and wait for the automated `First time setup` commit.
+## Advanced Customization
 
-> [!NOTE]
-> Automated updates to the `README.md` happen in a minute or so after creation.
+To change the Docker image:
 
-5. Clone your repository locally (use the green `<> Code` button for the URL).
-6. Prepare your add-on files and tests, see [Getting started](#getting-started) for details.
-7. Create a new PR for review and discussion (avoid committing directly to `main`, as that bypasses the collaborative process).
-8. Merge or squash your PR into `main` (squash is preferred for a cleaner commit history).
-9. Create a new [release](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository).
-10. When ready to share, make your add-on discoverable by adding the `ddev-get` [topic](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics).
+```bash
+ddev dotenv set .ddev/.env.redis-insight --redis-insight-docker-image="busybox:stable"
+ddev add-on get stasadev/ddev-redis-insight
+ddev restart
+```
 
-## Components of the repository
+Make sure to commit the `.ddev/.env.redis-insight` file to version control.
 
-* 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.
+All customization options (use with caution):
 
-## Getting started
-
-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. Add the files that need to be added to a DDEV project to the repository. If your add-on does not add a new service, remove `docker-compose.<addon-name>.yaml` file.
-4. Update the `install.yaml` to give the necessary instructions for installing the add-on:
-
-   * 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).
-
-5. Update `tests/test.bats` to provide a reasonable test for your repository. In most cases, you only need to modify the `health_checks()` function. 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) and its [libraries](https://github.com/ztombol/bats-docs) 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/).
-6. When everything is working, including the tests, you can push the repository to GitHub.
-7. Create a [release](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository) on GitHub.
-8. Test manually with `ddev add-on get <owner/repo>`.
-9. You can test PRs with `ddev add-on get https://github.com/<user>/<repo>/tarball/<branch>` or `https://github.com/<user>/<repo>/tarball/refs/pull/<pr-number>/head`.
-10. You can test add-ons locally without GitHub by downloading them, making changes and running `ddev add-on get /path/to/add-on-directory`.
-11. Update the [`README.md`](./README_ADDON.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. Add a good short description to your repo, and add the `ddev-get` [topic](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics). It will immediately be added to the list provided by `ddev add-on list --all`.
-13. 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.
-
-## How to debug in Github Actions
-
-See [full instructions](./README_DEBUG.md).
-
-## Resources
-
-* [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))
-* [Advanced Add-On Techniques](https://ddev.com/blog/advanced-add-on-contributor-training/)
-* [DDEV Add-on Maintenance Guide](https://ddev.com/blog/ddev-add-on-maintenance-guide/)
-* [DDEV docs](https://ddev.readthedocs.io/en/stable/users/extend/additional-services/)
-* [DDEV Add-on Registry](https://addons.ddev.com/)
+| Variable | Flag | Default |
+| -------- | ---- | ------- |
+| `REDIS_INSIGHT_DOCKER_IMAGE` | `--redis-insight-docker-image` | `busybox:stable` |
 
 ## Credits
 
-**Contributed and maintained by @CONTRIBUTOR**
+**Contributed and maintained by [@stasadev](https://github.com/stasadev)**

LICENSE

@@ -1,9 +1,9 @@
 #ddev-generated
-# Simple template to demonstrate addon-template
+# Simple template to demonstrate redis-insight
 services:
-  addon-template:
-    container_name: ddev-${DDEV_SITENAME}-addon-template
-    image: ${ADDON_TEMPLATE_DOCKER_IMAGE:-busybox:stable}
+  redis-insight:
+    container_name: ddev-${DDEV_SITENAME}-redis-insight
+    image: ${REDIS_INSIGHT_DOCKER_IMAGE:-busybox:stable}
     command: tail -f /dev/null
     restart: "no"
     # These labels ensure this service is discoverable by DDEV.