photoprism/.github/ISSUE_TEMPLATE/bug_report.md

86 lines
4.4 KiB
Markdown
Raw Normal View History

2021-10-23 18:09:07 +02:00
---
name: Bug Report
about: Report a new and clearly identified bug that must be fixed directly in the application
title: 'SHORT DESCRIPTION OF THE PROBLEM YOU ARE REPORTING'
2021-10-23 18:09:07 +02:00
labels: bug
assignees: ''
---
PLEASE PROCEED ONLY IF YOU ARE ABSOLUTELY SURE THAT THIS IS NOT A TECHNICAL SUPPORT INCIDENT AND/OR POSSIBLY A PROBLEM WITH SOME OTHER SOFTWARE YOU ARE USING. VISIT <https://photoprism.app/kb/getting-support> TO LEARN MORE ABOUT OUR SUPPORT OPTIONS. THANK YOU FOR YOUR CAREFUL CONSIDERATION!
---------------------------------------------------------------------------
#### 1. What does not work as described in the documentation?
2021-10-23 18:09:07 +02:00
Please be as specific as possible and explain which part of the software does not work [as documented](https://docs.photoprism.app/). "No photos found" would not be a sufficient description. Also never report [known issues](https://docs.photoprism.app/known-issues/) or [features not yet implemented](https://github.com/photoprism/photoprism/issues) as bugs. Thank you!
2022-01-10 15:05:04 +01:00
#### 2. How can we reproduce it?
2021-10-23 18:09:07 +02:00
Steps to reproduce the behavior:
2021-10-23 18:09:07 +02:00
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
If reporting an import, indexing, or performance issue, please include the number and type of pictures in your library,
as well as any configuration options you have changed e.g. for thumbnail quality.
#### 3. What behavior do you expect?
2021-10-23 18:09:07 +02:00
A clear and concise description of what you expected to happen.
#### 4. What could be the cause of your problem?
Try to determine the cause of your problem before submitting a bug report: <https://docs.photoprism.app/getting-started/troubleshooting/>
#### 5. Can you provide us with example files for testing, error logs, or screenshots?
Please add example files or screenshots that help to reproduce your problem.
You may also send files via email or share a download link: <https://photoprism.app/contact>
Learn how to diagnose frontend issues: <https://docs.photoprism.app/getting-started/troubleshooting/browsers/>
**Important: If it is an import, indexing or metadata issue, we require sample files and logs from you.** Otherwise, we will not be able to process your report. If it is an import problem specifically, please always provide us with an archive of the files before you import them so that we can actually reproduce the problem.
2022-01-10 23:32:27 +01:00
#### 6. Which software versions do you use?
(a) PhotoPrism Architecture & Build Number: AMD64, ARM64, ARMv7,...
(b) Database Type & Version: MariaDB, MySQL, SQLite,...
(c) Operating System Types & Versions: Linux, Windows, Android,...
(d) Browser Types & Versions: Firefox, Chrome, Safari on iPhone,...
(e) Browser Plugins & Ad Blockers, if any
2022-01-11 09:46:11 +01:00
The app version / build number can be found in *Settings* when you scroll to the bottom.
MySQL 8 is not officially supported anymore, see System Requirements.
Always provide database and operating system details if it is a backend, import, or indexing issue. Should it be a frontend issue, at a minimum we require you to provide web browser and operating system details.
When reporting a performance problem, we ask that you provide us with complete information about your environment, as there may be more than one cause.
2022-01-10 23:32:27 +01:00
#### 7. On what kind of device is PhotoPrism installed?
2022-01-11 10:23:31 +01:00
This is especially important if you are reporting a Performance, Import, or Indexing problem. You can skip this if you are reporting a problem found on our public demo, or if it is a completely unrelated issue, such as a broken page layout.
(a) Device / Processor Type: Raspberry Pi 4, Intel Core i7-3770, AMD Ryzen 7 3800X,...
2021-10-23 18:09:07 +02:00
(b) Physical Memory & Swap Space in GB
2022-01-10 23:32:27 +01:00
(c) Storage Type: HDD, SSD, RAID, USB, Network Storage,...
(d) anything else that might be helpful
*Always provide device, memory, and storage details if you have a backend, performance, import, or indexing issue.*
#### 8. Do you use a Reverse Proxy, Firewall, VPN, or CDN?
2021-10-23 18:09:07 +02:00
2022-01-10 23:32:27 +01:00
If yes, please specify type and version. You can skip this if you are reporting a completely unrelated issue.
Always provide this information when you have a reliability, performance, or frontend problem, such as failed uploads, connection errors, broken thumbnails, or video playback issues.
If you are using NGINX, also provide the configuration and/or consider asking the NGINX community for advice as we do not specialize in supporting their product. Docs can be found at <https://docs.photoprism.app/getting-started/proxies/nginx/>.