Skip to content

Conversation

SamJUK
Copy link
Contributor

@SamJUK SamJUK commented Nov 17, 2024

Supporting documentation for the PHP SPX implementation proposed within the PR wardenenv/warden#820

@SamJUK SamJUK marked this pull request as draft November 18, 2024 17:28

### CLI

Running the `warden shell` command, will place you within a PHP-SPX instrumented terminal. After running PHP CLI commands, you should see a SPX report printed after the command finishes.
Copy link
Member

Choose a reason for hiding this comment

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

I think you changed this to warden spx right?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yup, I'll get this updated to match the changes

Copy link
Member

Choose a reason for hiding this comment

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

Appreciate all your work and patience on this!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

All good! Updated the CLI section and rebased from main

@SamJUK SamJUK force-pushed the feature/php-spx-documentation branch from 3da2c9b to 3a47b54 Compare November 19, 2024 14:44
@SamJUK SamJUK force-pushed the feature/php-spx-documentation branch from 3a47b54 to 1fa93dc Compare November 19, 2024 14:46
@SamJUK SamJUK marked this pull request as ready for review November 19, 2024 14:50
@navarr navarr added the merge at next release PRs documenting new functionality that is not yet available on released versions of Warden label Nov 19, 2024
@ihor-sviziev
Copy link
Contributor

ihor-sviziev commented Nov 21, 2024

Based on comments in wardenenv/warden#820 (comment) wardenenv/warden#820 (comment),
can we also document on how to disable SPX to prevent issues?

@convenient
Copy link

In order to see the user interface I needed to specify the key for warden, I am not sure if this was something I did with my install but I didn't see it in the docs here.

https://example.test/?SPX_UI_URI=/&SPX_KEY=warden

@SamJUK
Copy link
Contributor Author

SamJUK commented Oct 12, 2025

Thanks for raising that Luke, you are correct and it is apart of the standard implementation.
I've gone ahead and updated the doc to reflect that

@SamJUK
Copy link
Contributor Author

SamJUK commented Oct 12, 2025

Based on comments in wardenenv/warden#820 (comment) wardenenv/warden#820 (comment), can we also document on how to disable SPX to prevent issues?

Apologies for the delay, SPX fell of my radar for a while.

I've opened two PR's which may resolve the disabling issue by refactoring the fastcgi selection logic.
Depending on the feedback on these, I will loopback and add the relevant sections before the next release.

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

Labels

merge at next release PRs documenting new functionality that is not yet available on released versions of Warden

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants