Creating a PILOT Extension
This article is intended for developers and administrators who create extensions for PILOT.
It describes the general workflow. Examples and technical requirements are available in the PILOT Extensions repository.
In this article
If you are creating an extension for the first time, start with the step-by-step guide From Hello World to Launch. It describes the complete process, from creating an extension to launching it in PILOT.
Useful resources:
The repository supports several hosting options:
-
Cloudflare Workers — upload a ZIP archive or folder through a browser without using Git. The project URL uses the workers.dev domain.
-
GitHub Pages — host files from a public GitHub repository. This option is useful if you want to keep the source code in GitHub and publish changes from the repository.
The Cloudflare workflow is described below. If you choose GitHub Pages, follow the deployment guide.
The extension code will be publicly available. Do not include passwords, private keys, or secret API tokens in it.
1. Define the task the extension should solve
2. Read the guide for creating your first extension
3. Choose a suitable example or template
4. Create the extension files
5. Upload the files to an external hosting service
6. Check that Module.js opens correctly
7. Register the extension in the PILOT Admin panel
8. Grant access to the required accounts
9. Check the extension in PILOT
Prepare a ZIP archive or folder with the extension files. The following two files must be located at the root level:
my_extension/
├── index.html
└── Module.js
|
Module.js is the main extension file. PILOT loads the extension through this file.
Use lowercase letters and the snake_case format for the extension name, for example, hello_world. This name is used in the extension entry class.
Example:
Ext.define('Store.hello_world.Module', {
extend: 'Ext.Component',
initModule: function () {}
});
|
The index.html file must be located at the root of the folder or archive, not inside a nested folder.
Cloudflare is an external service for hosting extension files. After uploading the files, Cloudflare provides a public project URL. You will need this URL when adding the extension in the PILOT Admin panel.
To upload the files through a browser:
1. Open Workers & Pages
2. Select Create application
3. On the Make something new screen, select Upload your static files
4. Upload the ZIP archive or folder containing the extension files
After deployment, Cloudflare creates a project with a URL on the workers.dev domain, for example:
https://my-extension.workers.dev
|
The project name will be different for each extension.
Before registering the extension in PILOT, check that Module.js is available:
1. Open the project URL in a browser and add /Module.js to the end:
https://my-extension.workers.dev/Module.js
|
2. Make sure the file opens
When registering the extension, enter only the base project URL in the URL field, without /Module.js:
https://my-extension.workers.dev
|
If Module.js does not open, fix the deployment first. Do not register the extension in PILOT until the file is available.
If the Cloudflare interface differs from this description, do not guess the next step. Send the visible button names and a screenshot to the extension administrator or developer. If the issue is related to your Cloudflare account, contact Cloudflare Support.
|
After uploading the files, add the extension in the PILOT Admin panel.

Enter the following information:
-
Name — a short internal name for the extension
-
Full name — the name displayed to users
-
Description — a short description of what the extension does
-
URL — the base URL where the extension files are hosted
-
Published — select the checkbox to publish the extension. Clear it to unpublish the extension
-
Icon class — select an icon for the extension from the list
-
Author — the name of the author or company
After registering the extension, grant access to the required accounts on the Access tab
1. Open the same Workers project
2. Select New deployment
3. Upload the new version of the files
4. Check the previous /Module.js URL
5. Reload PILOT
If the base URL has not changed, do not create a new project or change the extension record in the Admin panel.
The extension does not appear in the list
Check the following:
1. Ask the administrator whether your account has access to the extension
2. If the extension is not published, ask the administrator to enable Show drafts
3. If the extension is not a draft, make sure the administrator has published it
4. Make sure you are signed in to the correct account
The extension appears but does not start
Check the activation switch on the left side of the extension card. If it is disabled, enable it and reload the PILOT page.
If the extension still does not start, ask the administrator to check whether the extension URL is available.
The extension does not load after publication
Check the extension file URL:
1. Open the extension base URL in a browser
2. Add /Module.js to the URL
3. Make sure the file opens
For example:
https://my-extension.workers.dev/Module.js
|
If the file does not open:
-
check the URL for typing errors
-
make sure the Cloudflare project is available
-
check that the file is named exactly Module.js
-
make sure the file is located at the root of the folder or archive
-
check that a new deployment was created after uploading the files
The archive does not contain a valid extension
Make sure the files are located at the root level:
my_extension/
├── index.html
└── Module.js
|
Incorrect structure:
my_extension/
└── files/
├── index.html
└── Module.js
|
Move the files to the root of the archive and upload it again.
The old version is still displayed after an update
1. Open the same Workers project where the extension is hosted
2. Select New deployment
3. Upload the new version of the files
4. Check the previous /Module.js URL
5. Reload PILOT
The extension stopped working after the URL changed
If the project URL has changed:
1. Open the extension settings in the Admin panel
2. Compare the value in the URL field with the new project URL
3. Save the new URL
4. Check that /Module.js opens at the new address