23 Commits

Author SHA1 Message Date
ed8ff1dd66 chore: version bump 2025-05-03 02:12:09 +01:00
ecf6a6fe62 chore: version bump issue templates 2025-05-01 04:25:34 +01:00
c0bb3430bb chore: add v0.1.2 2025-04-29 02:19:30 +01:00
073803d05a chore: remove github issue template 2025-04-29 01:05:11 +01:00
f99b483bce chore: update messaging for github issues 2025-04-28 15:15:33 +01:00
e0c0ac7c45 chore: re-add github issue template 2025-04-28 15:10:54 +01:00
2b3083143d revert: add GitHub template
This reverts commit afd65d3bcb.
2025-04-28 15:10:22 +01:00
afd65d3bcb chore: add GitHub template 2025-04-28 15:09:07 +01:00
120f3f3b67 fix: incorrect title/labels 2025-04-28 13:41:08 +01:00
59da5d315d chore: move template message to bottom of body 2025-04-28 13:40:26 +01:00
35321a56b8 chore: add enhancement template 2025-04-28 13:40:04 +01:00
ea7cec2777 chore: add feature request template 2025-04-28 13:00:05 +01:00
a6a4ceceb8 chore: minor revision to bug report 2025-04-28 12:59:54 +01:00
f63779e5d3 chore: update bug labels for report 2025-04-28 12:42:40 +01:00
14964be220 chore: add bug report template 2025-04-28 12:41:29 +01:00
9b3813cde0 chore: added missing change in 0.1.0 2025-04-28 02:37:10 +01:00
5824678ff9 chore: add v0.1.1 2025-04-28 02:32:28 +01:00
77e48ed460 fix: amend date for 0.1.0 2025-04-28 00:00:04 +01:00
586671a52a chore: update docker-compose example 2025-04-27 23:49:49 +01:00
ce6bcd2f88 feat: add .env file 2025-04-27 23:47:08 +01:00
a78534b3b4 chore: remove outdated readme 2025-04-27 23:46:52 +01:00
6827099f44 chore: update example compose file 2025-04-27 23:46:42 +01:00
76454300f2 feat: version bump 2025-04-27 23:46:29 +01:00
8 changed files with 210 additions and 45 deletions

17
.env Normal file
View File

@@ -0,0 +1,17 @@
### Photon Environment Variables
PHOTON_PORT=8090
SHARE_DOMAIN=localhost:8080
USER_EMAIL=photon@jrdn.dev
SHARE_URL_SCHEME=http
DATA_PATH=./data
### Photon Worker Environment Variables
SCAN_RATE=10
### Database Environment Variables
MYSQL_HOST=db
MYSQL_DATABASE=photon
MYSQL_USER=photon
MYSQL_PASSWORD=changeme
MYSQL_ROOT_PASSWORD=pleasechangeme

View File

@@ -0,0 +1,30 @@
name: Bug Report
about: File a bug report
title: "[Bug] ..."
labels: "Kind/Bug"
body:
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Describe the bug and what the expected behaviour was.
placeholder: A bug happened!
validations:
required: true
- type: dropdown
id: version
attributes:
label: Version
description: What version of Photon are you running? You can find this in the footer of the app.
options:
- 0.1.3 (Latest)
- 0.1.2
- 0.1.1
- 0.1.0
validations:
required: true
- type: markdown
attributes:
value: |
This issue was created using the bug report template.
visible: [content]

View File

@@ -0,0 +1 @@
blank_issues_enabled: false

View File

@@ -0,0 +1,30 @@
name: Enhancement Request
about: Suggest a way things could be improved
title: "[Enhancement] ..."
labels: "Kind/Enhancement"
body:
- type: textarea
id: idea
attributes:
label: What is your idea?
description: Describe the feature you would like to see. Attach any screenshots or mockups if you have them.
placeholder: I would like to see...
validations:
required: true
- type: dropdown
id: version
attributes:
label: Version
description: What version of Photon are you running? You can find this in the footer of the app.
options:
- 0.1.3 (Latest)
- 0.1.2
- 0.1.1
- 0.1.0
validations:
required: true
- type: markdown
attributes:
value: |
This issue was created using the feature template.
visible: [content]

View File

@@ -0,0 +1,30 @@
name: Feature Request
about: Suggest an idea for this project
title: "[Feature] ..."
labels: "Kind/Feature"
body:
- type: textarea
id: idea
attributes:
label: What is your idea?
description: Describe the feature you would like to see. Attach any screenshots or mockups if you have them.
placeholder: I would like to see...
validations:
required: true
- type: dropdown
id: version
attributes:
label: Version
description: What version of Photon are you running? You can find this in the footer of the app.
options:
- 0.1.3 (Latest)
- 0.1.2
- 0.1.1
- 0.1.0
validations:
required: true
- type: markdown
attributes:
value: |
This issue was created using the feature template.
visible: [content]

View File

