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.

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

Added configuration for auth in composer section and for the spreadsh… #75

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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
15 changes: 15 additions & 0 deletions content/connectivity/spreadsheet/_index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
71 changes: 65 additions & 6 deletions content/core-concept/satellite/_index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand All @@ -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: '<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: '<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: '<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: '<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: '<token>' }
```

### Setting up the runtime

Expand Down
2 changes: 1 addition & 1 deletion content/getting-started/execution/_index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
Loading