Skip to content

Commit 7533d2f

Browse files
committed
docs(site): improve installation guide
1 parent 71f7198 commit 7533d2f

File tree

1 file changed

+21
-19
lines changed

1 file changed

+21
-19
lines changed

site/content/en/docs/Archives/v2.3.x/Developer Guide/installation.md

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,43 @@
11
---
2-
date: 2020-05-21
2+
date: 2021-09-05
33
title: "Installation"
44
linkTitle: "Installation"
55
weight: 10
66
description: >
77
How to install Connect File Pulse
88
---
99

10+
## Confluent Hub
1011

11-
**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).
12+
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) .
1213

13-
{{% alert title="Caution" color="warning" %}}
14-
You should note that the connector downloaded from Confluent Hub may not reflect the latest available version.
15-
{{% /alert %}}
16-
17-
**Confluent Hub CLI installation**
18-
19-
Use the [Confluent Hub client](https://docs.confluent.io/current/confluent-hub/client.html) to install this connector with:
14+
The following command can be used to install the last version of the plugin available on the Confluent Hub:
2015

2116
```bash
22-
confluent-hub install streamthoughts/kafka-connect-file-pulse:latest
17+
$ confluent-hub install streamthoughts/kafka-connect-file-pulse:latest
2318
```
2419

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

27-
Download the distribution ZIP file for the latest available version.
24+
## Manual Installation
2825

29-
**Example :**
30-
```bash
31-
export VERSION=1.3.0
32-
curl -sSL https://github.com/streamthoughts/kafka-connect-file-pulse/releases/download/v$VERSION/streamthoughts-kafka-connect-file-pulse-$VERSION.zip
33-
```
26+
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).
27+
All Connect FilePulse versions are available on the [GitHub Releases Page](https://github.com/streamthoughts/kafka-connect-file-pulse/releases).
3428

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

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

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

0 commit comments

Comments
 (0)