v1.0.0 #107

rtuszik · 2025-07-27T01:35:47Z

Versioning Change

The versioning for this Docker image has been decoupled from the upstream Photon version. This allows for more intuitive versioning that reflects changes to the container environment and scripts, rather than centering around changes to the underlying Photon application.

Breaking Changes

The data volume path has been changed from /photon/photon_data to /photon/data.

docker-compose.yml update:
```
volumes:
-   - photon_data:/photon/photon_data
+   - photon_data:/photon/data
```
COUNTRY_CODE replaced with REGION system

Old: COUNTRY_CODE=de
New: REGION=andorra or REGION=europe
Default base URL changed to https://r2.koalasec.org/public (was /public/experimental)
Index file naming changed to include OpenSearch version (e.g., photon-db-planet-0.7OS-latest.tar.bz2)

New Features

Non-Root User: The container now runs processes as a dedicated non-root user (photon) for improved security. The user and group IDs can be set via PUID and PGID environment variables to manage volume permissions.
Notifications: Support for status notifications (e.g., update completion, errors) has been added via Apprise. This can be configured with the APPRISE_URLS environment variable. feat: Add Apprise notifications for update status #100
Docker Healthcheck: A HEALTHCHECK instruction has been added to the Dockerfile. The container will show as unhealthy whenever the photon-api is not available.

Improvements

Process Management: All startup, update, and monitoring tasks are now managed by a Python application.
Atomic Updates: The index update mechanism now performs an atomic move.
Download Logic: The index downloader now supports resumable downloads and performs more thorough disk space checks. Closes Suggestion: make Downloads resumable #71
Build and Release Pipeline: The CI workflow for building and publishing Docker images has been updated to better handle pre-release (beta) and stable (latest) tags. A workflow for code quality checks using ruff, ty and vulture was added.

socket-security · 2025-07-27T01:35:59Z

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff	Package	Supply Chain Security	Vulnerability	Quality	Maintenance	License
	psutil@7.0.0
	apprise@1.9.3
	urllib3@2.5.0
	tqdm@4.67.1
	ruff@0.12.7
	requests@2.32.4
	python-dateutil@2.9.0.post0
	certifi@2025.6.15
	charset-normalizer@3.4.2
	markdown@3.8.2
	ty@0.0.1a16
	colorama@0.4.6
	pyyaml@6.0.2
	vulture@2.14
	six@1.17.0
	schedule@1.2.2
	oauthlib@3.3.1
	idna@3.10

View full report

rtuszik · 2025-08-05T14:07:43Z

Still needs work on the README.md to reflect changes.

…p customization feat(docker): create 'photon' user and group with specified PUID/PGID in Dockerfile feat(docker): add gosu to Dockerfile for running commands as specific user fix(permissions): update ownership and permissions logic to use 'photon' user/group refactor(start-photon.sh): remove unused ES_UID and ES_GID variables refactor(start-photon.sh): centralize user/group setup into `setup_user` function refactor(start-photon.sh): use `gosu` to run photon as the 'photon' user refactor(start-photon.sh): ensure data directory permissions are set before starting photon

Reorganize the "Configuration Options" section to appear after "Example Docker Compose" for better flow. Add `PUID` and `PGID` environment variables to the configuration options table.

fix(Dockerfile): set correct permissions for photon.jar and /photon directory refactor(start-photon.sh): remove redundant chmod 755 command refactor(start-photon.sh): simplify md5sum verification refactor(start-photon.sh): simplify tar extraction refactor(start-photon.sh): simplify elasticsearch directory removal refactor(start-photon.sh): simplify download logic refactor(start-photon.sh): simplify md5 verification refactor(start-photon.sh): simplify archive extraction feat(start-photon.sh): add debug log for current owner feat(start-photon.sh): add chown for temp directory

…eractive prompts

chore(config.sh): add chown command to ensure correct permissions for /photon directory

The photon service was previously started as the root user, which is not a good security practice. This commit changes the service to run as the 'photon' user using `gosu`, improving security.

feat(Dockerfile): add python3.12 and uv to the image refactor(Dockerfile): change entrypoint to use uv run main.py

…ting, and type-checking steps

…ependencies

…le functions

refactor: improve disk space checks and logging for sequential updates

…echeck, and vulture

…e files

…ations

…rphaned process cleanup

…d remove old index

…tial download

Now uses a marker file instead of checking the actual index file. Extracted index directories will not have the same timestamp as the remote download file.

…ot available

Replaces `COUNTRY_CODE` with `REGION` for more flexible data selection, supporting planet, continent, and specific sub-region downloads.

This comment was marked as outdated.

Sign in to view

Repository owner deleted a comment from sonarqubecloud bot Aug 5, 2025

rtuszik changed the title ~~v2.0.0~~ v1.0.0 Aug 5, 2025

rtuszik self-assigned this Aug 5, 2025

rtuszik added this to the v2.0.0 milestone Aug 5, 2025

rtuszik added 23 commits August 5, 2025 16:07

docs: update README for configuration options

05eb2ac

