diff --git a/README.md b/README.md index 889f047..47e6695 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ![Photon Logo](/logo.png) -![Version](https://img.shields.io/badge/version-v1.0.2-success) +![Version](https://img.shields.io/badge/version-v1.0.3-success) ![Docker](https://img.shields.io/badge/docker-grey?logo=docker) A modern, self-hosted PHP screenshot and media management dashboard with powerful organization features, sharing capabilities, and a clean web interface. @@ -10,7 +10,7 @@ A modern, self-hosted PHP screenshot and media management dashboard with powerfu The project consists of three main components: 1. **Photon Dashboard** (`photon`): Web interface for managing screenshots. -2. **Photon Worker** (`worker`): Background processing and file scanning. +2. **Photon Worker** (`worker`): Background processes (OCR and thumbnail generation). 3. **MariaDB Database** (`db`): Stores metadata and application data. Keep up-to-date on new releases by following the [changelog](./changelog.md). @@ -59,29 +59,6 @@ An external authentication proxy is recommended to protect your dashboard from u ## Configuration -### Environment Variables - -Copy the `.env` file and customize these key settings: - -#### Dashboard Settings -- `PHOTON_PORT`: Web interface port (default: 8090) -- `USER_EMAIL`: Admin email address -- `DATA_PATH`: Path to your screenshots folder - -#### Worker Settings -- `SCAN_RATE`: File scanning interval in seconds (default: 10) - -#### Database Settings -- `MYSQL_DATABASE`: Database name used by Photon (defaults to photon). -- `MYSQL_USER`: Database user used by Photon. -- `MYSQL_PASSWORD`: Database password used by Photon user. -- `MYSQL_ROOT_PASSWORD`: Database root password. - -#### Domain Options -- `PHOTON_DOMAIN`: Domain used for dashboard. -- `PHOTON_SHARE_DOMAIN`: Optional subdomain for sharing links. -- `COOKIE_DOMAIN`: Required when adding a subdomain for sharing. - ### Deployment Options #### Standard Deployment @@ -91,7 +68,7 @@ docker-compose -f examples/compose-default.yml up -d ``` #### Traefik – Custom Domains -Use `examples/compose-traefik.yml` for reverse proxy setups with custom domains. +Use `examples/compose-traefik.yml` for reverse proxy setups, authentication and custom domains. ## Project Structure @@ -108,8 +85,8 @@ photon-dashboard/ ## Updates Container images are available at: -- Dashboard: `git.jrdn.dev/jordanwalster/photon-dashboard:latest` -- Worker: `git.jrdn.dev/jordanwalster/photon-worker:latest` +- Dashboard: `git.jrdn.dev/photon/photon-dashboard:latest` +- Worker: `git.jrdn.dev/photon/photon-worker:latest` View version history: [Container Registry](https://git.jrdn.dev/jordanwalster/-/packages/container/photon-dashboard/versions) diff --git a/changelog.md b/changelog.md index 9af6f5b..9f053be 100644 --- a/changelog.md +++ b/changelog.md @@ -2,6 +2,27 @@ All notable changes to this project will be documented in this file. +## [v1.0.3] - 2026-05-02 + +### Added +- Private Sidebar button for easier viewing of images set to private. +- Make private button to multi-select actions. +- Download button to multi-select actions. +- Hold shift to select. +- Select all (on page) button. +- New version available message in footer. +- Generate thumbnail endpoint. +- Feedback button to footer. + +### Changed +- Updated icon library to latest. +- Upgraded to PHP 8.5. +- Icon for active tags now shows a tag (due to icon library updates). +- Moved changelog link into version number. + +### Fixed +- Bug where images with capitalised extensions could not be trashed by using "Empty trash" button. + ## [v1.0.2] - 2026-05-01 ### Added diff --git a/examples/.env.example b/examples/.env.example index 9b51598..7e90988 100644 --- a/examples/.env.example +++ b/examples/.env.example @@ -10,6 +10,10 @@ PHOTON_DOMAIN=photon.local # PHOTON_SHARE_DOMAIN=share.photon.local # COOKIE_DOMAIN=.photon.local +### Basic Auth Credentials (for Traefik) Use htpasswd to generate the password hash. +BASIC_AUTH_USER=admin +BASIC_AUTH_PASSWORD='$apr1$LbKLWjeg$i69pFbEbwQ61CtsjWGq/D0' + ### Photon Worker Environment Variables SCAN_RATE=10 diff --git a/examples/compose-traefik.yml b/examples/compose-traefik.yml index 2376f06..e7e2f6c 100644 --- a/examples/compose-traefik.yml +++ b/examples/compose-traefik.yml @@ -18,6 +18,9 @@ services: - "traefik.http.routers.photon.rule=Host(`${PHOTON_DOMAIN}`)" - "traefik.http.routers.photon.service=photon" - "traefik.http.services.photon.loadbalancer.server.port=80" + # Basic auth for dashboard (Replace this with your own credentials). + - "traefik.http.middlewares.photon-basic-auth.basicauth.users=${BASIC_AUTH_USER}:${BASIC_AUTH_PASSWORD}" + - "traefik.http.routers.photon.middlewares=photon-basic-auth" # Custom domain for share links - "traefik.http.routers.photon-share.rule=Host(`${PHOTON_SHARE_DOMAIN}`)" diff --git a/logo.png b/logo.png index d3c0b73..a724d0d 100644 Binary files a/logo.png and b/logo.png differ