Collecting Debug Information¶
Make sure Logs is enabled under Settings > General so you can see log messages in the Web UI.
Live Logs
The continuously updated live logs in Library > Logs are especially useful for diagnosing indexing and import issues, but also display other types of logs (depending on the log level):
- Navigate to Library
- Open the Logs tab
Only a limited number of messages are visible in the Web App to reduce memory usage. You can see all messages in the Docker Logs. This may be more convenient if you are looking for information on a specific file or want to attach your full logs to a support request.
Errors and Warnings
- Expand the main navigation
- Open the Library sub navigation
- Navigate to Library > Errors
If you have a frontend issue, it is often helpful to check the browser console for errors and warnings. A console is available in all modern browsers and can be activated via keyboard shortcuts or the browser menu.
Problems with the user interface can be caused by a bug or an incompatible browser: Some features may not be supported by non-standard browsers, as well as nightly, unofficial, or outdated versions.
In case you don't see any log messages, try reloading the page, as the problem may occur while the page is loading.
Chrome, Chromium, and Edge
- press ⌘+Option+J (Mac) or Ctrl+Shift+J (Windows, Linux, Chrome OS) to go directly to the Developer Tools
- or, navigate to More tools > Developer tools in the browser menu and open the Console tab
Firefox
- press ⌘+Option+K (Mac) or Ctrl+Shift+K (Windows) to go directly to the Firefox Web Console panel
- or, navigate to Web Development > Web Console in the menu and open the Console panel
Safari
Before you can access the console in Safari, you first need to enable the Develop menu:
- Choose Safari Menu > Preferences and select the Advanced Tab
- Select "Show Develop menu in menu bar"
Once the Develop menu is enabled:
- press Option+⌘+C to go directly to the Javascript Console
- or, navigate to Develop > Show Javascript Console in the browser menu
You can run this command to watch the Docker service logs, including the last 100 messages (omit --tail=100
to see them all, and -f
to output only the last logs without watching them):
docker compose logs -f --tail=100
To enable debug mode, set PHOTOPRISM_DEBUG
to "true"
in the environment:
section
of the photoprism
service (or use the --debug
flag when running the photoprism
command directly):
services:
photoprism:
environment:
PHOTOPRISM_DEBUG: "true"
Then restart all services for the changes to take effect. It can be helpful to keep Docker running in the foreground
while debugging so that log messages are displayed directly. To do this, omit the -d
parameter when restarting:
docker compose stop
docker compose up
If you see no errors or no logs at all, you may have started the server on a different host and/or port. There could also be an issue with your browser, browser plugins, firewall settings, or other tools you may have installed.
The default Docker Compose config filename is docker-compose.yml
. For simplicity, it doesn't need to be specified when running docker compose
or docker-compose
in the same directory. Config files for other apps or instances should be placed in separate folders.
We kindly ask you not to report bugs via GitHub Issues unless you are certain to have found a fully reproducible and previously unreported issue that must be fixed directly in the app. Ask for technical support if you need help, it could be a local configuration problem, or a misunderstanding in how the software works.