You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
api_key: <CONNECTOR_API_KEY> # Optional. If not provided, the connector will use the elasticsearch.api_key instead
142
-
```
143
-
144
-
<DocCallOut title="Tip">
145
-
Learn more about the `config.yml` file in the [repo docs](https://github.com/elastic/connectors/blob/main/docs/CONFIG.md).
146
-
</DocCallOut>
147
-
148
-
**Run the connector service**
149
-
150
-
Once you've configured the connector code, you can run the connector service.
151
-
152
-
In your terminal or IDE:
153
-
154
-
- `cd`into the root of your `elastic/connectors` clone/fork.
155
-
- Run the following commands to compile and run the connector service:
156
-
157
-
```shell
158
-
make install
159
-
make run
160
-
```
161
-
162
-
The connector service should now be running in your terminal. If the connection to your ((es)) instance was successful, the **Configure your connector** step will be activated in the project's UI.
163
-
164
-
Here we're working locally. In a production setup, you'll deploy the connector service to your own infrastructure.
165
-
166
112
### Run with Docker
167
113
168
-
You can also deploy connector clients using Docker.
114
+
You can deploy connector clients using Docker.
169
115
Follow these instructions.
170
116
171
117
**Step 1: Download sample configuration file**
@@ -220,7 +166,61 @@ Find all available Docker images in the [official Elastic Docker registry](https
220
166
Each individual connector client reference contain instructions for deploying specific connectors using Docker.
221
167
</DocCallOut>
222
168
223
-
## Enter data source details in UI
169
+
### Run from source
170
+
171
+
Running from source requires cloning the repository and running the code locally.
172
+
Use this approach if you're actively customizing connectors.
173
+
174
+
Follow these steps:
175
+
176
+
- Clone or fork the repository locally with the following command:
177
+
```shell
178
+
git clone https://github.com/elastic/connectors
179
+
```
180
+
- Open the `config.yml.example` file in the `connectors` repository and rename it to `config.yml`.
181
+
- Update the following settings to match your environment:
api_key: <CONNECTOR_API_KEY> # Optional. If not provided, the connector will use the elasticsearch.api_key instead
199
+
```
200
+
201
+
<DocCallOut title="Tip">
202
+
Learn more about the `config.yml` file in the [repo docs](https://github.com/elastic/connectors/blob/main/docs/CONFIG.md).
203
+
</DocCallOut>
204
+
205
+
**Run the connector service**
206
+
207
+
Once you've configured the connector code, you can run the connector service.
208
+
209
+
In your terminal or IDE:
210
+
211
+
- `cd`into the root of your `elastic/connectors` clone/fork.
212
+
- Run the following commands to compile and run the connector service:
213
+
214
+
```shell
215
+
make install
216
+
make run
217
+
```
218
+
219
+
The connector service should now be running in your terminal. If the connection to your ((es)) instance was successful, the **Configure your connector** step will be activated in the project's UI.
220
+
221
+
Here we're working locally. In a production setup, you'll deploy the connector service to your own infrastructure.
222
+
223
+
## Step 3: Enter data source details in UI
224
224
225
225
Once the connector service is running, it's time to head back to the UI to finalize the connector configuration.
226
226
You should now see the **Configure your connector** step in your project's UI.
@@ -235,7 +235,7 @@ For example, the Sharepoint Online connector requires the following details abou
235
235
- **Secret value**
236
236
- **Comma-separated list of tables**
237
237
238
-
## Connect to an index
238
+
## Step 4: Connect to an index
239
239
240
240
Once you've entered the data source details, you need to connect to an index.
241
241
This is the final step in your project's UI, before you can run a sync.
0 commit comments