Reorganize the "Configuration Options" section to appear after "Example Docker Compose" for better flow. Add `PUID` and `PGID` environment variables to the configuration options table.

fix typo

1fd3ed6

build(Dockerfile): add DEBIAN_FRONTEND=noninteractive to suppress int…

cc71304

…eractive prompts

feat(config.sh): add JAVA_PARAMS environment variable

76b9b72

chore(config.sh): add chown command to ensure correct permissions for /photon directory

fix(process.sh): run photon service as the 'photon' user instead of root

825bbc5

The photon service was previously started as the root user, which is not a good security practice. This commit changes the service to run as the 'photon' user using `gosu`, improving security.

Remove redundant functions

913b7d7

fix(process.sh): correctly parse JAVA_PARAMS to allow multiple arguments

864f439

initial python project structure draft

fa92ba5

initialize astral-uv

162ab9b

add logger module

8dc61f6

refactor(Dockerfile): remove unnecessary package installations

affbd48

feat(Dockerfile): add python3.12 and uv to the image refactor(Dockerfile): change entrypoint to use uv run main.py

add config.py

7a31238

update pyproject.toml

88644be

update .gitignore for python

1a8b442

remove bash files

24c13d9

draft of config module

b0d487a

draft of mtime checker

293df99

draft of download module

97acb48

draft of fiilesystem module

6c27e55

draft of process management

0641134

draft of entypoint script

8e86798

rtuszik added 16 commits August 5, 2025 16:07

fix: don't restart if up to date

4ee072a

refactor(logging): simplify logger setup and usage across modules

9dd5740

refactor(ci): streamline CI workflow by consolidating linting, format…

115962b

…ting, and type-checking steps

refactor: improve code formatting and update CI workflow for Python d…

e0f667c

…ependencies

ci: set minimum confidence for vulture checks to 100

293af4a

ci: add sonarqube

8cc4770

add sonar properties

d1547ae

refactor(downloader): split download_file into smaller, more manageab…

9956f3d

…le functions

feat: implement InsufficientSpaceError for disk space management

8a8c5eb

refactor: improve disk space checks and logging for sequential updates

refactor: improve download logging and error handling

c250d95

feat(pyproject.toml): add ruff configuration for linting and formatting

f529d28

fix: improve error handling and add timeouts to requests

7fc8f62

ci: refactor linting workflow into separate jobs for setup, lint, typ…

d9f2e07

…echeck, and vulture

refactor: improve code readability and maintainability across multipl…

09145d1

…e files

refactor: simplify disk space checks and remove unnecessary file oper…

fa4541b

…ations

ci: refactor Docker build and push workflow and remove unused workflows

8ad0787

rtuszik force-pushed the dev branch from 3b2dfc7 to 8ad0787 Compare August 5, 2025 14:07

rtuszik linked an issue Aug 5, 2025 that may be closed by this pull request

Download is being put in the Docker volume, not the mounted filesystem. #101

Closed

rtuszik added 8 commits August 5, 2025 16:51

ci: add release-drafter.yml workflow to automate release drafting

daa7b87

fix(process_manager): change method call from private to public for o…

5b4d65e

…rphaned process cleanup

refactor(entrypoint): migrate node_1 data to photon_data directory an…

e706375

…d remove old index

chore(entrypoint): promote configuration logs to INFO and clarify ini…

79c8d16

…tial download

feat: use marker file for index timestamp

9b57fbf

Now uses a marker file instead of checking the actual index file. Extracted index directories will not have the same timestamp as the remote download file.

refactor: only allow grace period with fallback when marker file is n…

a9f17da

…ot available

feat: implement new region-based data download system

5de963e

Replaces `COUNTRY_CODE` with `REGION` for more flexible data selection, supporting planet, continent, and specific sub-region downloads.

feat: add release drafter config

f769186

rtuszik linked an issue Sep 7, 2025 that may be closed by this pull request

New layout for the photon download server #116

Closed

rtuszik added 2 commits September 7, 2025 11:16

build: update release version from 0.7.2 to 0.7.3

cfac3e4

docs: update README for clarity and conciseness

2fb6938

rtuszik merged commit 0d1edbc into main Sep 7, 2025
6 of 7 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

v1.0.0 #107

v1.0.0 #107

Uh oh!

rtuszik commented Jul 27, 2025 •

edited

Loading

Uh oh!

socket-security bot commented Jul 27, 2025 •

edited

Loading

Uh oh!

This comment was marked as outdated.

Uh oh!

rtuszik commented Aug 5, 2025

Uh oh!

Uh oh!

Uh oh!

v1.0.0 #107

v1.0.0 #107

Uh oh!

Conversation

rtuszik commented Jul 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Versioning Change

Breaking Changes

New Features

Improvements

Uh oh!

socket-security bot commented Jul 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

rtuszik commented Aug 5, 2025

Uh oh!

Uh oh!

Uh oh!

rtuszik commented Jul 27, 2025 •

edited

Loading

socket-security bot commented Jul 27, 2025 •

edited

Loading