Skip to content

Commit ac900e0

Browse files
authored
docs: update repository links and sync cn readme (#1711)
1 parent 40ee792 commit ac900e0

46 files changed

Lines changed: 142 additions & 116 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/ISSUE_TEMPLATE/bug_report.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ body:
1010
Before submitting a bug, please double-check that your problem [is not
1111
a known issue](https://frankenphp.dev/docs/known-issues/)
1212
(especially if you use XDebug or Tideways), and that is has not
13-
[already been reported](https://github.com/dunglas/frankenphp/issues).
13+
[already been reported](https://github.com/php/frankenphp/issues).
1414
- type: textarea
1515
id: what-happened
1616
attributes:

Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ EXPOSE 2019
4646
LABEL org.opencontainers.image.title=FrankenPHP
4747
LABEL org.opencontainers.image.description="The modern PHP app server"
4848
LABEL org.opencontainers.image.url=https://frankenphp.dev
49-
LABEL org.opencontainers.image.source=https://github.com/dunglas/frankenphp
49+
LABEL org.opencontainers.image.source=https://github.com/php/frankenphp
5050
LABEL org.opencontainers.image.licenses=MIT
5151
LABEL org.opencontainers.image.vendor="Kévin Dunglas"
5252

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ containing [PHP 8.4](https://www.php.net/releases/8.4/en.php) and most popular P
2323

2424
On Windows, use [WSL](https://learn.microsoft.com/windows/wsl/) to run FrankenPHP.
2525

26-
[Download FrankenPHP](https://github.com/dunglas/frankenphp/releases) or copy this line into your
26+
[Download FrankenPHP](https://github.com/php/frankenphp/releases) or copy this line into your
2727
terminal to automatically install the version appropriate for your platform:
2828

2929
```console

SECURITY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Binaries and Docker images are rebuilt nightly using the latest versions of depe
1212
If you believe you have discovered a security issue directly affecting FrankenPHP,
1313
please do **NOT** report it publicly.
1414

15-
Please write a detailed vulnerability report and send it [through GitHub](https://github.com/dunglas/frankenphp/security/advisories/new) or to [kevin+frankenphp-security@dunglas.dev](mailto:kevin+frankenphp-security@dunglas.dev?subject=Security%20issue%20affecting%20FrankenPHP).
15+
Please write a detailed vulnerability report and send it [through GitHub](https://github.com/php/frankenphp/security/advisories/new) or to [kevin+frankenphp-security@dunglas.dev](mailto:kevin+frankenphp-security@dunglas.dev?subject=Security%20issue%20affecting%20FrankenPHP).
1616

1717
Only vulnerabilities directly affecting FrankenPHP should be reported to this project.
1818
Flaws affecting components used by FrankenPHP (PHP, Caddy, Go...) or using FrankenPHP (Laravel Octane, PHP Runtime...) should be reported to the relevant projects.

alpine.Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ EXPOSE 2019
4646
LABEL org.opencontainers.image.title=FrankenPHP
4747
LABEL org.opencontainers.image.description="The modern PHP app server"
4848
LABEL org.opencontainers.image.url=https://frankenphp.dev
49-
LABEL org.opencontainers.image.source=https://github.com/dunglas/frankenphp
49+
LABEL org.opencontainers.image.source=https://github.com/php/frankenphp
5050
LABEL org.opencontainers.image.licenses=MIT
5151
LABEL org.opencontainers.image.vendor="Kévin Dunglas"
5252

caddy/php-server.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ will be changed to the HTTPS port and the server will use HTTPS. If using
4141
a public domain, ensure A/AAAA records are properly configured before
4242
using this option.
4343
44-
For more advanced use cases, see https://github.com/dunglas/frankenphp/blob/main/docs/config.md`,
44+
For more advanced use cases, see https://github.com/php/frankenphp/blob/main/docs/config.md`,
4545
CobraFunc: func(cmd *cobra.Command) {
4646
cmd.Flags().StringP("domain", "d", "", "Domain name at which to serve the files")
4747
cmd.Flags().StringP("root", "r", "", "The path to the root of the site")

docs/cn/CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ docker run --cap-add=SYS_PTRACE --security-opt seccomp=unconfined -p 8080:8080 -
1717
- 附加配置文件: `/etc/frankenphp/php.d/*.ini`
1818
- php 扩展: `/usr/lib/frankenphp/modules/`
1919

20-
如果您的 docker 版本低于 23.0,则会因为 dockerignore [pattern issue](https://github.com/moby/moby/pull/42676) 而导致构建失败。将目录添加到 `.dockerignore`
20+
如果你的 docker 版本低于 23.0,则会因为 dockerignore [pattern issue](https://github.com/moby/moby/pull/42676) 而导致构建失败。将目录添加到 `.dockerignore`
2121

2222
```patch
2323
!testdata/*.php

docs/cn/README.md

Lines changed: 60 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,49 @@
44

55
FrankenPHP 是建立在 [Caddy](https://caddyserver.com/) Web 服务器之上的现代 PHP 应用程序服务器。
66

7-
FrankenPHP 凭借其令人惊叹的功能为您的 PHP 应用程序提供了超能力:[早期提示](early-hints.md)[worker 模式](worker.md)[实时功能](mercure.md)、自动 HTTPS、HTTP/2 和 HTTP/3 支持......
7+
FrankenPHP 凭借其令人惊叹的功能为你的 PHP 应用程序提供了超能力:[早期提示](early-hints.md)[worker 模式](worker.md)[实时功能](mercure.md)、自动 HTTPS、HTTP/2 和 HTTP/3 支持......
88

9-
FrankenPHP 可与任何 PHP 应用程序一起使用,并且由于提供了与 worker 模式的集成,使您的 Symfony 和 Laravel 项目比以往任何时候都更快。
9+
FrankenPHP 可与任何 PHP 应用程序一起使用,并且由于提供了与 worker 模式的集成,使你的 Symfony 和 Laravel 项目比以往任何时候都更快。
1010

1111
FrankenPHP 也可以用作独立的 Go 库,将 PHP 嵌入到任何使用 net/http 的应用程序中。
1212

13-
[**了解更多** *frankenphp.dev*](https://frankenphp.dev/cn) 以及在以下地址中
13+
[**了解更多** _frankenphp.dev_](https://frankenphp.dev/cn/) 以及查看此演示文稿
1414

1515
<a href="https://dunglas.dev/2022/10/frankenphp-the-modern-php-app-server-written-in-go/"><img src="https://dunglas.dev/wp-content/uploads/2022/10/frankenphp.png" alt="Slides" width="600"></a>
1616

1717
## 开始
1818

19+
### 独立二进制
20+
21+
我们为 Linux 和 macOS 提供包含 [PHP 8.4](https://www.php.net/releases/8.4/zh.php) 以及大多数常用 PHP 扩展的 FrankenPHP 静态二进制文件。
22+
23+
在 Windows 上,请使用 [WSL](https://learn.microsoft.com/windows/wsl/) 运行 FrankenPHP。
24+
25+
你可以 [下载 FrankenPHP](https://github.com/dunglas/frankenphp/releases),或将以下命令复制到终端中,自动安装适用于你平台的版本:
26+
27+
```console
28+
curl https://frankenphp.dev/install.sh | sh
29+
mv frankenphp /usr/local/bin/
30+
```
31+
32+
要提供当前目录的内容,请运行:
33+
34+
```console
35+
frankenphp php-server
36+
```
37+
38+
你还可以使用以下命令运行命令行脚本:
39+
40+
```console
41+
frankenphp php-cli /path/to/your/script.php
42+
```
43+
1944
### Docker
2045

46+
此外,还可以使用 [Docker 镜像](https://frankenphp.dev/docs/docker/)
47+
2148
```console
22-
docker run -v $PWD:/app/public \
49+
docker run -v .:/app/public \
2350
-p 80:80 -p 443:443 -p 443:443/udp \
2451
dunglas/frankenphp
2552
```
@@ -31,48 +58,47 @@ docker run -v $PWD:/app/public \
3158
> 不要尝试使用 `https://127.0.0.1`。使用 `https://localhost` 并接受自签名证书。
3259
> 使用 [`SERVER_NAME` 环境变量](config.md#环境变量) 更改要使用的域。
3360
34-
### 独立二进制
61+
### Homebrew
3562

36-
如果您不想使用 Docker,我们为 Linux 和 macOS 提供独立的 FrankenPHP 二进制文件
37-
,其中包含 [PHP 8.4](https://www.php.net/releases/8.4/en.php) 和最流行的 PHP 扩展:[下载 FrankenPHP](https://github.com/dunglas/frankenphp/releases)
63+
FrankenPHP 也作为 [Homebrew](https://brew.sh) 软件包提供,适用于 macOS 和 Linux 系统。
3864

39-
若要启动当前目录的内容,请运行
65+
安装方法
4066

4167
```console
42-
./frankenphp php-server
68+
brew install dunglas/frankenphp/frankenphp
4369
```
4470

45-
您还可以使用以下命令运行命令行脚本
71+
要提供当前目录的内容,请运行
4672

4773
```console
48-
./frankenphp php-cli /path/to/your/script.php
74+
frankenphp php-server
4975
```
5076

5177
## 文档
5278

53-
* [worker 模式](worker.md)
54-
* [早期提示支持(103 HTTP status code)](early-hints.md)
55-
* [实时功能](mercure.md)
56-
* [配置](config.md)
57-
* [Docker 镜像](docker.md)
58-
* [在生产环境中部署](production.md)
59-
* [创建独立、可自行执行的 PHP 应用程序](embed.md)
60-
* [创建静态二进制文件](static.md)
61-
* [从源代码编译](compile.md)
62-
* [Laravel 集成](laravel.md)
63-
* [已知问题](known-issues.md)
64-
* [演示应用程序 (Symfony) 和性能测试](https://github.com/dunglas/frankenphp-demo)
65-
* [Go 库文档](https://pkg.go.dev/github.com/dunglas/frankenphp)
66-
* [贡献和调试](https://frankenphp.dev/docs/contributing/)
79+
- [worker 模式](worker.md)
80+
- [早期提示支持(103 HTTP status code)](early-hints.md)
81+
- [实时功能](mercure.md)
82+
- [配置](config.md)
83+
- [Docker 镜像](docker.md)
84+
- [在生产环境中部署](production.md)
85+
- [创建独立、可自行执行的 PHP 应用程序](embed.md)
86+
- [创建静态二进制文件](static.md)
87+
- [从源代码编译](compile.md)
88+
- [Laravel 集成](laravel.md)
89+
- [已知问题](known-issues.md)
90+
- [演示应用程序 (Symfony) 和性能测试](https://github.com/dunglas/frankenphp-demo)
91+
- [Go 库文档](https://pkg.go.dev/github.com/dunglas/frankenphp)
92+
- [贡献和调试](https://frankenphp.dev/docs/contributing/)
6793

6894
## 示例和框架
6995

70-
* [Symfony](https://github.com/dunglas/symfony-docker)
71-
* [API Platform](https://api-platform.com/docs/distribution/)
72-
* [Laravel](laravel.md)
73-
* [Sulu](https://sulu.io/blog/running-sulu-with-frankenphp)
74-
* [WordPress](https://github.com/StephenMiracle/frankenwp)
75-
* [Drupal](https://github.com/dunglas/frankenphp-drupal)
76-
* [Joomla](https://github.com/alexandreelise/frankenphp-joomla)
77-
* [TYPO3](https://github.com/ochorocho/franken-typo3)
78-
* [Magento2](https://github.com/ekino/frankenphp-magento2)
96+
- [Symfony](https://github.com/dunglas/symfony-docker)
97+
- [API Platform](https://api-platform.com/docs/distribution/)
98+
- [Laravel](laravel.md)
99+
- [Sulu](https://sulu.io/blog/running-sulu-with-frankenphp)
100+
- [WordPress](https://github.com/StephenMiracle/frankenwp)
101+
- [Drupal](https://github.com/dunglas/frankenphp-drupal)
102+
- [Joomla](https://github.com/alexandreelise/frankenphp-joomla)
103+
- [TYPO3](https://github.com/ochorocho/franken-typo3)
104+
- [Magento2](https://github.com/ekino/frankenphp-magento2)

docs/cn/compile.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ tar xf php-*
1616
cd php-*/
1717
```
1818

19-
然后,为您的平台配置 PHP.
19+
然后,为你的平台配置 PHP.
2020

2121
这些参数是必需的,但你也可以添加其他编译参数(例如额外的扩展)。
2222

@@ -63,10 +63,10 @@ sudo make install
6363

6464
## 编译 Go 应用
6565

66-
您现在可以使用 Go 库并编译我们的 Caddy 构建:
66+
你现在可以使用 Go 库并编译我们的 Caddy 构建:
6767

6868
```console
69-
curl -L https://github.com/dunglas/frankenphp/archive/refs/heads/main.tar.gz | tar xz
69+
curl -L https://github.com/php/frankenphp/archive/refs/heads/main.tar.gz | tar xz
7070
cd frankenphp-main/caddy/frankenphp
7171
CGO_CFLAGS=$(php-config --includes) CGO_LDFLAGS="$(php-config --ldflags) $(php-config --libs)" go build
7272
```
@@ -90,9 +90,9 @@ xcaddy build \
9090
> [!TIP]
9191
>
9292
> 如果你的系统基于 musl libc(Alpine Linux 上默认使用)并搭配 Symfony 使用,
93-
> 您可能需要增加默认堆栈大小
94-
> 否则,您可能会收到如下错误 `PHP Fatal error: Maximum call stack size of 83360 bytes reached during compilation. Try splitting expression`
93+
> 你可能需要增加默认堆栈大小
94+
> 否则,你可能会收到如下错误 `PHP Fatal error: Maximum call stack size of 83360 bytes reached during compilation. Try splitting expression`
9595
>
9696
> 请将 `XCADDY_GO_BUILD_FLAGS` 环境变量更改为如下类似的值
9797
> `XCADDY_GO_BUILD_FLAGS=$'-ldflags "-w -s -extldflags \'-Wl,-z,stack-size=0x80000\'"'`
98-
> 根据您的应用需求更改堆栈大小)。
98+
> 根据你的应用需求更改堆栈大小)。

docs/cn/config.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Docker:
1212
- php.ini: `/usr/local/etc/php/php.ini` 默认情况下不提供 php.ini。
1313
- 附加配置文件: `/usr/local/etc/php/conf.d/*.ini`
1414
- php 扩展: `/usr/local/lib/php/extensions/no-debug-zts-<YYYYMMDD>/`
15-
- 您应该复制 PHP 项目提供的官方模板:
15+
- 你应该复制 PHP 项目提供的官方模板:
1616

1717
```dockerfile
1818
FROM dunglas/frankenphp
@@ -39,7 +39,7 @@ FrankenPHP 安装 (.rpm 或 .deb):
3939

4040
## Caddyfile 配置
4141

42-
可以在站点块中使用 `php_server``php` [HTTP 指令](https://caddyserver.com/docs/caddyfile/concepts#directives) 来为您的 PHP 应用程序提供服务。
42+
可以在站点块中使用 `php_server``php` [HTTP 指令](https://caddyserver.com/docs/caddyfile/concepts#directives) 来为你的 PHP 应用程序提供服务。
4343

4444
最小示例:
4545

@@ -52,7 +52,7 @@ localhost {
5252
}
5353
```
5454

55-
您也可以使用全局选项显式配置 FrankenPHP:
55+
你也可以使用全局选项显式配置 FrankenPHP:
5656
`frankenphp` [全局选项](https://caddyserver.com/docs/caddyfile/concepts#global-options) 可用于配置 FrankenPHP。
5757

5858
```caddyfile
@@ -70,7 +70,7 @@ localhost {
7070
# ...
7171
```
7272

73-
或者,您可以使用 `worker` 选项的一行缩写形式:
73+
或者,你可以使用 `worker` 选项的一行缩写形式:
7474

7575
```caddyfile
7676
{

0 commit comments

Comments
 (0)