Bu sayfa topluluk tarafından çevrilmiştir ve güncel olmayabilir. Referans versiyonuna (İngilizce) bakın.

Bu sayfa topluluk tarafından çevrilmiştir ve güncel olmayabilir. Referans versiyonuna (İngilizce) bakın.

Bu sayfa topluluk tarafından çevrilmiştir ve güncel olmayabilir. Referans versiyonuna (İngilizce) bakın.

Tarafından desteklenmektedir
Konfigürasyon

Konfigürasyon

FrankenPHP, Caddy’nin yanı sıra Mercure ve Vulcain modülleri, Caddy tarafından desteklenen formatlar kullanılarak yapılandırılabilir.

FrankenPHP, Caddy’nin yanı sıra Mercure ve Vulcain modülleri, Caddy tarafından desteklenen formatlar kullanılarak yapılandırılabilir.

En yaygın format, basit, insan tarafından okunabilir bir metin formatı olan Caddyfile‘dır. Varsayılan olarak, FrankenPHP mevcut dizinde bir Caddyfile arayacaktır. Özel bir yol belirtmek için -c veya --config seçeneğini kullanabilirsiniz.

Bir PHP uygulamasını sunmak için minimal bir Caddyfile aşağıda gösterilmiştir:

# Yanıt verilecek ana bilgisayar adı
localhost

# İsteğe bağlı olarak, dosyaların sunulacağı dizin, aksi takdirde mevcut dizin varsayılan olarak kullanılır
#root public/
php_server

Daha fazla özellik sağlayan ve kullanışlı ortam değişkenleri sunan daha gelişmiş bir Caddyfile, FrankenPHP deposunda ve Docker imajlarıyla birlikte sağlanır.

PHP’nin kendisi bir php.ini dosyası kullanılarak yapılandırılabilir.

Kurulum yönteminize bağlı olarak, FrankenPHP ve PHP yorumlayıcısı, aşağıda açıklanan konumlardaki yapılandırma dosyalarını arayacaktır.

# Docker

