Skip to content

Commit

Permalink
Merge pull request #122 from seqeralabs/109-add-api-info-readme
Browse files Browse the repository at this point in the history
docs: api endpoint detail in config
  • Loading branch information
ejseqera authored Mar 4, 2024
2 parents 6059e8d + 349b314 commit 1a1607f
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,9 +82,16 @@ Create a Seqera Platform access token using the [Seqera Platform](https://tower.
`seqerakit` reads this token from the environment variable `TOWER_ACCESS_TOKEN`. Please export it into your terminal as shown below:

```bash
export TOWER_ACCESS_TOKEN=<your access token>
export TOWER_ACCESS_TOKEN=<Your access token>
```

For Enterprise installations of Seqera Platform, you will also need to configure the API endpoint that will be used to connect to the Platform. You can do so by exporting the following environment variable:
```bash
export TOWER_API_ENDPOINT=<Tower API URL>
```
By default, this is set to `https://api.tower.nf` to connect to Seqera Platform Cloud.


## Usage

To confirm the installation of `seqerakit`, configuration of the Seqera Platform CLI and connection to the Platform is working as expected. This will run the `tw info` command under the hood:
Expand Down

0 comments on commit 1a1607f

Please sign in to comment.