Quick start
The aim of this article is to get you up and running with CKEditor 5 Collaboration Features.
Follow the steps below:
- Subscribe to the Collaboration 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).
- Create a CKEditor 5 build with support for collaboration and configure it.
All steps are explained in details below.
# Subscribe to the Collaboration service
Sign up to the Collaboration service. After signing up, you will receive access to the customer dashboard (CKEditor Ecosystem dashboard).
For your convenience, the Collaboration trial gives you full access to the Easy Image service, without the need of signing up to the Easy Image trial separately.
# 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 subscription that you want to manage and press the “Manage” link.
On the next page you will see the subscription parameters overview together with the management area below.
# 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:
- Choose the website that you want to manage and click the “Manage” link:
- Press the “CKEditor configuration” button for the environment that you want to manage:
- Press the “Create dev token URL” button in the “Collaboration configuration” dialog that opened:
The development token URL will show up in the dialog:
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.
# Simulating random users
The development token URL will generate random user names by default. If you would like to specify user details, you may pass them in the query string using:
user.name– Full name.user.id– The unique ID of the user in your system.user.email(Optional) – Email address.user.avatar(Optional) – The URL to an avatar.
So if your token URL is https://17717-dev.cke-cs-dev.com/token/dev/XXX then you may connect to CKEditor Cloud Services as user Jane Doe with the ID 13 using the customized development token URL: https://17717-dev.cke-cs-dev.com/token/dev/XXX?user.name=Jane%20Doe&user.id=13
# 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.
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.
Make sure to keep the access credentials in a safe place.