Skip to main content
Markdown

Deploying a PHP app

Under PHP-FPM with nginx or Apache, or any host that runs PHP 8.1 with sodium: nothing realtime is kept on your servers, so any of them answers any request.

Its settings​

WORDPLUS_SITE, WORDPLUS_SECRETfrom your app in WordPlus Cloud
WORDPLUS_LOCAL_KEYyours: kept as long as the app

Set them in the server environment (the PHP-FPM env[WORDPLUS_SITE] = …, the Apache SetEnv), or a file outside the web root. Keep the secret and the local key out of your repository and out of every page. The key reaches pages through config(), which is what it is for.

Its addresses​

Add every address your pages are served from to the app in WordPlus Cloud: scheme, host and port exactly (https://shop.example.com, https://www.shop.example.com). A page anywhere else is refused with wrong_origin. Up to 20 addresses an app. If your server hears webhooks, set their address there too.

Its routes​

Send every request that is not a file to your front controller, so /api/realtime/auth, /calls, /keys and /webhook reach it:

location / {
try_files $uri /index.php$is_args$args;
}
FallbackResource /index.php

Its files​

realtime-worker.js, realtime-rooms.min.js, realtime-rooms-e2ee.worker.js and realtime-ui.min.js are served by your app, from its own address: a browser runs a worker only from the page origin. Copy them in your build (npx wordplus-realtime copy public/), so each release serves the ones its package came with.

Sessions​

The PHP file sessions are locked while a request has them open, so the requests of a page wait on each other. Open the session for reading only where a route just needs to know the user: session_start( [ 'read_and_close' => true ] ), as the example routes do.

Content Security Policy​

If your pages send one, let them reach the WordPlus Cloud servers (the realtime servers, which may move a connection to another of them, and the media servers for group calls) and run the workers from your own address:

connect-src 'self' https://*.wordplus.cloud wss://*.wordplus.cloud;
worker-src 'self';

Clocks​

Your server signs what it sends with the time. Keep its clock synced (NTP): one more than 5 minutes off has its emits refused with stale_signature.