FrankenPHP:

  • /etc/frankenphp/Caddyfile: ana yapılandırma dosyası
  • /etc/frankenphp/Caddyfile.d/*.caddyfile: otomatik olarak yüklenen ek yapılandırma dosyaları

PHP:

  • php.ini: /usr/local/etc/php/php.ini (varsayılan olarak bir php.ini sağlanmaz)
  • ek yapılandırma dosyaları: /usr/local/etc/php/conf.d/*.ini
  • PHP uzantıları: /usr/local/lib/php/extensions/no-debug-zts-<YYYYMMDD>/
  • PHP projesi tarafından sağlanan resmi bir şablonu kopyalamalısınız:
FROM dunglas/frankenphp

# Üretim için:
RUN cp $PHP_INI_DIR/php.ini-production $PHP_INI_DIR/php.ini

# Veya geliştirme için:
RUN cp $PHP_INI_DIR/php.ini-development $PHP_INI_DIR/php.ini

# RPM ve Debian paketleri

FrankenPHP:

  • /etc/frankenphp/Caddyfile: ana yapılandırma dosyası
  • /etc/frankenphp/Caddyfile.d/*.caddyfile: otomatik olarak yüklenen ek yapılandırma dosyaları

PHP:

  • php.ini: /etc/php-zts/php.ini (varsayılan olarak üretim ön ayarlarına sahip bir php.ini dosyası sağlanır)
  • ek yapılandırma dosyaları: /etc/php-zts/conf.d/*.ini

# Statik ikili

FrankenPHP:

  • Mevcut çalışma dizininde: Caddyfile

PHP:

  • php.ini: frankenphp run veya frankenphp php-server komutunun çalıştırıldığı dizin, ardından /etc/frankenphp/php.ini
  • ek yapılandırma dosyaları: /etc/frankenphp/php.d/*.ini
  • PHP uzantıları: yüklenemez, bunları doğrudan ikili dosyaya dahil edin
  • PHP kaynak kodu ile birlikte verilen php.ini-production veya php.ini-development dosyalarından birini kopyalayın.

# Caddyfile yapılandırması

PHP uygulamanızı sunmak için site blokları içinde php_server veya php HTTP yönergeleri kullanılabilir.

Minimal örnek:

localhost {
	# Sıkıştırmayı etkinleştir (isteğe bağlı)
	encode zstd br gzip
	# Geçerli dizindeki PHP dosyalarını çalıştırın ve varlıkları sunun
	php_server
}

Ayrıca, FrankenPHP’yi global seçenek olan frankenphp kullanarak açıkça yapılandırabilirsiniz:

{
	frankenphp {
		num_threads <num_threads> # Herhangi bir işçi tarafından hizmet verilmeyen istekler için başlatılacak PHP iş parçacığı sayısını ayarlar. İşçi iş parçacıkları bunun üzerine eklenir. Varsayılan: İşçilerin iş parçacıklarına sahip olduktan sonra mevcut CPU sayısının 2 katından kalan miktar, en az bir tane.
		max_threads <num_threads> # İşçiler dahil olmak üzere aynı anda çalışabilecek PHP iş parçacığı sayısını sınırlar. Varsayılan: başlangıçta başlatılan iş parçacıkları. 'auto' olarak ayarlanabilir.
		max_wait_time <duration> # Bir isteğin boş bir PHP iş parçacığı bekleme süresinin zaman aşımına uğramadan önceki maksimum süresini ayarlar. Varsayılan: devre dışı.
		max_idle_time <duration> # Otomatik ölçeklenen bir iş parçacığının devre dışı bırakılmadan önce ne kadar süre boş kalabileceğini ayarlar. Varsayılan: 5s.
		max_requests <num> # (deneysel) Bir PHP iş parçacığının yeniden başlatılmadan önce işleyeceği maksimum istek sayısını ayarlar, bellek sızıntılarını azaltmak için faydalıdır. Hem normal hem de işçi iş parçacıkları için geçerlidir. Varsayılan: 0 (sınırsız).
		php_ini <key> <value> # Bir php.ini yönergesi ayarlar. Birden fazla yönerge ayarlamak için birden fazla kez kullanılabilir.
		worker {
			file <path> # Worker komut dosyasının yolunu ayarlar.
			num <num> # Başlatılacak PHP iş parçacığı sayısını ayarlar, varsayılan değer mevcut CPU'ların 2 katıdır.
			env <key> <value> # Ek bir ortam değişkenini verilen değere ayarlar. Birden fazla ortam değişkeni için birden fazla kez belirtilebilir.
			watch <path> # Dosya değişikliklerini izlemek için yolu ayarlar. Birden fazla yol için birden fazla kez belirtilebilir.
			name <name> # İşçinin adını ayarlar, günlüklerde ve metriklerde kullanılır. Varsayılan: worker dosyasının mutlak yolu
			max_consecutive_failures <num> # İşçinin sağlıksız kabul edilmeden önceki maksimum ardışık hata sayısını ayarlar, -1 işçinin her zaman yeniden başlayacağı anlamına gelir. Varsayılan: 6.
		}
	}
}

# ...

Alternatif olarak, worker seçeneğinin tek satırlık kısa formunu kullanabilirsiniz:

{
	frankenphp {
		worker <file> <num>
	}
}

# ...

Aynı sunucuda birden fazla uygulamaya hizmet veriyorsanız birden fazla işçi de tanımlayabilirsiniz:

app.example.com {
    root /path/to/app/public
	php_server {
		root /path/to/app/public # daha iyi önbelleğe almayı sağlar
		worker index.php <num>
	}
}

other.example.com {
    root /path/to/other/public
	php_server {
		root /path/to/other/public
		worker index.php <num>
	}
}

# ...

Genellikle ihtiyacınız olan şey php_server yönergesini kullanmaktır, ancak tam kontrole ihtiyacınız varsa, daha düşük seviyeli php yönergesini kullanabilirsiniz. php yönergesi, önce bir PHP dosyası olup olmadığını kontrol etmek yerine tüm girdiyi PHP’ye iletir. Daha fazla bilgiyi performans sayfasında okuyun. Yolu split_path uzantılarından hiçbirini içermeyen bir istek, bir işçi tarafından işlenmediği sürece 404 alır.

php_server yönergesini kullanmak bu yapılandırmayla aynıdır:

route {
	# Dizin istekleri için sondaki eğik çizgiyi ekleyin
	@canonicalPath {
		file {path}/index.php
		not path */
	}
	redir @canonicalPath {path}/ 308
	# İstenen dosya mevcut değilse, dizin dosyalarını deneyin
	@indexFiles file {
		try_files {path} {path}/index.php index.php
		split_path .php
	}
	rewrite @indexFiles {http.matchers.file.relative}
	# FrankenPHP!
	@phpFiles path *.php
	php @phpFiles
	file_server
}

php_server ve php yönergeleri aşağıdaki seçeneklere sahiptir:

