Skip to content

Commit

Permalink
docs(site): improve installation guide
Browse files Browse the repository at this point in the history
  • Loading branch information
fhussonnois committed Sep 5, 2021
1 parent 71f7198 commit 7533d2f
Showing 1 changed file with 21 additions and 19 deletions.
@@ -1,41 +1,43 @@
---
date: 2020-05-21
date: 2021-09-05
title: "Installation"
linkTitle: "Installation"
weight: 10
description: >
How to install Connect File Pulse
---

## Confluent Hub

**Connect FilePulse** can be installed either from [GitHub Releases Page](https://github.com/streamthoughts/kafka-connect-file-pulse/releases) or from [Confluent Hub](https://www.confluent.io/hub/streamthoughts/kafka-connect-file-pulse).
Connect FilePulse can be installed directly from [Confluent Hub](https://www.confluent.io/hub/streamthoughts/kafka-connect-file-pulse) using the [Confluent Hub client](https://docs.confluent.io/current/confluent-hub/client.html) .

{{% alert title="Caution" color="warning" %}}
You should note that the connector downloaded from Confluent Hub may not reflect the latest available version.
{{% /alert %}}

**Confluent Hub CLI installation**

Use the [Confluent Hub client](https://docs.confluent.io/current/confluent-hub/client.html) to install this connector with:
The following command can be used to install the last version of the plugin available on the Confluent Hub:

```bash
confluent-hub install streamthoughts/kafka-connect-file-pulse:latest
$ confluent-hub install streamthoughts/kafka-connect-file-pulse:latest
```

**Download Installation**
{{% alert title="Caution" color="warning" %}}
You should note that the connector downloaded from Confluent Hub may not reflect the latest available version.
{{% /alert %}}

Download the distribution ZIP file for the latest available version.
## Manual Installation

**Example :**
```bash
export VERSION=1.3.0
curl -sSL https://github.com/streamthoughts/kafka-connect-file-pulse/releases/download/v$VERSION/streamthoughts-kafka-connect-file-pulse-$VERSION.zip
```
Connect FilePulse is distributed as a ZIP file which is compatible with the [Confluent Hub client](https://docs.confluent.io/current/confluent-hub/client.html).
All Connect FilePulse versions are available on the [GitHub Releases Page](https://github.com/streamthoughts/kafka-connect-file-pulse/releases).

Extract it into one of the directories that is listed on the `plugin.path` worker configuration property.
To manually install the connector you can download the distribution ZIP file and extract all the dependencies under a target directory.

You can also use the Confluent Hub CLI for installing it.
1. Download the latest available version:
```bash
$ export VERSION=2.3.0
$ curl -sSL https://github.com/streamthoughts/kafka-connect-file-pulse/releases/download/v$VERSION/streamthoughts-kafka-connect-file-pulse-$VERSION.zip
```
2. Create a directory under the `plugin.path` on your Connect worker, e.g., `connect-source-filepulse`.
3. Copy all of the dependencies under the newly created subdirectory.
4. Restart the Connect worker.

Note: You can also use the [Confluent Hub CLI](https://docs.confluent.io/current/confluent-hub/client.html) for installing it.
```bash
$ confluent-hub install --no-prompt streamthoughts-kafka-connect-file-pulse-$VERSION.zip
```
Expand Down

0 comments on commit 7533d2f

Please sign in to comment.