Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

A few improvements for the README.md #24

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

A few improvements for the README.md #24

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
81b0ab5
Remove some redundacny and adjust the case of the XHGui wordmark
rpkoller Nov 29, 2023
0dd1a7e
Small refinement to the usage section
rpkoller Nov 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 6 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,6 @@ Profiling in a production environment is not recommended.
}
```

- Run `ddev xhprof` to start profiling.
- XHGui is now available at `https://yourproject.ddev.site:8142`

### WordPress

- Install `perftools/php-profiler`
Expand All @@ -81,8 +78,6 @@ Profiling in a production environment is not recommended.
```

- Remove `#ddev-generated` from `wp-config-ddev.php` to prevent DDEV overriding it.
- Run `ddev xhprof` to start profiling
- XHGui is now available at `https://yourproject.ddev.site:8142`

### Silverstripe

Expand All @@ -109,20 +104,15 @@ Profiling in a production environment is not recommended.
}
```

- Run `ddev xhprof` to start profiling
- XHGui is now available at `https://yourproject.ddev.site:8142`

## Usage

The service will automatically start when run: `ddev start` or `ddev restart`.

By default, xhgui will be available at `https://yourproject.ddev.site:8143`.
Use the following command to launch the xhgui in your browser:
Run the following commands to enable profiling and then launch the XHGui in your browser.

```shell
ddev xhgui
ddev xhprof on && ddev xhgui
```

By default, XHGui will be available at `https://yourproject.ddev.site:8143`.

For detailed information about a single request, click on the "Method" keyword on the "Recent runs" dashboard.

![Click GET method](./images/xhgui-get.png)
Expand All @@ -137,9 +127,9 @@ Use the following command to check the logs:

## Configuration

To configure Xhgui, update `.ddev/xhgui/xhgui.config.php`.
To configure XhGui, update `.ddev/xhgui/xhgui.config.php`.

For example, to set xhgui to use `Asia/Toyko` timezone for dates:
For example, to set XHGui to use `Asia/Toyko` timezone for dates:

- Remove `#ddev-generated` from `.ddev/xhgui/xhgui.config.php`
- Change the timezone value
Expand Down