Skip to content

Commit

Permalink
updated README with docker instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
mplogas committed Mar 15, 2024
1 parent 52de91e commit 908e68f
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# KernelMemory.FileWatcher
## A service for automating document ingestion for Semantic Kernel's KernelMemory service
## Automated document ingestion for Semantic Kernel's KernelMemory service


## Overview
Expand Down Expand Up @@ -65,3 +65,21 @@ The service's configuration is defined in the `appsettings.json` file. Here you
In the `FileWatcher` section, you can specify multiple directories to watch. For each directory, you can specify a path, a filter for the types of files to watch, an index, and whether to include subdirectories.

In the `KernelMemory` section, you can specify the endpoint of the KernelMemory service, your API key, and the schedule for the `HttpWorker` to check for new file events.

## Running the Service

To run the service, you can either run the `KernelMemory.FileWatcher` project directly or build and run the Docker container.

### Running as a Standalone Service

To run the service as a standalone service, you can build and run the `KernelMemory.FileWatcher` project using the following commands:

```bash
dotnet run --project KernelMemory.FileWatcher
```

### Running as a Docker Container

```sh
docker run -v /path/to/your/appsettings.json:/config/appsettings.json -v /path/to/your/documents-01:/data/documents-01 mplogas/km-filewatcher:latest
```

0 comments on commit 908e68f

Please sign in to comment.