Skip to content

Commit 233753c

Browse files
authored
docs: update docs for first-time contributor (#1368)
1 parent 9dd05b0 commit 233753c

3 files changed

Lines changed: 11 additions & 6 deletions

File tree

CONTRIBUTING.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ docker build -t frankenphp-dev -f dev.Dockerfile .
1111
docker run --cap-add=SYS_PTRACE --security-opt seccomp=unconfined -p 8080:8080 -p 443:443 -p 443:443/udp -v $PWD:/go/src/app -it frankenphp-dev
1212
```
1313

14-
The image contains the usual development tools (Go, GDB, Valgrind, Neovim...).
14+
The image contains the usual development tools (Go, GDB, Valgrind, Neovim...).
1515

1616
If docker version is lower than 23.0, build is failed by dockerignore [pattern issue](https://github.com/moby/moby/pull/42676). Add directories to `.dockerignore`.
1717

@@ -49,10 +49,13 @@ cd testdata/
4949
../caddy/frankenphp/frankenphp run
5050
```
5151

52-
The server is listening on `127.0.0.1:8080`:
52+
The server is listening on `127.0.0.1:80`:
53+
54+
> [!NOTE]
55+
> if you are using Docker, you will have to either bind container port 80 or execute from inside the container
5356
5457
```console
55-
curl -vk https://localhost/phpinfo.php
58+
curl -vk http://127.0.0.1/phpinfo.php
5659
```
5760

5861
## Minimal test server

dev.Dockerfile

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ RUN apt-get update && \
4646
echo 'set auto-load safe-path /' > /root/.gdbinit && \
4747
echo '* soft core unlimited' >> /etc/security/limits.conf \
4848
&& \
49-
apt-get clean
49+
apt-get clean
5050

5151
WORKDIR /usr/local/src/php
5252
RUN git clone --branch=PHP-8.4 https://github.com/php/php-src.git . && \
@@ -71,7 +71,9 @@ WORKDIR /usr/local/src/watcher
7171
RUN git clone https://github.com/e-dant/watcher . && \
7272
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release && \
7373
cmake --build build/ && \
74-
cmake --install build
74+
cmake --install build && \
75+
cp build/libwatcher-c.so /usr/local/lib/libwatcher-c.so && \
76+
ldconfig
7577

7678
WORKDIR /go/src/app
7779
COPY . .

internal/testserver/main.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ func main() {
2121

2222
http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
2323
req, err := frankenphp.NewRequestWithContext(r)
24-
if err == nil {
24+
if err != nil {
2525
panic(err)
2626
}
2727

0 commit comments

Comments
 (0)