Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@ frankenphp.test
caddy/frankenphp/Build
package/etc/php.ini
*.log
compile_flags.txt
142 changes: 142 additions & 0 deletions docs/development.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,142 @@
# FrankenPHP Development Environment Setup

---

## For Windows: WSL2 Setup with X11 GUI Support

1. Install WSL2:

```powershell
wsl --install
```
2. Install a Linux distribution (example: AlmaLinux 10) via e.g. `wsl --install AlmaLinux-10`.
Copy link
Member

Choose a reason for hiding this comment

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

What's AlmaLinux 10? Is it the official recommandation for WSL? If not, maybe we should discuss what's the "official" recommended distribution to do 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.

I don't think there's an "officially recommended distribution". The default (wsl --install) uses Ubuntu I believe, but AlmaLinux, Debian, OpenSUSE and more are available by default as well.

3. Install X11 dependencies to run GUI-based IDEs from within WSL2:

```bash
sudo dnf install libXtst libXi libXrender libXrandr libXcursor libXinerama libXcomposite libXdamage libXext libXfixes
```

---

## Initial setup

Follow the guide on [compiling from sources](compile.md).
We will assume you installed these things into the following paths:
- go: `/usr/local/go`
- cloned `~/php-src`
- php: `/usr/local/bin/php`
- cloned `~/frankenphp`

## CLion Setup for CGO glue/PHP Source Development

### 1. Install CLion

* Download from: [https://www.jetbrains.com/clion/download/](https://www.jetbrains.com/clion/download/)
* Extract and install:

```bash
tar -xzf CLion-*.tar.gz
sudo mv clion-* /opt/clion
```
* Launch:

```bash
/opt/clion/bin/clion &>/dev/null
```

### 2. Open Project in CLion

* Open CLion → Open → Select the `~/frankenphp` directory
* Add a build chain: Settings → Build, Execution, Deployment → Custom Build Targets
* Select any Build Target, under `Build` set up an External Tool (call it e.g. go build)
* Set up a wrapper script that builds frankenphp for you, called `go_compile_frankenphp.sh`

```bash
export CGO_CFLAGS="-O0 -g $(php-config --includes)"
export CGO_LDFLAGS="$(php-config --ldflags) $(php-config --libs)"
go build -tags=nobadger,nomysql,nopgx
```

* Under Program, select `go_compile_frankenphp.sh`
* Leave Arguments blank
* Working Directory: `~/frankenphp/caddy/frankenphp`

### 3. Configure Run Targets

* Go to **Run → Edit Configurations**
* Create:

* **frankenphp**:

* Type: Native Application
* Target: select the `go build` target you created
* Executable: `~/frankenphp/caddy/frankenphp/frankenphp`
* Arguments: the arguments you want to start frankenphp with, e.g. `php-cli test.php`

### 4. Debug Go files from CLion

* Right click on a *.go file in the Project view on the left
* Override file type
* C/C++

Now you can place breakpoints in C, C++ and Go files.
To get syntax highlighting for imports from php-src, you may need to tell CLion about the include paths. Create a `compile_flags.txt` file in `~/frankenphp` with the following contents:

```gcc
-I/usr/local/include/php
-I/usr/local/include/php/Zend
-I/usr/local/include/php/main
-I/usr/local/include/php/TSRM
```

---

## GoLand Setup for FrankenPHP Development

Use GoLand for primary Go development, but the debugger cannot debug C code.

### 1. Install GoLand

* Download from: [https://www.jetbrains.com/go/download/](https://www.jetbrains.com/go/download/)
* Extract and install:

```bash
tar -xzf goland-*.tar.gz
sudo mv GoLand-* /opt/goland
```
* Launch:

```bash
/opt/goland/bin/goland &>/dev/null
```

### 2. Open in GoLand

* Launch GoLand → Open → Select the `~/frankenphp` directory

---

### Go Configuration

* Select Go Build
* Name `frankenphp`
* Run kind: Directory

* Directory: `~/frankenphp/caddy/frankenphp`
* Output directory: `~/frankenphp/caddy/frankenphp`
* Working directory: `~/frankenphp/caddy/frankenphp`
* Environment (adjust for your $(php-config ...) output): `CGO_CFLAGS=-O0 -g -I/usr/local/include/php -I/usr/local/include/php/main -I/usr/local/include/php/TSRM -I/usr/local/include/php/Zend -I/usr/local/include/php/ext -I/usr/local/include/php/ext/date/lib;CGO_LDFLAGS=-lm -lpthread -lsqlite3 -lxml2 -lbrotlienc -lbrotlidec -lbrotlicommon -lwatcher`
* Go tool arguments: `-tags=nobadger,nomysql,nopgx`
* Program arguments: e.g. `php-cli -i`

You can now place breakpoints and debug through Go code when you debug the `frankenphp` configuration, but breakpoints in C code will not work.

---

## Debugging and Integration Notes

* Use **CLion** for debugging PHP internals and `cgo` glue code
* Use **GoLand** for primary Go development and debugging
* FrankenPHP can be added as a run configuration in CLion for unified C/Go debugging if needed, but syntax highlighting won't work in Go files

---
Loading