Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Task] Update installation guide, firewall needs to be configured before installation #240

Merged
merged 1 commit into from
Jul 10, 2024
Merged

[Task] Update installation guide, firewall needs to be configured before installation #240

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 17 additions & 16 deletions doc/01_Installation.md
View file
Open in desktop
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
Loading