BUG_REPORT.yml 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144
  1. name: Bug report
  2. description: Create a report to help us improve
  3. body:
  4. - type: markdown
  5. attributes:
  6. value: |
  7. **THIS IS NOT A SUPPORT CHANNEL!**
  8. **IF YOU HAVE SUPPORT QUESTIONS ABOUT RUNNING OR CONFIGURING YOUR OWN HOME SERVER**, please ask in **[#synapse:matrix.org](https://matrix.to/#/#synapse:matrix.org)** (using a matrix.org account if necessary).
  9. If you want to report a security issue, please see https://matrix.org/security-disclosure-policy/
  10. This is a bug report form. By following the instructions below and completing the sections with your information, you will help the us to get all the necessary data to fix your issue.
  11. You can also preview your report before submitting it.
  12. - type: textarea
  13. id: description
  14. attributes:
  15. label: Description
  16. description: Describe the problem that you are experiencing
  17. validations:
  18. required: true
  19. - type: textarea
  20. id: reproduction_steps
  21. attributes:
  22. label: Steps to reproduce
  23. description: |
  24. Describe the series of steps that leads you to the problem.
  25. Describe how what happens differs from what you expected.
  26. placeholder: Tell us what you see!
  27. value: |
  28. - list the steps
  29. - that reproduce the bug
  30. - using hyphens as bullet points
  31. validations:
  32. required: true
  33. - type: markdown
  34. attributes:
  35. value: |
  36. ---
  37. **IMPORTANT**: please answer the following questions, to help us narrow down the problem.
  38. - type: input
  39. id: homeserver
  40. attributes:
  41. label: Homeserver
  42. description: Which homeserver was this issue identified on? (matrix.org, another homeserver, etc)
  43. validations:
  44. required: true
  45. - type: input
  46. id: version
  47. attributes:
  48. label: Synapse Version
  49. description: |
  50. What version of Synapse is this homeserver running?
  51. You can find the Synapse version by visiting https://yourserver.example.com/_matrix/federation/v1/version
  52. or with this command:
  53. ```
  54. $ curl http://localhost:8008/_synapse/admin/v1/server_version
  55. ```
  56. (You may need to replace `localhost:8008` if Synapse is not configured to listen on that port.)
  57. validations:
  58. required: true
  59. - type: dropdown
  60. id: install_method
  61. attributes:
  62. label: Installation Method
  63. options:
  64. - Docker (matrixdotorg/synapse)
  65. - Debian packages from packages.matrix.org
  66. - pip (from PyPI)
  67. - Other (please mention below)
  68. - I don't know
  69. validations:
  70. required: true
  71. - type: input
  72. id: database
  73. attributes:
  74. label: Database
  75. description: |
  76. Are you using SQLite or PostgreSQL? What's the version of your database?
  77. If PostgreSQL, please also answer the following:
  78. - are you using a single PostgreSQL server
  79. or [separate servers for `main` and `state`](https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#databases)?
  80. - have you previously ported from SQLite using the Synapse "portdb" script?
  81. - have you previously restored from a backup?
  82. validations:
  83. required: true
  84. - type: dropdown
  85. id: workers
  86. attributes:
  87. label: Workers
  88. description: |
  89. Are you running a single Synapse process, or are you running
  90. [2 or more workers](https://matrix-org.github.io/synapse/latest/workers.html)?
  91. options:
  92. - Single process
  93. - Multiple workers
  94. - I don't know
  95. validations:
  96. required: true
  97. - type: textarea
  98. id: platform
  99. attributes:
  100. label: Platform
  101. description: |
  102. Tell us about the environment in which your homeserver is operating...
  103. e.g. distro, hardware, if it's running in a vm/container, etc.
  104. validations:
  105. required: true
  106. - type: textarea
  107. id: config
  108. attributes:
  109. label: Configuration
  110. description: |
  111. Do you have any unusual config options turned on? If so, please provide details.
  112. - Experimental or undocumented features
  113. - [Presence](https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#presence)
  114. - [Message retention](https://matrix-org.github.io/synapse/latest/message_retention_policies.html)
  115. - [Synapse modules](https://matrix-org.github.io/synapse/latest/modules/index.html)
  116. - type: textarea
  117. id: logs
  118. attributes:
  119. label: Relevant log output
  120. description: |
  121. Please copy and paste any relevant log output as text (not images), ideally at INFO or DEBUG log level.
  122. This will be automatically formatted into code, so there is no need for backticks (`\``).
  123. Please be careful to remove any personal or private data.
  124. **Bug reports are usually impossible to diagnose without logging.**
  125. render: shell
  126. validations:
  127. required: true
  128. - type: textarea
  129. id: anything_else
  130. attributes:
  131. label: Anything else that would be useful to know?