Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 56 additions & 0 deletions .github/ISSUE_TEMPLATE/01-feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: Feature request
description: Suggest an idea or improvement for Defguard
title: "[Feature]: "
labels:
- feature
type: feature

body:
- type: markdown
attributes:
value: |
Thank you for suggesting a feature. Your feedback helps improve Defguard.

- type: textarea
id: problem
attributes:
label: Problem description
description: What problem are you trying to solve? Attach screenshots or recording if it helps illustrate the problem.
placeholder: |
Describe the limitation, friction, or missing capability.
Example: "Users cannot restrict access based on device posture..."
validations:
required: true

- type: textarea
id: proposed_solution
attributes:
label: Proposed solution
description: Describe the solution you would like. Attach mockups or diagrams if you have them.
placeholder: |
Describe the desired behavior, API, UI, or workflow.
Include examples if possible.
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Alternatives considered
description: Any alternative solutions or workarounds you've considered
placeholder: |
Example: "Currently we use separate locations, but this is hard to manage..."
validations:
required: false

- type: dropdown
id: impact
attributes:
label: Impact
description: How important is this feature for you?
options:
- Nice to have
- Important
- Critical / blocking our usage
validations:
required: true
124 changes: 124 additions & 0 deletions .github/ISSUE_TEMPLATE/02-bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
name: Bug report
description: Report a problem in Defguard so we can reproduce and fix it.
title: "[Bug]: "
labels:
- bug
type: bug

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to report a bug.

**Privacy note:** This issue tracker is public. Do not include sensitive data such as secrets, private keys, tokens, passwords, internal domains, or customer data. All data should be anonymised and any secrets must be redacted.

- type: textarea
id: summary
attributes:
label: Summary
description: A clear, one-paragraph description of what’s broken.
placeholder: "After enabling MFA for a user, Desktop client cannot start a session; it loops on …"
validations:
required: true

- type: textarea
id: steps
attributes:
label: Steps to reproduce
description: Numbered steps help us reproduce reliably. Attach screenshots or recordings if they help illustrate the steps.
placeholder: |
1. Go to …
2. Click …
3. Configure …
4. Observe …
validations:
required: true

- type: textarea
id: expected
attributes:
label: Expected behavior
description: What should happen if the bug were fixed?
placeholder: "VPN connects successfully and a session is established."
validations:
required: true

- type: textarea
id: actual
attributes:
label: Actual behavior
description: What happens instead? Include error messages, screenshots, or recordings if they help illustrate the issue.
placeholder: "VPN connection fails with … / UI shows … / API returns …"
validations:
required: true

- type: input
id: version
attributes:
label: Defguard version
description: Exact versions of all components.
placeholder: "Core: v1.6.0, Gateway: v1.6.0, Edge: v1.6.0, Desktop client: v1.6.0, Mobile client: v1.6.0."
validations:
required: true

- type: input
id: environment
attributes:
label: Environment details
description: Operating systems of all components.
placeholder: "Core: Ubuntu 24.04, Gateway: Ubuntu 24.04, Edge: Ubuntu 24.04, Desktop client: macOS 15.x, Mobile client: iOS 18."
validations:
required: true

- type: dropdown
id: deployment
attributes:
label: Deployment / install method
description: How is Defguard installed?
multiple: false
options:
- One-line script
- Standalone packages
- Docker / Docker Compose
- Kubernetes / Helm
- Terraform
- AMI
- Custom
validations:
required: true

- type: textarea
id: logs
attributes:
label: Relevant logs / output
description: Paste only what’s necessary. Please redact secrets (tokens, private IPs, domains) if needed. Enable DEBUG log level if you can (https://docs.defguard.net/support-1/how-to-submit-an-issue#id-1.-enable-debug-logging).
render: shell
placeholder: |
# Core logs
[2024-06-01T12:00:00Z] ERROR: ...

# Edge logs
[2024-06-01T12:00:00Z] ERROR: ...

# Gateway logs
[2024-06-01T12:00:00Z] ERROR: ...

# Desktop client logs (you can find them in the app's settings)
[2024-06-01T12:00:00Z] ERROR: ...

# Mobile client logs (you can find them in the app's main menu - View Application Logs)
[2024-06-01T12:00:00Z] ERROR: ...
validations:
required: false

- type: textarea
id: config
attributes:
label: Relevant configuration (redacted)
description: If configuration is involved (LDAP, OIDC, WireGuard, gRPC certs), paste the minimum snippet.
render: yaml
placeholder: |
# Redact secrets/certs/private keys
validations:
required: false
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/03-internal.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: Internal issue
description: Internal Defguard team use only
labels:
- internal
type: task

body:
- type: markdown
attributes:
value: |
This template is intended for internal Defguard team use.

- type: textarea
id: description
attributes:
label: Description
placeholder: Detailed description, context, links, notes
validations:
required: false
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Defguard Troubleshooting Guide
url: https://docs.defguard.net/support-1/troubleshooting
about: Make sure to check the troubleshooting guide before submitting an issue. It has solutions for common problems and can help you debug faster.
- name: Open a discussion to get help from the community
url: https://github.com/DefGuard/defguard/discussions/new/choose
about: Having trouble with Defguard deployment or configuration? Reach out to our community for help.
Loading