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

docs: enhance licensing and feature management information in commerc… #1675

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: enhance licensing and feature management information in commerc… #1675

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1f8ca0f
docs: enhance licensing and feature management information in commerc…
shyim Jan 24, 2025
ca71247
Apply suggestions from code review
shyim Jan 27, 2025
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
32 changes: 32 additions & 0 deletions products/plugins/commercial/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,35 @@
::: warning
In accordance with a Shopware merchant's active account configuration, features within the plugin will be in *active* or *inactive* (whilst still being installed within the Shopware codebase). Pay close attention to any install information or special conditions for the provided features.
:::

## Licensing

On installation, the commercial plugin tries to fetch the license key using the logged-in Shopware Account. If this can't be fetched, the plugin can be installed, but all features are deactivated. If you log into your Shopware Account, you can fetch the license key again using `bin/console commercial:license:update`.

For further debugging you can run the command:

```bash
bin/console commercial:license:info
```

which will show the current license key, whether it is set, and when it expires.

## Disable Features

::: info
This Feature is available since 6.6.10.0
:::

The commercial plugin consists of multiple features. Since you may not need all the Features included with the plugin, you can specify with the `SHOPWARE_COMMERCIAL_ENABLED_BUNDLES` environment variable all commercial bundles you want to be enabled.

Example environment variable:

```text
SHOPWARE_COMMERCIAL_ENABLED_BUNDLES=CustomPricing,Subscription
```

You can find all bundle names using this command:

```bash
./bin/console debug:container --parameter kernel.bundles --format=json

Check warning on line 55 in products/plugins/commercial/index.md

View workflow job for this annotation

GitHub Actions / LanguageTool

[LanguageTool] products/plugins/commercial/index.md#L55 

If a new sentence starts here, add a space and start with an uppercase letter. (LC_AFTER_PERIOD[1])
Suggestions: ` Bundles`, ` bundles`
Rule: https://community.languagetool.org/rule/show/LC_AFTER_PERIOD?lang=en-US&subId=1
Category: CASING
Raw output 
products/plugins/commercial/index.md:55:49: If a new sentence starts here, add a space and start with an uppercase letter. (LC_AFTER_PERIOD[1])
 Suggestions: ` Bundles`, ` bundles`
 Rule: https://community.languagetool.org/rule/show/LC_AFTER_PERIOD?lang=en-US&subId=1
 Category: CASING
```
Loading