diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index b1ffe8a..0000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,37 +0,0 @@ -# Issue Title: [Brief Summary of the Issue] - -## Description - -Provide a clear and concise description of the issue: - -- What is the problem? -- Where does it occur (specific service or file)? -- Steps to reproduce (if applicable) - -## Expected Behaviour - -Describe what you expected to happen. - -## Actual Behaviour - -Describe what actually happened. - -## Screenshots (if applicable) - -Include any relevant screenshots or error logs that might help in troubleshooting. - -## Environment - -- **OS**: [e.g., Ubuntu 22.04] -- **Docker Version**: [e.g., 20.10.8] -- **Tailscale Version**: [e.g., 1.32.3] -- **Other dependencies**: [Specify versions of relevant libraries or tools] - -## Additional Context - -Add any other context about the problem here. - -## Checklist - -- [ ] I have searched for similar issues in this repository -- [ ] I have updated to the latest version (if applicable) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000..dcb5420 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,133 @@ +name: 🐞 Bug Report +description: Report a bug to help improve ScaleTail +title: '🐞 Bug: ' +type: 'Bug' +labels: 'bug' +body: + - type: markdown + attributes: + value: | + **Before you start:** + Please check if the issue has already been reported or completed by searching [existing bugs](https://github.com/tailscale-dev/ScaleTail/issues?q=label%3Abug). + - type: textarea + id: description + attributes: + label: Bug Description + description: A clear and concise (short) description of what the bug is. + placeholder: When I start the docker compose, the app crashes... + validations: + required: true + + - type: textarea + id: expected + attributes: + label: Expected Behavior + description: A clear and concise description of what you expected to happen. + placeholder: I expected the page to load a new view... + validations: + required: true + + - type: textarea + id: actual + attributes: + label: Actual Behavior + description: A clear and concise description of what actually happened. + placeholder: Instead, I got an error message saying... + validations: + required: true + + - type: textarea + id: screenshots + attributes: + label: Screenshots + description: If applicable, add screenshots to help explain your problem. + placeholder: Paste screenshots here... + validations: + required: false + + - type: dropdown + id: os + attributes: + label: Operating System + description: What operating system is ScaleTail running on? + options: + - Linux + - macOS + - Windows + - Other + validations: + required: true + + - type: input + id: tailscale + attributes: + label: Tailscale Version + description: What Tailscale version are you using? (Check Tailscale sidecar container Docker logs or run `tailscale --version' in the Tailscale sidecar container). + placeholder: '1.94.1' + validations: + required: true + + - type: input + id: docker + attributes: + label: Docker Version + description: What Docker version are you using? (Run `docker --version`). + placeholder: '24.0.6' + validations: + required: true + + - type: textarea + id: logs + attributes: + label: Relevant Logs or Error Messages + description: Please share any relevant logs, error messages. + placeholder: | + Paste any error messages or (Docker) logs here... + + To get Docker logs: docker logs + render: shell + validations: + required: false + + - type: textarea + id: compose + attributes: + label: Docker Compose Configuration + description: Please share your compose.yaml file content (remove sensitive data). + placeholder: | + Paste your compose.yaml content here... + + Please remove any sensitive information like: + - API_KEYS + - PASSWORDS + + render: yaml + validations: + required: false + + - type: textarea + id: env + attributes: + label: Environment Configuration (.env file) + description: Please share your .env file content (remove sensitive data). + placeholder: | + Paste your .env file content here... + + Please remove any sensitive information like: + - TS_KEY + - ENCRYPTION_KEY + - JWT_SECRET + + render: shell + validations: + required: false + + - type: textarea + id: additional + attributes: + label: Additional Context + description: Add any other context about the problem here. + placeholder: Any other relevant information... + validations: + required: false + \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..d3edc27 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,6 @@ +blank_issues_enabled: false +contact_links: + - name: 💬 Tailscale Discord + url: https://discord.gg/tailscale + about: For help and chatting with the community + \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml new file mode 100644 index 0000000..84331d9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -0,0 +1,50 @@ +name: ⚡️ Feature Request +description: Suggest a new feature or enhancement for ScaleTail +title: '⚡️ Feature: ' +type: 'Feature' +labels: "enhancement" +body: + - type: markdown + attributes: + value: | + This issue type is intended to be used for new features for the Tailscale sidecar or environment variables. + + **Before you start:** + Please check if the feature has already been requested by searching [existing feature requests](https://github.com/tailscale-dev/ScaleTail/issues?q=label%3Aenhancement). + - type: textarea + id: description + attributes: + label: Feature Description + description: A clear and concise description of the feature you'd like to see implemented. + placeholder: I would like to see... + validations: + required: true + + - type: textarea + id: problem + attributes: + label: Problem It Solves + description: Explain what problem this feature solves or what need it addresses. + placeholder: This would help with... + validations: + required: true + + - type: textarea + id: solution + attributes: + label: Proposed Solution + description: Describe how you envision this feature working. + placeholder: I think this could work by... + validations: + required: true + + - type: checkboxes + id: contribute + attributes: + label: Would you be willing to work on this feature? + options: + - label: Yes, I'd like to implement this feature + - label: I could help with parts of this feature + - label: No, I'm just suggesting the feature + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/new_service.yml b/.github/ISSUE_TEMPLATE/new_service.yml new file mode 100644 index 0000000..0f1d2a7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/new_service.yml @@ -0,0 +1,64 @@ +name: 🏗️ New Service Request +description: Suggest a new service for ScaleTail +title: '🏗️ New Service: ' +type: 'Feature' +labels: "new service" +body: + - type: markdown + attributes: + value: | + This issue type is intended to be used to request new services for ScaleTail. + Only services with an existing Docker Compose container on a known container image registry (e.g., Docker Hub, GitHub Container Registry, etc.) are accepted. + + **Before you start:** + Please check if the service has already been requested by searching [existing service requests](https://github.com/tailscale-dev/ScaleTail/issues?q=label%3A%22new%20service%22). + + - type: textarea + id: description + attributes: + label: Service Description + description: A clear and concise description of the service you'd like to see implemented. + placeholder: I would like to see {SERVICE} implemented... + validations: + required: true + + - type: input + id: link-to-compose + attributes: + label: Docker Compose File Link + description: Please provide a link to your Docker Compose file. + placeholder: https://link.to/service.yml + validations: + required: true + + - type: textarea + id: compose-example + attributes: + label: Docker Compose Configuration + description: If applicable, please share the Docker Compose content from the service. + placeholder: | + Paste the Docker Compose content here... + + render: yaml + validations: + required: false + + - type: input + id: link-to-website-of-service + attributes: + label: Website of Service + description: Please provide a link to the official website of the service. + placeholder: https://servicename.com/service + validations: + required: false + + - type: checkboxes + id: contribute + attributes: + label: Would you be willing to work on this service? + options: + - label: Yes, I'd like to implement this feature + - label: I could help with parts of this feature + - label: No, I'm just suggesting the feature + validations: + required: true diff --git a/README.md b/README.md index 14932ba..73d107c 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ This repository provides examples of using [Tailscale](https://tailscale.com/) i The provided configurations showcase how to set up Tailscale alongside Docker services, with a focus on ensuring connectivity, security, and ease of deployment. The examples include configurations for Tailscale authentication, state management, and service routing. -If you would like to add your own config, you can use the [service-template](templates/service-template/) or simply open an [issue](https://github.com/2Tiny2Scale/tailscale-docker-sidecar-configs/issues). +If you would like to add your own config, you can use the [service-template](templates/service-template/) or open an [issue](https://github.com/2Tiny2Scale/tailscale-docker-sidecar-configs/issues). ## Table of Contents