We have a shiny, new BEE Plugin technical docs site.
You can find a new version of this page here.
Availability: Paid plans only
As you may have noticed, BEE plugin is provided with a default cloud storage for files (images or files that the message uses or links to).
This approach may fit well for applications that offer content creation for the first time, especially if they don't need to share these files with other areas of the application.
If you do want users to be able to access the same image and file directories that they use elsewhere in your application, we have a solution.
We created a way to connect to a custom file system provider, allowing you to use BEE with your own file storage, no matter which technology you use.
What is a custom file system provider?
It's an API that will allow the BEE editor to perform actions with files out of the plugin environment, connecting your file system to BEE's file manager.
It can be built with your preferred technology: just be sure to follow our instructions to ensure successful communication between the two systems.
Once successfully connected, when an user uploads a file or creates a new folder in the BEE editor's file manager, this API will perform these actions in your storage, instead of our default cloud storage.
How flexible is it?
Directories permissions, root directory to use, how thumbnails for images are generated, etc.: it's entirely up to you.
How can I develop my file system provider?
We prepared some documentation and some sample code to get you started her: Start building a file system provider API for BEE.
How do I connect it to the editor?
- Log into your account at developers.beefree.io.
- Locate the application that you want to work with
- Access the application details and then open the configuration panel.
- Under "Storage options" you will find a switch to activate the connection.
- Before saving this option you will be asked to provide a URL, a user and a password to connect your API. Make sure that these parameters have been entered correctly.