-
Notifications
You must be signed in to change notification settings - Fork 306
feat: add documentation for Plugin Store Authentication #2209
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.
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| --- | ||
| nav: | ||
| title: Plugin Store Authentication | ||
| position: 100 | ||
| --- | ||
|
|
||
| # Plugin Store Authentication | ||
| The build process might needs to authentication against plugins stores (Shopware official and any other one), this document explain how configure this authentication. | ||
|
Check warning on line 8 in products/paas/shopware/fundamentals/plugins-store-authentication.md
|
||
|
|
||
| We rely on `composer` to fecth plugin during build time configured with two environment variables: `SHOPWARE_PACKAGES_TOKEN` and `COMPOSER_AUTH`. | ||
|
|
||
| ## Shopware plugin store | ||
| Under normal circumstances, during the provisioning of your organization we automatically create the secret `SHOPWARE_PACKAGES_TOKEN`. | ||
| This secret contains the token to authenticate against the official Shopware plugin store. | ||
|
|
||
| If this secret is not present you can recreate it: | ||
| ``` | ||
| sw-paas vault create --type buildenv --key SHOPWARE_PACKAGES_TOKEN | ||
| ``` | ||
|
Comment on lines
+17
to
+19
|
||
| Then just put the token provided by Shopware. | ||
|
|
||
| ## Third party plugin store | ||
| To authenticate against third party plugin store or plugin repository you need to create a secret named `COMPOSER_AUTH`. | ||
| The content need to be the json string required for the store/repository, run the following command: | ||
| ``` | ||
|
Comment on lines
+22
to
+25
|
||
| sw-paas vault create --type buildenv --key COMPOSER_AUTH | ||
| ``` | ||
|
Comment on lines
+25
to
+27
|
||
|
|
||
| The content of the secret needs to be a json string compatible with composer, for instance: | ||
| - basic auth string: | ||
| ```json | ||
| { | ||
| "http-basic": { | ||
| "git.mycompany.com": { | ||
| "password": "mypassword", | ||
| "username": "myuser" | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| - a bearer token: | ||
| ```json | ||
| { | ||
| "bearer": { | ||
| "git.mycompany.com": "mytoken" | ||
| } | ||
| } | ||
| ``` | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are several spelling/grammar issues in the intro that make it hard to understand (e.g., “might needs to authentication”, “plugins stores”, “document explain”, “fecth plugin”). Please rewrite these sentences for correct English (e.g., “might need to authenticate…”, “plugin stores…”, “this document explains…”, “fetch plugins…”).