guideQuick start

The aim of this article is to get you up and running with the Easy Image service.

Follow the steps below:

  • Subscribe to Easy Image on the CKEditor website. You can also sign up to a 30 days free trial.
  • Generate your access credentials in the CKEditor Ecosystem customer dashboard.
  • Write a script that generates one-time tokens for authorizing end users of your application in CKEditor Cloud Services (using access credentials created earlier).
  • Configure CKEditor.

All steps are explained in details below.

# Subscribe to CKEditor Cloud Services

Create an account in CKEditor Cloud Services by signing up to Easy Image. After signing up, you will receive access to the customer dashboard (CKEditor Ecosystem dashboard).

# Log in to the CKEditor Ecosystem dashboard

Log in to the CKEditor Ecosystem dashboard and navigate to “Your products > Cloud Services”.

From the list of available subscriptions in the dashboard choose the Easy Image subscription that you want to manage and press the “Manage” link.

Your trials view.

On the next page you will see the subscription parameters overview together with the management area below.

Easy Image trial view.

# Create token endpoint

You now need to create a security token endpoint in your application. The role of this endpoint is to securely authorize end users of your application to use CKEditor Cloud Services only if they should have access to the content or action they are requesting.

# Development token endpoint

If you are just starting, you may use the development token endpoint URL which is available out of the box and requires no coding on your side. The URL of the development token endpoint can be obtained easily in three simple steps:

  1. Choose the website that you want to manage and click the “Manage” link:

Websites management in CKEditor Ecosystem dashboard.

  1. Press the “CKEditor configuration” button for the environment that you want to manage:

CKEditor configuration button in environment management.

  1. Press the “Create dev token URL” button in the “CKEditor configuration” dialog that opened:

The button to generate development token URL.

The development token URL will show up in the dialog:

CKEditor configuration with the development token URL.

The development token endpoint is a special endpoint to help you in getting started with CKEditor Cloud Services. It offers unrestricted, full access to the service and will expire 30 days after being used for the first time. You should not use it on production. Anyone knowing this URL will have full access to the associated environment.

# Writing your own token endpoint

Skip this step if you use the development token endpoint.

To write your own security token endpoint, you need to create access credentials for the selected environment by clicking the “Create new access credentials” link.

Show access credentials for an environment.

For your convenience, one default set of access credentials was created automatically. You can see them after you click the “Show access credentials” link for a particular environment.

Access credentials for a particular environment.

Make sure to keep the access credentials in a safe place.

# Configure the application

In order to configure your CKEditor installation to use Easy Image, you need to provide two values:

  • The security token endpoint (token URL) of your choice.
  • The upload URL.

Note: Every customer (organization in the CKEditor Ecosystem dashboard) has their own, unique URLs to communicate with CKEditor Cloud Services, so it is necessary to configure the upload URL. The value of upload URL can be found in the CKEditor Ecosystem dashboard (press the “CKEditor configuration” button next to the selected environment).

CKEditor configuration with the development token URL.

# CKEditor 5 configuration options

The following configuration options need to be set in your CKEditor 5 configuration:

Refer to the Easy Image integration guide in the CKEditor 5 documentation for more information.

# CKEditor 4 configuration options

The following configuration options need to be set in your CKEditor 4 configuration:

Note: Apart form setting the configuration options above, make sure that your CKEditor 4 build has the Easy Image plugin enabled. See the Easy Image Integration guide for more details.