Skip to content

Commit da94cfc

Browse files
authored
Add default dummy value for JWT to ease installation (#958)
* Add default dummy value for JWT to ease installation * update docs * update docs
1 parent 0f13d0b commit da94cfc

4 files changed

Lines changed: 17 additions & 11 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Every description is translatable and can be found in the `studio_api_docs.en.ya
1717
## Requirements
1818
This bundle requires the following dependencies:
1919

20-
* Pimcore Core Framework 11
20+
* Pimcore Core Framework 12
2121
* Generic Execution Engine as part of the Pimcore Core Framework
2222
* Generic Data Index
2323
* Mercure (https://mercure.rocks)

doc/00_Installation.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,22 @@
11
# Installation of the Studio Backend Bundle
22

3-
:::info
4-
5-
This bundle is only supported on Pimcore Core Framework 11.
6-
7-
:::
8-
93
## Bundle Installation
104

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

7+
1) Make sure prerequisites are met:
8+
9+
- [GenericExecutionEngineBundle](https://docs.pimcore.com/platform/Pimcore/Development_Tools_and_Details/Generic_Execution_Engine/) installed and activated
10+
- [GenericDataIndexBundle](https://docs.pimcore.com/platform/Generic_Data_Index/Installation/) installed and activated
11+
1312

14-
1) Install the required dependencies:
13+
2) Install the required dependencies:
1514

1615
```bash
1716
composer require pimcore/studio-backend-bundle
1817
```
1918

20-
2) Enable Firewall settings
19+
3) Enable Firewall settings
2120

2221
To enable the firewall settings in your project, add the following configuration to your `config/packages/security.yaml` file:
2322
Keep in mind that the prefix part pimcore-studio/api can be changed to any other value in the config.
@@ -31,7 +30,7 @@ security:
3130
- { path: ^/pimcore-studio/api, roles: ROLE_PIMCORE_USER }
3231
```
3332
34-
3) Make sure the bundle is enabled in the `config/bundles.php` file. The following lines should be added:
33+
4) Make sure the bundle is enabled in the `config/bundles.php` file. The following lines should be added:
3534

3635
```php
3736
use Pimcore\Bundle\StudioBackendBundle\PimcoreStudioBackendBundle;
@@ -43,7 +42,7 @@ return [
4342
];
4443
```
4544

46-
4) Install the bundle:
45+
5) Install the bundle:
4746

4847
```bash
4948
bin/console pimcore:bundle:install PimcoreStudioBackendBundle

doc/02_Mercure_Setup.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,12 @@ you configured in configuration). This request should return the text
9595
Missing "topic" parameter.
9696
```
9797
98+
or
99+
100+
```
101+
Unauthorized
102+
```
103+
98104
> Also execute ``curl https://your-app-domain.com/hub`` (or `server_side_url` you configured in
99105
> configuration) from the command line of the server to ensure that the URL is also accessible by the
100106
> server itself.

src/DependencyInjection/Configuration.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -288,6 +288,7 @@ private function addMercureConfiguration(ArrayNodeDefinition $node): void
288288
->scalarNode('jwt_key')
289289
->info('The key used to sign the JWT token. Must be longer than 256 bits.')
290290
->isRequired()
291+
->defaultValue('some-secret-default')
291292
->end()
292293
->integerNode('cookie_lifetime')
293294
->info('Lifetime of the mercure cookie in seconds. Default is one hour.')

0 commit comments

Comments
 (0)