php_server [<matcher>] {
	root <directory> # Sitenin kök klasörünü ayarlar. Varsayılan: `root` yönergesi.
	split_path <delim...> # URI'yi iki parçaya bölmek için alt dizgeleri ayarlar. İlk eşleşen alt dizge bir yol segmentini bitiren "yol bilgisini" yoldan ayırmak için kullanılır. İlk parça eşleşen alt dizeyle sonlandırılır ve gerçek kaynak (CGI betiği) adı olarak kabul edilir. İkinci parça betiğin kullanması için PATH_INFO olarak ayarlanacaktır. Varsayılan: `.php`
	resolve_root_symlink false # Varsa, sembolik bir bağlantıyı değerlendirerek `root` dizininin gerçek değerine çözümlenmesini devre dışı bırakır (varsayılan olarak etkindir).
	name <name> # Bu sunucu için, işçileri, metrikleri ve günlükleri ilişkilendirmek için kullanılan adı ayarlar. Varsayılan: kapsayan rotanın ilk ana bilgisayar eşleştiricisi veya ilk dinleyici adresi.
	env <key> <value> # Ek bir ortam değişkenini verilen değere ayarlar. Birden fazla ortam değişkeni için birden fazla kez belirtilebilir.
	file_server off # Yerleşik file_server yönergesini devre dışı bırakır.
	request_body_timeout <duration> # İstek gövdesi okumalarında bir boşta kalma zaman aşımı ayarlar: takılan (yavaş POST) bir istemci kesilirken, herhangi bir boyuttaki sürekli bir yükleme başarılı olur. Varsayılan: 60s. Devre dışı bırakmak için 0 olarak ayarlayın.
	worker { # Bu sunucuya özgü bir işçi oluşturur. Birden fazla işçi için birden fazla kez belirtilebilir.
		file <path> # İşçi betiğinin yolunu ayarlar, php_server köküne göre göreceli olabilir
		num <num> # Başlatılacak PHP iş parçacığı sayısını ayarlar, varsayılan değer mevcut CPU'ların 2 katıdır.
		name <name> # İşçi için günlüklerde ve metriklerde kullanılan adı ayarlar. Varsayılan: işçi dosyasının mutlak yolu. Ad zaten kullanımda ise sonuna bir sayı eklenir.
		watch <path> # Dosya değişikliklerini izlemek için yolu ayarlar. Birden fazla yol için birden fazla kez belirtilebilir.
		env <key> <value> # Ek bir ortam değişkenini verilen değere ayarlar. Birden fazla ortam değişkeni için birden fazla kez belirtilebilir. Bu işçi için ortam değişkenleri ayrıca php_server üst öğesinden devralınır, ancak burada geçersiz kılınabilir.
		match <path> # İşçiyi bir yol desenine eşleştirir. try_files'ı geçersiz kılar ve yalnızca php_server yönergesinde kullanılabilir.
	}
	worker <other_file> <num> # Global frankenphp bloğundaki gibi kısa formu da kullanabilirsiniz.
}

# Dosya değişikliklerini izleme

Workers yalnızca uygulamanızı bir kez başlatır ve bellekte tutar, bu nedenle PHP dosyalarınızdaki herhangi bir değişiklik hemen yansımaz.

Bunun yerine işçiler, watch yönergesi aracılığıyla dosya değişikliklerinde yeniden başlatılabilir. Bu, geliştirme ortamları için kullanışlıdır.

{
	frankenphp {
		worker {
			file  /path/to/app/public/worker.php
			watch
		}
	}
}

Bu özellik genellikle hot reload ile birlikte kullanılır.

Eğer watch dizini belirtilmezse, FrankenPHP sürecinin başlatıldığı dizin ve alt dizinlerdeki tüm .env, .php, .twig, .yaml ve .yml dosyalarını izleyen ./**/*.{env,php,twig,yaml,yml} değerine geri döner. Bunun yerine, bir veya daha fazla dizini kabuk dosya adı deseni aracılığıyla da belirtebilirsiniz:

