Download the PHP package bedita/manager without Composer

BEdita Manager

Backend Manager for BEdita API.

Prerequisites

• PHP >= 8.3
• Composer
• Node >= 22
• Yarn >= 1.15

Install

• Create project via composer

This will create a new manager folder and install composer dependencies. If you are using a .zip or .tar.gz release file you just need to unpack it and then run composer install. Run same command if you do a git clone on this repo.

• Build JS/CSS bundles with yarn from manager folder

• Configure BEdita API base URL and API KEY in config/.env like:

To test the webapp you can simply run builtin webserver from manager folder like this

And then point your browser to http://localhost:8765/

For any other use than a simple test we recommend to configure your preferred web server like Nginx/Apache and point to webroot/ as vhost document root.

 Configuration

You can further configure your BEdita Manager instance in config/app_local.php with environment and project specific settings.

Have look at the main Manager configuration wiki page on how to customize your Manager instance.

Module access by role

In Administration > Roles Modules accesses, choose Write, Read, or Hidden for each module, then save the role. The first save creates the application's AccessControl configuration if it does not exist. Without this configuration, no additional Manager module restrictions apply; API permissions still apply.

Only non-admin roles allowed to access the Manager application are listed. If no roles are eligible, use the Roles and Endpoint permissions links to create a role or grant it write permission on the auth endpoint for this Manager application. Admin users are not restricted by module access control. Saving a role updates only that role's settings; selecting Write for all modules removes its previous restrictions. Use Remove module access configuration to delete the role's entry from AccessControl entirely. Confirmation is required; the role itself, API permissions, and other roles' settings are unchanged. The role remains listed and can be configured again.

JS Development with webpack

Using .env

It's easy to configure config/.env to match your web server and proxy requirements, see below. (default proxy: localhost:8080, default server: localhost:3000)

To start develop mode run

Production build with Bundle Report

ESlint

• Run ESlint via yarn, to check linting on js files

Run unit tests

To setup tests locally simply copy tests/.env.example to tests/.env and set env vars accordingly. To launch tests:

To run those tests you may want to use a Docker image as BEdita4 API endpoint. For instance if you can pull a Docker image via or

Then you may run the image with

You can then set env vars accordingly like this:

and you're ready to go

Licensing

BEdita is released under LGPL, Lesser General Public License v3.