Skip to main content

PHP example

Overview​

This example will help you integrate ONLYOFFICE Docs into your web application written on PHP.

It is intended for testing purposes and demonstrating functionality of the editors. DO NOT use this integration example on your own server without proper code modifications. In case you enabled the test example, disable it before going for production.

Important security info​

Please keep in mind the following security aspects when you are using test examples:

  • There is no protection of the storage from unauthorized access since there is no need for authorization.
  • There are no checks against parameter substitution in links, since the parameters are generated by the code according to the pre-arranged scripts.
  • There are no data checks in requests of saving the file after editing, since each test example is intended for requests only from ONLYOFFICE Docs.
  • There are no prohibitions on using test examples from other sites, since they are intended to interact with ONLYOFFICE Docs from another domain.

Step 1. Install the prerequisites and run the website with the editors​

The PHP example offers various installation options, but we highly recommend using Docker for this purpose.

Option 1. Using Docker​

To run the example using Docker, you will need Docker Desktop 4.17.0 or Docker Engine 20.10.23 with Docker Compose 2.15.1. Additionally, you might want to consider installing GNU Make 4.4.1, although it is optional. These are the minimum versions required for the tools.

Once you have everything installed, download the release archive and unarchive it:

curl --output PHP.Example.zip --location https://github.com/ONLYOFFICE/document-server-integration/releases/latest/download/PHP.Example.zip
unzip PHP.Example.zip

Then open the example directory and up containers:

cd "PHP Example"
make compose-prod

By default, the server starts at localhost:80.

To configure the example, you can edit the environment variables in docker-compose.yml. See below for more information about environment variables.

Option 2. On local machine​

Download and install ONLYOFFICE Docs (packaged as Document Server):

Get ONLYOFFICE Docs

Check the detailed guide to learn how to install it on Windows, Linux, or Docker.

To run the example on your local machine, you will need PHP 8.2.11 with Composer 2.6.5. Additionally, you might want to consider installing GNU Make 4.4.1, although it is optional. These are the minimum versions required for the tools.

Once you have everything installed, download the release archive and unarchive it:

curl --output PHP.Example.zip --location https://github.com/ONLYOFFICE/document-server-integration/releases/latest/download/PHP.Example.zip
unzip PHP.Example.zip

Then open the example directory, install dependencies, and start the server:

cd "PHP Example"
make prod
make server-prod

By default, the server starts at 0.0.0.0:9000.

To configure the example, you can pass the environment variables before the command that starts the server. See below for more information about environment variables.

Step 2. Check accessibility​

In case the example and ONLYOFFICE Docs are installed on different computers, make sure that your server with the example installed has access to the ONLYOFFICE Docs with the address which you specify instead of documentserver in the configuration files.

Make sure that the ONLYOFFICE Docs in its turn has access to the server with the example installed with the address which you specify instead of example.com in the configuration files.

Step 3. Configure the PHP example​

The example is configured by changing environment variables.

ParameterExampleDescription
ADDRESS0.0.0.0The address where the server should be started.
PORT80The port on which the server should be running.
DOCUMENT_SERVER_PRIVATE_URLhttp://proxy:8080The URL through which the server will communicate with ONLYOFFICE Docs.
DOCUMENT_SERVER_PUBLIC_URLhttp://localhost:8080The URL through which a user will communicate with ONLYOFFICE Docs.
EXAMPLE_URLhttp://proxyThe URL through which ONLYOFFICE Docs will communicate with the server.
JWT_SECRETyour-256-bit-secretJWT authorization secret. Leave blank to disable authorization.