Easy Image - quick start
This article aims to get you up and running with the Easy Image feature in your CKEditor Premium Features free trial.
Follow the steps below:
- Subscribe to the CKEditor Premium Features 30-day free trial.
- Generate your access credentials in the CKEditor Ecosystem customer dashboard.
- Configure CKEditor.
# Subscribe to the CKEditor Premium Features free trial
Create an account by signing up for CKEditor Premium Features free trial. After signing up, you will receive access to the customer dashboard (CKEditor Ecosystem dashboard).
You will be asked to check the features you are most interested in.
Checking these features does not affect the trial bundle contents — all the features will be available regardless of the choice. We just want to know your needs better.
# Log in to the CKEditor Ecosystem dashboard
Log in to the CKEditor Ecosystem dashboard. You will receive a confirmation email and will be asked to create a password for your account. Keep it safe.
# Account dashboard
After logging in, click “CKEditor” under the “Your products” header on the left. You will see the subscription parameters overview together with the management area below.
# Creating token endpoint
Before you can use your newly activated CKEditor Premium Features free trials bundle, you first 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 (fast and easy)
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:
To work with CKEditor Premium Features like Easy Image, you need to create an environment. Environments allow you to create access credentials, manage webhooks, configure features and connect to CKEditor Cloud Services. You may have more than one environment to serve separate instances or integrations. From the list of environments choose the one that you want to manage.
Please refer to the the environment management guide if needed.
After choosing the environment, press the “Generate” button in the “Development token URL” section of the “CKEditor configuration” tab:
The development token URL will show up in the “Development token URL” section:
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 in production. Anyone knowing this URL will have full access to the associated environment.
# Writing your token endpoint (advanced users)
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 going to the “Access credentials” tab and clicking the “Create a new access key” button.
Read more in the Creating access credentials section of the Environments management guide.
# Integrating the Easy Image feature with the editor
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 (for the files).
Note: Every customer (organization in the CKEditor Ecosystem customer dashboard) has their own, unique URLs to communicate with CKEditor Cloud Services, so it is necessary to configure the upload URL. The value of the upload URL can be found in the CKEditor Ecosystem dashboard (navigate to the “CKEditor 5 configuration” tab in the selected environment).
# 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 from 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.