Skip to content

Xdebug documentation with PHPStorm#2439

Draft
alli83 wants to merge 2 commits into
gigascience:developfrom
alli83:feat-2436-xdebug-documentation
Draft

Xdebug documentation with PHPStorm#2439
alli83 wants to merge 2 commits into
gigascience:developfrom
alli83:feat-2436-xdebug-documentation

Conversation

@alli83

@alli83 alli83 commented Aug 13, 2025

Copy link
Copy Markdown
Collaborator

Pull request for issue: #2436

This is a pull request for the following functionalities:

XDebug documentation with PHPStorm

How to test?

How have functionalities been implemented?

Any issues with implementation?

Any changes to automated tests?

Any changes to documentation?

Any technical debt repayment?

Any improvements to CI/CD pipeline?

@alli83 alli83 moved this from Draft to Ready For Review in Backlog: Pull Requests Aug 13, 2025
@kencho51 kencho51 moved this from Ready For Review to Under Review in Backlog: Pull Requests Aug 14, 2025
@kencho51 kencho51 added the Ken label Aug 14, 2025
Comment thread XDEBUG.md

## 1. Configure Xdebug

You must configure it. You can do this in an `.ini` file in `docker/php/conf.d`:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @alli83,

Regarding the .ini file, is it this one ops/configuration/php-conf/xdebug.ini in our codebase?

Is it better to push the updated xdebug.ini file in this PR, so we all can use it after merge?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can add the file

Comment thread XDEBUG.md
You must configure it. You can do this in an `.ini` file in `docker/php/conf.d`:

```ini
#Xdebug 2

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why there are two lines containing the same zend_extension=xdebug.so?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there are two different configurations: either Xdebug 2 or Xdebug3

Comment thread XDEBUG.md

```ini
#Xdebug 2
zend_extension=xdebug.so

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

need to comment this line

Comment thread XDEBUG.md
xdebug.remote_port=9003

#XDebug3 (PHP 8 images)
zend_extension=xdebug.so

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

need to comment this line

@alli83
alli83 marked this pull request as draft August 14, 2025 09:35
Comment thread XDEBUG.md
dockerfile: ../packaging/Dockerfile
args:
...
- INSTALL_XDEBUG="true"

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo: remove quotes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

Status: Under Review

Development

Successfully merging this pull request may close these issues.

2 participants