Skip to content

Commit 7882410

Browse files
committed
docs: Homebrew installation instructions
1 parent f64c0f9 commit 7882410

2 files changed

Lines changed: 77 additions & 29 deletions

File tree

README.md

Lines changed: 39 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,43 @@ FrankenPHP can also be used as a standalone Go library to embed PHP in any app u
1616

1717
## Getting Started
1818

19+
### Standalone Binary
20+
21+
We provide static FrankenPHP binaries for Linux and macOS
22+
containing [PHP 8.4](https://www.php.net/releases/8.4/en.php) and most popular PHP extensions.
23+
24+
On Windows, use [WSL](https://learn.microsoft.com/windows/wsl/) to run FrankenPHP.
25+
26+
[Download FrankenPHP](https://github.com/dunglas/frankenphp/releases) or copy this line into your
27+
terminal to automatically install the version appropriate for your platform:
28+
29+
```console
30+
curl https://frankenphp.dev/install.sh | sh
31+
mv frankenphp /usr/local/bin/
32+
```
33+
34+
To serve the content of the current directory, run:
35+
36+
```console
37+
frankenphp php-server
38+
```
39+
40+
You can also run command-line scripts with:
41+
42+
```console
43+
frankenphp php-cli /path/to/your/script.php
44+
```
45+
46+
> ![WARNING]
47+
>
48+
> In production, prefer using [the Docker images](#docker), [the Brew package](#homebrew)
49+
> or [compiling FrankenPHP from sources](https://frankenphp.dev/docs/compile/).
50+
> The standalone binary is provided for development and testing purposes.
51+
1952
### Docker
2053

54+
Alternatively, [Docker images](https://frankenphp.dev/docs/docker/) are available:
55+
2156
```console
2257
docker run -v .:/app/public \
2358
-p 80:80 -p 443:443 -p 443:443/udp \
@@ -31,19 +66,14 @@ Go to `https://localhost`, and enjoy!
3166
> Do not attempt to use `https://127.0.0.1`. Use `https://localhost` and accept the self-signed certificate.
3267
> Use the [`SERVER_NAME` environment variable](docs/config.md#environment-variables) to change the domain to use.
3368
34-
### Standalone Binary
69+
### Homebrew
3570

36-
If you prefer not to use Docker, we provide standalone FrankenPHP binaries for Linux and macOS
37-
containing [PHP 8.4](https://www.php.net/releases/8.4/en.php) and most popular PHP extensions.
71+
FrankenPHP is also available as a [Homebrew](https://brew.sh) package for macOS and Linux.
3872

39-
On Windows, use [WSL](https://learn.microsoft.com/windows/wsl/) to run FrankenPHP.
40-
41-
[Download FrankenPHP](https://github.com/dunglas/frankenphp/releases) or copy this line into your
42-
terminal to automatically install the version appropriate for your platform:
73+
To install it:
4374

4475
```console
45-
curl https://frankenphp.dev/install.sh | sh
46-
mv frankenphp /usr/local/bin/
76+
brew install dunglas/frankenphp/frankenphp
4777
```
4878

4979
To serve the content of the current directory, run:
@@ -52,12 +82,6 @@ To serve the content of the current directory, run:
5282
frankenphp php-server
5383
```
5484

55-
You can also run command-line scripts with:
56-
57-
```console
58-
frankenphp php-cli /path/to/your/script.php
59-
```
60-
6185
## Docs
6286

6387
* [Classic mode](https://frankenphp.dev/docs/classic/)

docs/fr/README.md

Lines changed: 38 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,42 @@ Découvrez plus de détails sur ce serveur d’application dans le replay de cet
1616

1717
## Pour Commencer
1818

19+
### Binaire autonome
20+
21+
Si vous préférez ne pas utiliser Docker, nous fournissons des binaires autonomes de FrankenPHP pour Linux et macOS
22+
contenant [PHP 8.4](https://www.php.net/releases/8.4/fr.php) et la plupart des extensions PHP populaires.
23+
24+
Sous Windows, utilisez [WSL](https://learn.microsoft.com/windows/wsl/) pour exécuter FrankenPHP.
25+
26+
[Téléchargez FrankenPHP](https://github.com/dunglas/frankenphp/releases) ou copiez cette ligne dans votre terminal pour installer automatiquement la version appropriée à votre plateforme :
27+
28+
```console
29+
curl https://frankenphp.dev/install.sh | sh
30+
mv frankenphp /usr/local/bin/
31+
```
32+
33+
Pour servir le contenu du répertoire courant, exécutez :
34+
35+
```console
36+
frankenphp php-server
37+
```
38+
39+
Vous pouvez également exécuter des scripts en ligne de commande avec :
40+
41+
```console
42+
frankenphp php-cli /path/to/your/script.php
43+
```
44+
45+
> [!WARNING]
46+
>
47+
> En production, préférez utiliser [les images Docker](#docker), [le paquet Brew](#homebrew)
48+
> ou [compiler FrankenPHP à partir des sources](https://frankenphp.dev/docs/fr/compile/).
49+
> Le binaire autonome est fourni à des fins de développement et de test.
50+
1951
### Docker
2052

53+
Des [images Docker](https://frankenphp.dev/docs/fr/docker/) sont également disponibles :
54+
2155
```console
2256
docker run -v $PWD:/app/public \
2357
-p 80:80 -p 443:443 -p 443:443/udp \
@@ -31,18 +65,14 @@ Rendez-vous sur `https://localhost`, c'est parti !
3165
> Ne tentez pas d'utiliser `https://127.0.0.1`. Utilisez `https://localhost` et acceptez le certificat auto-signé.
3266
> Utilisez [la variable d'environnement `SERVER_NAME`](config.md#variables-denvironnement) pour changer le domaine à utiliser.
3367
34-
### Binaire autonome
68+
### Homebrew
3569

36-
Si vous préférez ne pas utiliser Docker, nous fournissons des binaires autonomes de FrankenPHP pour Linux et macOS
37-
contenant [PHP 8.4](https://www.php.net/releases/8.4/fr.php) et la plupart des extensions PHP populaires.
70+
FrankenPHP est également disponible sous forme de paquet [Homebrew](https://brew.sh) pour macOS et Linux.
3871

39-
Sous Windows, utilisez [WSL](https://learn.microsoft.com/windows/wsl/) pour exécuter FrankenPHP.
40-
41-
[Téléchargez FrankenPHP](https://github.com/dunglas/frankenphp/releases) ou copiez cette ligne dans votre terminal pour installer automatiquement la version appropriée à votre plateforme :
72+
Pour l'installer :
4273

4374
```console
44-
curl https://frankenphp.dev/install.sh | sh
45-
mv frankenphp /usr/local/bin/
75+
brew install dunglas/frankenphp/frankenphp
4676
```
4777

4878
Pour servir le contenu du répertoire courant, exécutez :
@@ -51,12 +81,6 @@ Pour servir le contenu du répertoire courant, exécutez :
5181
frankenphp php-server
5282
```
5383

54-
Vous pouvez également exécuter des scripts en ligne de commande avec :
55-
56-
```console
57-
frankenphp php-cli /path/to/your/script.php
58-
```
59-
6084
## Documentation
6185

6286
* [Le mode worker](worker.md)

0 commit comments

Comments
 (0)