{
	frankenphp {
		worker {
			file  /path/to/app/public/worker.php
			watch /path/to/app # /path/to/app'ın tüm alt dizinlerindeki tüm dosyaları izler
			watch /path/to/app/*.php # /path/to/app'da .php ile biten dosyaları izler
			watch /path/to/app/**/*.php # /path/to/app ve alt dizinlerindeki PHP dosyalarını izler
			watch /path/to/app/**/*.{php,twig} # /path/to/app ve alt dizinlerindeki PHP ve Twig dosyalarını izler
		}
	}
}
  • ** deseni, özyinelemeli izlemeyi belirtir
  • Dizinler göreceli de olabilir (FrankenPHP sürecinin başlatıldığı yere göre)
  • Birden fazla işçi tanımladıysanız, bir dosya değiştiğinde hepsi yeniden başlatılacaktır.
  • Çalışma zamanında oluşturulan dosyaları (günlükler gibi) izlerken dikkatli olun, zira bunlar istenmeyen işçi yeniden başlatmalarına neden olabilir.

Dosya izleyici e-dant/watcher üzerine kuruludur.

# İşçiyi yola eşleştirme

Geleneksel PHP uygulamalarında, betikler her zaman public dizininde bulunur. Bu, diğer tüm PHP betikleri gibi ele alınan worker betikleri için de geçerlidir. Worker betiğini public dizininin dışına koymak isterseniz, bunu match yönergesi aracılığıyla yapabilirsiniz.

match yönergesi, yalnızca php_server ve php içinde bulunan try_files‘a optimize edilmiş bir alternatiftir. Aşağıdaki örnek, varsa her zaman public dizinindeki bir dosyayı sunacak, aksi takdirde isteği yol desenine uyan worker’a iletecektir.

