Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ x-cache-hits: 5
x-cache-ttl: 87654.321
x-debug-token: 012345
x-debug-token-link: https://<your-project>.ddev.site:<https-port>//_profiler/012345
x-powered-by: Ibexa Commerce v5
x-powered-by: Cohesivo CMS
x-robots-tag: noindex
x-varnish: 12345 67890
xkey: ez-all c52 ct42 l2 pl1 p1 p2
Expand Down
21 changes: 21 additions & 0 deletions docs/infrastructure_and_maintenance/devops.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,27 @@
Here you can see the name of the current SiteAccess and how it was matched.
For reference see the [list of possible SiteAccess matchers](siteaccess_matching.md#available-siteaccess-matchers).

## X-Powered-By header

Check notice on line 101 in docs/infrastructure_and_maintenance/devops.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/infrastructure_and_maintenance/devops.md#L101

[Ibexa.SentenceCapitalizationInHeadings] Use sentence-style capitalization in headings
Raw output
{"message": "[Ibexa.SentenceCapitalizationInHeadings] Use sentence-style capitalization in headings", "location": {"path": "docs/infrastructure_and_maintenance/devops.md", "range": {"start": {"line": 101, "column": 4}}}, "severity": "INFO"}

The system sets an `X-Powered-By` header on every response, identifying the platform running the site:

``` http
X-Powered-By: Cohesivo CMS
```

The header is enabled by default.

Check notice on line 109 in docs/infrastructure_and_maintenance/devops.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/infrastructure_and_maintenance/devops.md#L109

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/infrastructure_and_maintenance/devops.md", "range": {"start": {"line": 109, "column": 12}}}, "severity": "INFO"}
To remove it, disable it under the `ibexa_system_info` configuration:

```yaml
ibexa_system_info:
system_info:
powered_by:
enabled: false
```

The header doesn't expose anything that couldn't be detected through other means.

Check notice on line 119 in docs/infrastructure_and_maintenance/devops.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/infrastructure_and_maintenance/devops.md#L119

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/infrastructure_and_maintenance/devops.md", "range": {"start": {"line": 119, "column": 50}}}, "severity": "INFO"}
Still, as part of [minimizing exposure](security/security_checklist.md#minimize-exposure), you may want to disable it, for example to avoid revealing what software powers your site to automated scanners.

## Logging and debug configuration

Logging in [[= product_name =]] consists of two parts.
Expand Down
13 changes: 2 additions & 11 deletions docs/infrastructure_and_maintenance/security/security_checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,17 +117,8 @@

- If possible, make the back office unavailable on the open internet.
- [Symfony FOSJsRoutingBundle](https://github.com/FriendsOfSymfony/FOSJsRoutingBundle) is required in those releases where it's included, to expose routes to JavaScript. It exposes only the required routes, nothing more. It's only required in the back office SiteAccess though, so you can consider blocking it in other SiteAccesses. You should also go through your own custom routes, and decide for each if you need to expose them or not. See the documentation on [YAML route definitions for exposure](https://github.com/FriendsOfSymfony/FOSJsRoutingBundle/blob/master/Resources/doc/usage.rst#generating-uris).
- By default, a [Powered-By header](update_db_to_2.5.md#powered-by-header) is set. It specifies what version of [[= product_name =]] is running. For example, `x-powered-by: [[= product_name_exp =]] v4`. This doesn't expose anything that couldn't be detected through other means. But if you wish to obscure this, you can either omit the version number, or disable the header entirely by setting `enabled: false`.

```yaml
ibexa_system_info:
system_info:
powered_by:
# major => v4 || minor => v4.6 || none
release: major
# true || false
enabled: false
```
- By default, an `X-Powered-By` header is set.

Check notice on line 120 in docs/infrastructure_and_maintenance/security/security_checklist.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/infrastructure_and_maintenance/security/security_checklist.md#L120

[Ibexa.Lists] Verify list formatting: Full sentences should start with uppercase and end with a period. Sentence fragments should start with lowercase and have no period.
Raw output
{"message": "[Ibexa.Lists] Verify list formatting: Full sentences should start with uppercase and end with a period. Sentence fragments should start with lowercase and have no period.", "location": {"path": "docs/infrastructure_and_maintenance/security/security_checklist.md", "range": {"start": {"line": 120, "column": 1}}}, "severity": "INFO"}
This doesn't expose anything that couldn't be detected through other means, but to obscure this information you can [disable the header entirely](devops.md#x-powered-by-header).

Check notice on line 121 in docs/infrastructure_and_maintenance/security/security_checklist.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/infrastructure_and_maintenance/security/security_checklist.md#L121

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/infrastructure_and_maintenance/security/security_checklist.md", "range": {"start": {"line": 121, "column": 44}}}, "severity": "INFO"}

- Consider whether certain interfaces must be left available on the open internet. For example:
- The `/search` and `/graphql` endpoints
Expand Down
16 changes: 16 additions & 0 deletions docs/release_notes/cohesivo_v6.0_deprecations.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@

This page lists backwards compatibility breaks introduced in Cohesivo v6.0.

## Removed packages

The `ibexa/app-switcher` package, and its `IbexaAppSwitcherBundle`, is no longer part of the 6.0.

## PHP API changes

### ibexa/http-cache
Expand All @@ -46,3 +50,15 @@
| v5.0.9 | [`\Ibexa\Contracts\Messenger\Stamp\SudoStamp`](background_tasks.md#sudostamp) | No longer attached automatically to every dispatched message. For messages that should be processed without taking permissions into account, always attach the SudoStamp manually. |
| v5.0.9 | <nobr>`\Ibexa\Bundle\Messenger\Stamp\DeduplicateStamp`</nobr> | Moved to [`\Ibexa\Contracts\Messenger\Stamp\DeduplicateStamp`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Messenger-Stamp-DeduplicateStamp.html). Covered by [[[= product_name_base =]] Rector](../resources/rector.md) refactoring rules. |
| v5.0.10 | <nobr>[`\Ibexa\Contracts\Messenger\Stamp\DeduplicateStamp`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Messenger-Stamp-DeduplicateStamp.html)</nobr> | Replaced in v6.0 with [`\Symfony\Component\Messenger\Stamp\DeduplicateStamp`]([[= symfony_doc =]]/messenger.html#message-deduplication). A Rector rule will be available for the Cohesivo 6.0 upgrade. Until then, keep using the deprecated `\Ibexa\Contracts\Messenger\Stamp\DeduplicateStamp`, as Ibexa DXP 5.0 doesn't handle the native Symfony stamp. |

### ibexa/user

Check notice on line 54 in docs/release_notes/cohesivo_v6.0_deprecations.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/release_notes/cohesivo_v6.0_deprecations.md#L54

[Ibexa.SentenceCapitalizationInHeadings] Use sentence-style capitalization in headings
Raw output
{"message": "[Ibexa.SentenceCapitalizationInHeadings] Use sentence-style capitalization in headings", "location": {"path": "docs/release_notes/cohesivo_v6.0_deprecations.md", "range": {"start": {"line": 54, "column": 5}}}, "severity": "INFO"}

| Deprecated since | Entity | Change |
| --- |----------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------|
| N/A | `\Ibexa\User\UserSetting\Group\LocationGroup` | Renamed to `\Ibexa\User\UserSetting\Group\LocaleGroup`. The [user setting](add_user_setting.md) group identifier `location` is renamed to `locale`. Custom settings registered under the `location` identifier must be updated to use `locale` instead. |

Check notice on line 58 in docs/release_notes/cohesivo_v6.0_deprecations.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/release_notes/cohesivo_v6.0_deprecations.md#L58

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/release_notes/cohesivo_v6.0_deprecations.md", "range": {"start": {"line": 58, "column": 199}}}, "severity": "INFO"}

Check notice on line 58 in docs/release_notes/cohesivo_v6.0_deprecations.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/release_notes/cohesivo_v6.0_deprecations.md#L58

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/release_notes/cohesivo_v6.0_deprecations.md", "range": {"start": {"line": 58, "column": 287}}}, "severity": "INFO"}

## Configuration keys

| Old name | New name / Comment |
| --- | --- |
| `ibexa_system_info.system_info.powered_by.release` | Removed. See [X-Powered-By header](devops.md#x-powered-by-header) for how the header works in Cohesivo v6.0. |
31 changes: 31 additions & 0 deletions docs/update_and_migration/from_5.0/update_to_6.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
description: Update your installation to v6.0 from the latest v5.0 version.
month_change: false
---

# Update from v5.0 to Cohesivo v6.0

## Update from v5.0.x to v5.0.latest

Before you update to v6.0, you need to [update to the latest maintenance release of v5.0 (v[[= latest_tag_5_0 =]])](update_from_5.0.md).

## Update from v5.0.latest to v6.0.0

### Update custom code for Cohesivo v6.0

See [Cohesivo v6.0 renames, deprecations and removals](cohesivo_v6.0_deprecations.md) for the full list of changes.

#### Remove IbexaAppSwitcher bundle

The `IbexaAppSwitcherBundle` bundle, part of the `ibexa/app-switcher` package, is removed in 6.0.

Check notice on line 20 in docs/update_and_migration/from_5.0/update_to_6.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/update_and_migration/from_5.0/update_to_6.0.md#L20

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/update_and_migration/from_5.0/update_to_6.0.md", "range": {"start": {"line": 20, "column": 80}}}, "severity": "INFO"}

Remove the entry from `config/bundles.php`:

``` diff
- Ibexa\Bundle\AppSwitcher\IbexaAppSwitcherBundle::class => ['all' => true],
```

### Empty the background task queue

Check notice on line 28 in docs/update_and_migration/from_5.0/update_to_6.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/update_and_migration/from_5.0/update_to_6.0.md#L28

[Ibexa.ArticlesInHeadings] Avoid articles in headings.
Raw output
{"message": "[Ibexa.ArticlesInHeadings] Avoid articles in headings.", "location": {"path": "docs/update_and_migration/from_5.0/update_to_6.0.md", "range": {"start": {"line": 28, "column": 11}}}, "severity": "INFO"}

The message format used for [background task deduplication](cohesivo_v6.0_deprecations.md#ibexamessenger) changed between v5.0 and v6.0.

Check notice on line 30 in docs/update_and_migration/from_5.0/update_to_6.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/update_and_migration/from_5.0/update_to_6.0.md#L30

[Ibexa.SentenceLength] Keep your sentences to less than 30 words.
Raw output
{"message": "[Ibexa.SentenceLength] Keep your sentences to less than 30 words.", "location": {"path": "docs/update_and_migration/from_5.0/update_to_6.0.md", "range": {"start": {"line": 30, "column": 1}}}, "severity": "INFO"}
Before you update, process or manually remove pending messages stored in the `ibexa_messenger_messages` table, so no message in the old format remains.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -934,6 +934,7 @@ nav:
- Update to v5.0: update_and_migration/from_4.6/update_to_5.0.md
- Update from v5.0:
- Update to v5.0: update_and_migration/from_5.0/update_from_5.0.md
- Update to v6.0: update_and_migration/from_5.0/update_to_6.0.md
- Migrate to Ibexa DXP or Cohesivo:
- Migrate from eZ Publish Platform: update_and_migration/migrate_to_ibexa_dxp/migrating_from_ez_publish_platform.md
- Migrate from eZ Publish: update_and_migration/migrate_to_ibexa_dxp/migrating_from_ez_publish.md
Expand Down
Loading