guideRunning tests without Docker - Not recommended

This approach to installing the application is not recommended.

The CKEditor Collaboration Server On-Premises is developed, tested and maintained using a docker images.
Thanks to this your production environment is as close to this where we test our products as possible.
Docker images handle all dependencies, which guaranties compatibility with our products.
All that is not possible by using a pure Node.js installation, where you need to take care about the whole environment your application is running on.

However, if your case requires using an installation without Docker, please contact us.

This approach is not recommended. Please use the Docker approach if possible.

Click here to show the Node.js instructions anyway.

# Prerequisites

In order to run tests, the following software must be installed first:

From the CKEditor Ecosystem customer dashboard, download the software ZIP package that matches the downloaded Docker image. Unzip the package and go to the package root directory.

# Running tests

These steps allow you to verify if the application works correctly after the first run or an application update:

  1. Go to tests/.
  2. Run:
    pnpm install
    
  3. Run:
    APPLICATION_ENDPOINT=[your_app_endpoint] ENVIRONMENTS_MANAGEMENT_SECRET_KEY=[your_env_management_secret_key] npm run test
    
  4. If there are no errors after finishing the tests, the application is ready to use.

Notes:

  • APPLICATION_ENDPOINT – An endpoint required to communicate with Collaboration Server On-Premises.
  • ENVIRONMENTS_MANAGEMENT_SECRET_KEY – A variable set in the Collaboration Server On-Premises configuration.
  • There is a possibility that some test will not pass. In this case please run the tests again.
  • You can run the tests from the server where Collaboration Server On-Premises is installed by setting APPLICATION_ENDPOINT=http://localhost[:application_http_port] or from a remote machine by setting APPLICATION_ENDPOINT=https://your.external.address.