@@ -6,32 +6,4 @@ To deploy Photon, use the included `docker-compose-example.yml`.
Ensure you have a data folder that contains your screenshots. Current supported mimetypes are `JPG`, `PNG`, `GIF` and `MP4`. Ensure you have a data folder that contains your screenshots. Current supported mimetypes are `JPG`, `PNG`, `GIF` and `MP4`.
```
services:
photon:
container_name: photon_dashboard
image: git.jrdn.dev/jordanwalster/photon-dashboard:latest
ports:
- 8090:80
volumes:
- type: bind
source: ./data
target: /var/www/html/data
bind:
propagation: rshared
environment:
ADMIN_DOMAIN: photon.jrdn.dev
SHARE_DOMAIN: ss.example.com
USER_EMAIL: me@example.com
```
There are additional environment variables that can be set to enable experimental features (defaults are set to false):
| Environment Variable | Values | Default | Description |
| -------------------- |:-----------------:|:-------:| ---------------------------------- |
| TAGS_ENABLED | `true` \| `false` | false | Enables the tagging functionality |
| SEARCH_ENABLED | `true` \| `false` | false | Enables screenshot search |
| PAGE_LIMIT | `int` | 24 | Override the default page limit |
You can find the container image history [here](https://git.jrdn.dev/jordanwalster/-/packages/container/photon-dashboard/versions). You can find the container image history [here](https://git.jrdn.dev/jordanwalster/-/packages/container/photon-dashboard/versions).

View File

@@ -2,12 +2,76 @@
All notable changes to this project will be documented in this file. All notable changes to this project will be documented in this file.
## [v0.0.9] - 2025-04-21 ## [v0.1.3] - 2025-05-03
### Added
- Upload button for uploading via web dashboard.
### Changed
- Column dropdown is now a button that switches between options.
- Some old icons have been switched to FontAwesome icons.
- Sidebar remaining open flag is now set by a cookie instead of a session token.
### Fixed ### Fixed
- Occasional redirection to a previous page when deleting or restoring images. - Page refresh loop when changing column count.
- Assign tags field remembers existing tags. - Scrollbar failing to show after page content changes.
- Allowing removal of tags from an image. - Bug where images with capitalised file extensions do not appear in the grid.
- Unable to use multi select actions on images with spaces in their names.
### Removed
- `TAGS_ENABLED`, `SEARCH_ENABLED` and `TRASH_ENABLED` environment variables, these are now permanently enabled.
## [v0.1.2] - 2025-04-29
> [!WARNING]
> This introduces a breaking change that requires the latest version of the photon-worker container image.
### Added
- Image compression worker function, decreasing page load times.
## [v0.1.1] - 2025-04-28
### Fixed
- Columns not updating when selected in dropdown.
- Icons missing from context menu on search page.
### Changed
- Version numbers are now taken from container image.
## [v0.1.0] - 2025-04-27
### Fixed
- Sharing URL Scheme set to `https` regardless of setting in environment variables.
- Search not clearing the first two characters after emptying search field.
- Error handing for existing tag names.
- Double click bug on modals.
- Permanently deleting images did not remove from db
- Pagination on tagged pages showed in the corner.
### Changed
- Upgraded to PHP 8.
- Database engine now using MySQL.
- Mandatory setting for admin url removed.
### Added
- Search by image content using OCR via worker container.
- Button for applying actions to multiple images at a time.
- Automatic migration tool for SQLite to MySQL
- Tag not found page for nonexistent tags.
- Custom time zone environment variable.
- Form validation using JS for frontend.
- Messaging for no OCR table.
- Icons on context menu.
### Removed
- Image format being shown in corner.
## [v0.0.9] - 2025-04-21
### Added
- Introduced search functionality.
- Rename tag button.
- Restore all button for trashed images.
### Changed ### Changed
- Pages no longer use query strings and instead use paths. - Pages no longer use query strings and instead use paths.
@@ -16,10 +80,10 @@ All notable changes to this project will be documented in this file.
- File format shown in badge. - File format shown in badge.
- Links are now path based instead of query string based. - Links are now path based instead of query string based.
### Added ### Fixed
- Introduced search functionality. - Occasional redirection to a previous page when deleting or restoring images.
- Rename tag button. - Assign tags field remembers existing tags.
- Restore all button for trashed images. - Allowing removal of tags from an image.
## [v0.0.8] - 2025-01-30 ## [v0.0.8] - 2025-01-30

View File

@@ -2,17 +2,38 @@ services:
photon: photon:
container_name: photon_dashboard container_name: photon_dashboard
image: git.jrdn.dev/jordanwalster/photon-dashboard:latest image: git.jrdn.dev/jordanwalster/photon-dashboard:latest
ports:
- 8090:80
volumes: volumes:
- ./db:/var/www/html/db # Only required if migrating from SQLite
- type: bind - type: bind
source: ./data source: ${DATA_PATH}
target: /var/www/html/data target: /var/www/html/data
bind: bind:
propagation: rshared propagation: rshared
environment: ports:
ADMIN_DOMAIN: photon.jrdn.dev - ${PHOTON_PORT:-8090}:80
SHARE_DOMAIN: ss.example.com env_file:
USER_EMAIL: me@example.com - .env
TAGS_ENABLED: false web:
SEARCH_ENABLED: false container_name: public_web
image: nginx
ports:
- 8080:80
volumes:
- ${DATA_PATH}:/usr/share/nginx/html:ro
worker:
container_name: photon_worker
image: git.jrdn.dev/jordanwalster/photon-worker:latest
volumes:
- ${DATA_PATH}:/var/www/html/data
env_file:
- .env
db:
container_name: photon_db
image: mariadb
volumes:
- db:/var/lib/mysql
env_file:
- .env
volumes:
db: