Skip to content

Commit 3eab537

Browse files
committed
Added configuration for auth in composer section and for the spreadsheet plugin
1 parent 00c7636 commit 3eab537

File tree

3 files changed

+81
-7
lines changed

3 files changed

+81
-7
lines changed

content/connectivity/spreadsheet/_index.en.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -212,3 +212,18 @@ spreadsheet:
212212

213213
{{< /tabs >}}
214214
> Note: this option is only available for loaders
215+
216+
### Write to more than one sheet in the same file
217+
218+
In order to be able to write to several sheets of the same file, we've added a `persistent` option to your loader.
219+
220+
Since a loader writes to a single sheet, you need to set this option on each concerned loader.
221+
222+
```yaml
223+
spreadsheet:
224+
loader:
225+
persistent: true
226+
# ...
227+
```
228+
229+
> Note: this option is only available for Excel and Open Document loaders.

content/core-concept/satellite/_index.en.md

Lines changed: 65 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -219,9 +219,10 @@ satellites:
219219
The `auth` parameter is optional and allows you to use registries that are not public and must be accessed through an authentication.
220220
The parameter is the way for you to tell composer how to authenticate to the registry server.
221221

222-
Each auth can have the following configuration fields:
223-
- `url`: the url of your repository
224-
- `token`: when you use a connection via token, you must use this field
222+
##### HTTP Basic Authentication
223+
224+
HTTP Basic authentication requires three elements: a `url`, a `username` and a `password`. This type of authentication sends
225+
this information encoded in Base64 in the HTTP request header.
225226

226227
```yaml
227228
version: '0.3'
@@ -231,10 +232,68 @@ satellites:
231232
# ...
232233
composer:
233234
auth:
234-
- { url: 'http-basic.kiboko.repo.packagist.com', token: '0fe8828b23371406295ca2b72634c0a3df2431c4787df0173ea051a0c639' }
235-
```
235+
- { type: 'http-basic', url: 'xxxx.repo.packagist.com', token: '<token>' }
236+
```
237+
238+
##### HTTP Bearer Authentication
239+
240+
HTTP Bearer authentication requires a `domain` and a `token`. This token is included in the HTTP request header to authorize access.
241+
242+
```yaml
243+
version: '0.3'
244+
satellites:
245+
my_satellite:
246+
label: 'My first Satellite'
247+
# ...
248+
composer:
249+
auth:
250+
- { type: 'http-bearer', url: 'xxxx.repo.packagist.com', token: '<token>' }
251+
```
252+
253+
##### GitLab OAuth
236254

237-
> Notice : Currently, the only way to identify to a repository is to use tokens. Support for other authentication methods is in our backlog.
255+
GitLab OAuth authentication requires a `token`. The service url is optional; by default it is set to https://gitlab.com.
256+
257+
```yaml
258+
version: '0.3'
259+
satellites:
260+
my_satellite:
261+
label: 'My first Satellite'
262+
# ...
263+
composer:
264+
auth:
265+
- { type: 'gitlab-oauth', token: '<token>' }
266+
```
267+
268+
##### GitLab Token
269+
270+
GitLab Token authentication requires a `token`. The service url is optional; by default it is set to https://gitlab.com.
271+
272+
```yaml
273+
version: '0.3'
274+
satellites:
275+
my_satellite:
276+
label: 'My first Satellite'
277+
# ...
278+
composer:
279+
auth:
280+
- { type: 'gitlab-token', token: '<token>' }
281+
```
282+
283+
##### GitHub OAuth
284+
285+
GitHub OAuth authentication requires a `token`. The service url is optional; by default, it is set to https://github.com.
286+
287+
```yaml
288+
version: '0.3'
289+
satellites:
290+
my_satellite:
291+
label: 'My first Satellite'
292+
# ...
293+
composer:
294+
auth:
295+
- { type: 'gitlab-token', token: '<token>' }
296+
```
238297

239298
### Setting up the runtime
240299

content/getting-started/execution/_index.en.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ the [adapter](http://localhost:1313/documentation/core-concept/satellite#setting
1515
Runs the pipeline that was compiled under `src/build/`:
1616

1717
```shell
18-
php bin/satellite run:pipeline src/build/
18+
php bin/satellite run src/build/
1919
```
2020

2121
This command will run your satellite service located in a directory. The execution of your service may take several minutes,

0 commit comments

Comments
 (0)