Skip to content

Commit

Permalink
Update installation guide, firewall needs to be configured before ins…
Browse files Browse the repository at this point in the history
…talling it
  • Loading branch information
mattamon committed Jul 10, 2024
1 parent 83e5e61 commit 758f478
Showing 1 changed file with 17 additions and 16 deletions.
33 changes: 17 additions & 16 deletions doc/01_Installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,29 @@

## Bundle Installation

To install the Studio Backend Bundle, follow the three steps below:
To install the Studio Backend Bundle, follow the four steps below:


1) Install the required dependencies:

```bash
composer require pimcore/studio-backend-bundle
```

2) Make sure the bundle is enabled in the `config/bundles.php` file. The following lines should be added:
2) Enable Firewall settings

To enable the firewall settingsin your project, add the following configuration to your `config/packages/security.yaml` file:

```yaml
security:
firewalls:
pimcore_studio: '%pimcore_studio_backend.firewall_settings%'
access_control:
- { path: ^/studio/api/(docs|docs.json|translations)$, roles: PUBLIC_ACCESS }
- { path: ^/studio, roles: ROLE_PIMCORE_USER }
```
3) Make sure the bundle is enabled in the `config/bundles.php` file. The following lines should be added:

```php
use Pimcore\Bundle\StudioBackendBundle\PimcoreStudioBackendBundle;
Expand All @@ -28,7 +42,7 @@ return [
];
```

3) Install the bundle:
4) Install the bundle:

```bash
bin/console pimcore:bundle:install PimcoreStudioBackendBundle
Expand All @@ -39,19 +53,6 @@ Pimcore Studio Backend also requires the installation and setup of the generic d
The bundle is required by default and also automatically enabled in the bundles.
To install the generic data index refer to [Generic-Data-Index](https://github.com/pimcore/generic-data-index-bundle?tab=readme-ov-file)

## Enable Firewall settings

To enable the firewall settings, add the following configuration to your `config/packages/security.yaml` file:

```yaml
security:
firewalls:
pimcore_studio: '%pimcore_studio_backend.firewall_settings%'
access_control:
- { path: ^/studio/api/(docs|docs.json|translations)$, roles: PUBLIC_ACCESS }
- { path: ^/studio, roles: ROLE_PIMCORE_USER }
```
## Mercure

The Studio Backend Bundle uses Mercure to push updates to the frontend. To enable Mercure, you need to set up a
Expand Down

0 comments on commit 758f478

Please sign in to comment.