Skip to content

Commit

Permalink
Add .env.example and update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
StanGirard committed Apr 21, 2024
1 parent d6c6fb4 commit e1c9132
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
SLACK_BOT_TOKEN=
SLACK_SIGNING_SECRET=
QUIVR_API_KEY=
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,31 @@ This Slack bot allows users to ask questions to a Quivr brain directly from Slac
QUIVR_API_KEY=your-quivr-api-key
```

4. Set up a Slack app:
- Create a new Slack app.
- Add a bot user to the app.
- Install the app to your workspace.
- Copy the bot token and signing secret to the `.env` file.

5. Go to your Quivr account:
- Go to the user settings page.
- Copy the API key to the `.env` file.

## Usage

1. Start the bot:
```
ngrok http 1234
```
This will create a public URL that you can use to expose the bot to the internet.
```
uvicorn main:api --reload --port 1234
```
2. Set up the Slack app:
- Go to the Slack app settings page.
- Add the public URL as the request URL for the Slack app.
- Subscribe to the `app_mention` event.
- Save the changes.

2. Invite the bot to a Slack channel.

Expand Down

0 comments on commit e1c9132

Please sign in to comment.