{
	frankenphp {
		php_server {
			worker {
				file /path/to/worker.php # dosya public yolunun dışında olabilir
				match /api/* # /api/ ile başlayan tüm istekler bu worker tarafından işlenecektir
			}
		}
	}
}

# İstek sayısına göre iş parçacıklarını yeniden başlatma (deneysel)

FrankenPHP, PHP iş parçacıklarını belirli bir sayıda isteği işledikten sonra otomatik olarak yeniden başlatabilir. Bir iş parçacığı sınıra ulaştığında, tüm belleği ve durumu temizleyerek tamamen yeniden başlatılır. Yeniden başlatma sırasında diğer iş parçacıkları isteklere hizmet vermeye devam eder.

Zamanla bellek büyümesi fark ederseniz, ideal çözüm sızıntıyı ilgili uzantı veya kütüphane bakımcısına bildirmektir. Ancak çözüm, kontrol edemediğiniz üçüncü bir tarafa bağlı olduğunda, max_requests üretim için pratik ve umarız geçici bir çözüm sunar:

{
	frankenphp {
		max_requests 500
	}
}

# Ortam değişkenleri

Aşağıdaki ortam değişkenleri Caddyfile içinde değişiklik yapmadan Caddy yönergelerini entegre etmek için kullanılabilir:

  • SERVER_NAME: dinlenecek adresleri değiştirir, sağlanan ana bilgisayar adları oluşturulan TLS sertifikası için de kullanılacaktır
  • SERVER_ROOT: sitenin kök dizinini değiştirir, varsayılan olarak public/dir
  • CADDY_GLOBAL_OPTIONS: global seçenekleri entegre eder
  • FRANKENPHP_CONFIG: frankenphp yönergesi altına yapılandırma entegre eder

FPM ve CLI SAPI’lerinde olduğu gibi, ortam değişkenleri varsayılan olarak $_SERVER süper globalinde gösterilir.

variables_order‘a ait PHP yönergesinin S değeri bu yönergede E‘nin başka bir yere yerleştirilmesinden bağımsız olarak her zaman ES ile eş değerdir.

# PHP yapılandırması

Ek olarak PHP yapılandırma dosyalarını yüklemek için, PHP_INI_SCAN_DIR ortam değişkeni kullanılabilir. Ayarlandığında, PHP verilen dizinlerde bulunan .ini uzantılı tüm dosyaları yükleyecektir.

PHP yapılandırmasını Caddyfile içindeki php_ini yönergesini kullanarak da değiştirebilirsiniz:

{
    frankenphp {
        php_ini memory_limit 256M

        # veya

        php_ini {
            memory_limit 256M
            max_execution_time 15
        }
    }
}

# HTTPS’i devre dışı bırakma

Varsayılan olarak, FrankenPHP tüm ana bilgisayar adları için (localhost dahil) HTTPS’i otomatik olarak etkinleştirir. HTTPS’i devre dışı bırakmak isterseniz (örneğin bir geliştirme ortamında), SERVER_NAME ortam değişkenini http:// veya :80 olarak ayarlayabilirsiniz:

Alternatif olarak, Caddy belgelerinde açıklanan diğer tüm yöntemleri kullanabilirsiniz.

Eğer localhost ana bilgisayar adı yerine 127.0.0.1 IP adresiyle HTTPS kullanmak isterseniz, lütfen bilinen sorunlar bölümünü okuyun.

# Tam çift yönlü (HTTP/1)

HTTP/1.x kullanırken, tüm gövde okunmadan önce bir yanıt yazmaya izin vermek için tam çift yönlü modun etkinleştirilmesi istenebilir (örneğin: Mercure, WebSocket, Sunucu Tarafından Gönderilen Olaylar vb.).

Bu, Caddyfile‘daki global seçeneklere eklenmesi gereken isteğe bağlı bir yapılandırmadır:

{
  servers {
    enable_full_duplex
  }
}

Caution

Bu seçeneği etkinleştirmek, tam çift yönlü desteği olmayan eski HTTP/1.x istemcilerinin kilitlenmesine neden olabilir. Bu, CADDY_GLOBAL_OPTIONS ortam yapılandırması kullanılarak da yapılandırılabilir:

CADDY_GLOBAL_OPTIONS="servers {
  enable_full_duplex
}"

Bu ayar hakkında daha fazla bilgiyi Caddy belgelerinde bulabilirsiniz.

# İstek gövdesi boyut sınırı

İstek gövdelerinin boyutunu sınırlamak için request_body yönergesini kullanın:

request_body {
	max_size 10MB
}

Daha büyük gövdeye sahip istekler 413 Request Entity Too Large yanıtı alır. PHP, komut dosyası başlamadan önce gövdeyi okursa (formlar ve dosya yüklemeleri gibi Content-Type içeren POST istekleri), komut dosyası çalışmaz. Komut dosyası gövdeyi php://input veya request_parse_body() aracılığıyla kendisi okursa, sınıra ulaşıldığında okuma bir FrankenPHP\RequestBodyTooLargeException hatası fırlatır, böylece kesilen bir gövde asla tam olarak algılanmaz.

# Hata ayıklama modunu etkinleştirin

Docker imajını kullanırken, hata ayıklama modunu etkinleştirmek için CADDY_GLOBAL_OPTIONS ortam değişkenini debug olarak ayarlayın:

docker run -v $PWD:/app/public \
    -e CADDY_GLOBAL_OPTIONS=debug \
    -p 80:80 -p 443:443 -p 443:443/udp \
    dunglas/frankenphp

# Kabuk tamamlama

FrankenPHP, Bash, Zsh, Fish ve PowerShell için yerleşik kabuk tamamlama desteği sağlar. Bu, tüm komutlar ( php-server, php-cli ve extension-init gibi özelleştirilmiş komutlar dahil) ve bunların bayrakları için otomatik tamamlama sağlar.

# Bash

Geçerli kabuk oturumunuzda tamamlamaları yüklemek için:

source <(frankenphp completion bash)

Her yeni oturum için tamamlamaları yüklemek üzere:

Linux:

frankenphp completion bash > /usr/share/bash-completion/completions/frankenphp

macOS:

frankenphp completion bash > $(brew --prefix)/share/bash-completion/completions/frankenphp

# Zsh

Ortamınızda kabuk tamamlama zaten etkin değilse, bunu etkinleştirmeniz gerekecektir. Aşağıdakini bir kez çalıştırabilirsiniz:

echo "autoload -U compinit; compinit" >> ~/.zshrc

Her oturum için tamamlamaları yüklemek üzere, bir kez çalıştırın:

frankenphp completion zsh > "${fpath[1]}/_frankenphp"

Bu kurulumun etkili olması için yeni bir kabuk başlatmanız gerekecektir.

# Fish

Geçerli kabuk oturumunuzda tamamlamaları yüklemek için:

frankenphp completion fish | source

Her yeni oturum için tamamlamaları yüklemek üzere, bir kez çalıştırın:

frankenphp completion fish > ~/.config/fish/completions/frankenphp.fish

# PowerShell

Geçerli kabuk oturumunuzda tamamlamaları yüklemek için:

frankenphp completion powershell | Out-String | Invoke-Expression

Her yeni oturum için tamamlamaları yüklemek üzere, bir kez çalıştırın:

frankenphp completion powershell | Out-File -FilePath (Join-Path (Split-Path $PROFILE) "frankenphp.ps1")
Add-Content -Path $PROFILE -Value '. (Join-Path (Split-Path $PROFILE) "frankenphp.ps1")'

Bu kurulumun etkili olması için yeni bir kabuk başlatmanız gerekecektir.

Bu sayfayı düzenleyin