From 3eab53728805bd8fd389e9eda92d287887dfd517 Mon Sep 17 00:00:00 2001 From: sebprt Date: Thu, 27 Jun 2024 15:48:13 +0200 Subject: [PATCH] Added configuration for auth in composer section and for the spreadsheet plugin --- content/connectivity/spreadsheet/_index.en.md | 15 ++++ content/core-concept/satellite/_index.en.md | 71 +++++++++++++++++-- .../getting-started/execution/_index.en.md | 2 +- 3 files changed, 81 insertions(+), 7 deletions(-) diff --git a/content/connectivity/spreadsheet/_index.en.md b/content/connectivity/spreadsheet/_index.en.md index 0bd3836..2a1da34 100644 --- a/content/connectivity/spreadsheet/_index.en.md +++ b/content/connectivity/spreadsheet/_index.en.md @@ -212,3 +212,18 @@ spreadsheet: {{< /tabs >}} > Note: this option is only available for loaders + +### Write to more than one sheet in the same file + +In order to be able to write to several sheets of the same file, we've added a `persistent` option to your loader. + +Since a loader writes to a single sheet, you need to set this option on each concerned loader. + +```yaml +spreadsheet: + loader: + persistent: true + # ... +``` + +> Note: this option is only available for Excel and Open Document loaders. diff --git a/content/core-concept/satellite/_index.en.md b/content/core-concept/satellite/_index.en.md index 6ae5a90..6e3e445 100644 --- a/content/core-concept/satellite/_index.en.md +++ b/content/core-concept/satellite/_index.en.md @@ -219,9 +219,10 @@ satellites: The `auth` parameter is optional and allows you to use registries that are not public and must be accessed through an authentication. The parameter is the way for you to tell composer how to authenticate to the registry server. -Each auth can have the following configuration fields: -- `url`: the url of your repository -- `token`: when you use a connection via token, you must use this field +##### HTTP Basic Authentication + +HTTP Basic authentication requires three elements: a `url`, a `username` and a `password`. This type of authentication sends +this information encoded in Base64 in the HTTP request header. ```yaml version: '0.3' @@ -231,10 +232,68 @@ satellites: # ... composer: auth: - - { url: 'http-basic.kiboko.repo.packagist.com', token: '0fe8828b23371406295ca2b72634c0a3df2431c4787df0173ea051a0c639' } -``` + - { type: 'http-basic', url: 'xxxx.repo.packagist.com', token: '' } +``` + +##### HTTP Bearer Authentication + +HTTP Bearer authentication requires a `domain` and a `token`. This token is included in the HTTP request header to authorize access. + +```yaml +version: '0.3' +satellites: + my_satellite: + label: 'My first Satellite' + # ... + composer: + auth: + - { type: 'http-bearer', url: 'xxxx.repo.packagist.com', token: '' } +``` + +##### GitLab OAuth -> Notice : Currently, the only way to identify to a repository is to use tokens. Support for other authentication methods is in our backlog. +GitLab OAuth authentication requires a `token`. The service url is optional; by default it is set to https://gitlab.com. + +```yaml +version: '0.3' +satellites: + my_satellite: + label: 'My first Satellite' + # ... + composer: + auth: + - { type: 'gitlab-oauth', token: '' } +``` + +##### GitLab Token + +GitLab Token authentication requires a `token`. The service url is optional; by default it is set to https://gitlab.com. + +```yaml +version: '0.3' +satellites: + my_satellite: + label: 'My first Satellite' + # ... + composer: + auth: + - { type: 'gitlab-token', token: '' } +``` + +##### GitHub OAuth + +GitHub OAuth authentication requires a `token`. The service url is optional; by default, it is set to https://github.com. + +```yaml +version: '0.3' +satellites: + my_satellite: + label: 'My first Satellite' + # ... + composer: + auth: + - { type: 'gitlab-token', token: '' } +``` ### Setting up the runtime diff --git a/content/getting-started/execution/_index.en.md b/content/getting-started/execution/_index.en.md index 78d66d0..36400dd 100644 --- a/content/getting-started/execution/_index.en.md +++ b/content/getting-started/execution/_index.en.md @@ -15,7 +15,7 @@ the [adapter](http://localhost:1313/documentation/core-concept/satellite#setting Runs the pipeline that was compiled under `src/build/`: ```shell -php bin/satellite run:pipeline src/build/ +php bin/satellite run src/build/ ``` This command will run your satellite service located in a directory. The execution of your service may take several minutes,