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
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ Here’s how you can help out:
10
10
11
11
This guide will walk you through our development process, where to get help and other handy resources. We want to make it easy for you to get involved, whether it’s updating our docs, improving the app, or fixing some bugs.
12
12
13
-
Got questions? We are hanging out on [Slack](https://join.slack.com/t/merlinncommunity/signup), ready to help.
13
+
Got questions? We are hanging out on [Slack](https://join.slack.com/t/vesppercommunity/signup), ready to help.
14
14
15
15
If you’re short on time for coding, no worries! You can still support Merlinn in other ways:
16
16
@@ -123,7 +123,7 @@ Additionally, if you want to work on our Python services (currently only the `da
123
123
```bash
124
124
yarn install
125
125
```
126
-
2. Create a `.env` file as described in the [quickstart guide](https://github.com/merlinn-co/merlinn?tab=readme-ov-file#quick-installation-%EF%B8%8F).
126
+
2. Create a `.env` file as described in the [quickstart guide](https://github.com/vespper/vespper?tab=readme-ov-file#quick-installation-%EF%B8%8F).
@@ -121,7 +121,7 @@ You can find the installation video [here](https://www.loom.com/share/1f562cb067
121
121
122
122
5. Update these variables:
123
123
124
-
- `SLACK_BOT_TOKEN`, `SLACK_APP_TOKEN` and `SLACK_SIGNING_SECRET` - These variables are needed in order to talk to Merlinn on Slack. Please follow [this guide](https://github.com/merlinn-co/merlinn/tree/main/config/slack/README.md) to create a new Slack app in your organization.
124
+
- `SLACK_BOT_TOKEN`, `SLACK_APP_TOKEN` and `SLACK_SIGNING_SECRET` - These variables are needed in order to talk to Merlinn on Slack. Please follow [this guide](https://github.com/vespper/vespper/tree/main/config/slack/README.md) to create a new Slack app in your organization.
125
125
126
126
- (Optional) `SMTP_CONNECTION_URL` - This variable is needed in order to invite new members to your Merlinn organization via email and allow them to use the bot. It's not mandatory if you just want to test Merlinn and play with it. If you do want to send invites to your team members, you can use a service like SendGrid/Mailgun. Should follow this pattern: `smtp://username:password@domain:port`.
127
127
@@ -133,25 +133,25 @@ You can find the installation video [here](https://www.loom.com/share/1f562cb067
133
133
That's it. You should be able to visit Merlinn's dashboard in http://localhost:5173.
134
134
Simply create a user **(with the same e-mail as the one in your Slack user)** and start to configure your organization. If something does not work for you, please checkout our [troubleshooting](#troubleshooting-️) or reach out to us via our [support channels](#support-and-feedback-️).
135
135
136
-
The next steps are to configure your organization a bit more (connect incident management tools, build a knowledge base, etc). Head over to the [connect & configure](https://docs.merlinn.co/Getting%20started/Configure%20&%20connect) section in our docs for more information 💫
136
+
The next steps are to configure your organization a bit more (connect incident management tools, build a knowledge base, etc). Head over to the [connect & configure](https://docs.vespper.com/Getting%20started/Configure%20&%20connect) section in our docs for more information 💫
137
137
138
138
#### Using DockerHub images
139
139
140
-
If you want, you can pull our [Docker images](https://hub.docker.com/u/merlinnco) from DockerHub instead of cloning the repo & building from scratch.
140
+
If you want, you can pull our [Docker images](https://hub.docker.com/u/vespper) from DockerHub instead of cloning the repo & building from scratch.
141
141
142
142
In order to do that, follow these steps:
143
143
144
144
1. Download configuration files:
145
145
146
146
```bash
147
-
curl https://raw.githubusercontent.com/merlinn-co/merlinn/main/tools/scripts/download_env_files.sh | sh
147
+
curl https://raw.githubusercontent.com/vespper/vespper/main/tools/scripts/download_env_files.sh | sh
148
148
```
149
149
150
150
2. Follow steps 2 and 5 above to configure LiteLLM Proxy and your `.env` file respectively. Namely, you'd need to configure your OpenAI key at `config/litellm/.env` and configure your Slack credentials in the root `.env`.
151
151
152
152
3. Spin up the environment using docker compose:
153
153
```bash
154
-
curl https://raw.githubusercontent.com/merlinn-co/merlinn/main/tools/scripts/start.sh | sh
154
+
curl https://raw.githubusercontent.com/vespper/vespper/main/tools/scripts/start.sh | sh
155
155
```
156
156
157
157
That's it 💫 You should be able to visit Merlinn's dashboard in http://localhost:5173.
@@ -172,7 +172,7 @@ That's it 💫 You should be able to visit Merlinn's dashboard in http://localho
172
172
173
173
### Deployment ☁️
174
174
175
-
Visit our [example guides](https://github.com/merlinn-co/merlinn/tree/main/examples) in order to deploy Merlinn to your cloud.
175
+
Visit our [example guides](https://github.com/vespper/vespper/tree/main/examples) in order to deploy Merlinn to your cloud.
176
176
177
177
### Visualize Knowledge Base 🗺️
178
178
@@ -193,16 +193,16 @@ To learn how to use VectorAdmin, visit the [docs](https://github.com/Mintplex-La
193
193
In order of preference the best way to communicate with us:
194
194
195
195
- **GitHub Discussions**: Contribute ideas, support requests and report bugs (preferred as there is a static & permanent for other community members).
196
-
- **Slack**: community support. Click [here](https://merlinn.co/#community) to join.
197
-
- **Privately**: contact at support@merlinn.co
196
+
- **Slack**: community support. Click [here](https://vespper.com/#community) to join.
197
+
- **Privately**: contact at support@vespper.com
198
198
199
199
## Contributing to Merlinn ⛑️
200
200
201
-
If you're interested in contributing to Merlinn, checkout our [`CONTRIBUTING.md`](https://github.com/merlinn-co/merlinn/blob/main/CONTRIBUTING.md) file 💫 🧙♂️
201
+
If you're interested in contributing to Merlinn, checkout our [`CONTRIBUTING.md`](https://github.com/vespper/vespper/blob/main/CONTRIBUTING.md) file 💫 🧙♂️
202
202
203
203
## Troubleshooting ⚒️
204
204
205
-
If you encounter any problems/errors/issues with Merlinn, checkout our [troubleshooting guide](https://github.com/merlinn-co/merlinn/tree/main/TROUBLESHOOTING.md). We try to update it regularly, and fix some of the urgent problems there as soon as possible.
205
+
If you encounter any problems/errors/issues with Merlinn, checkout our [troubleshooting guide](https://github.com/vespper/vespper/tree/main/TROUBLESHOOTING.md). We try to update it regularly, and fix some of the urgent problems there as soon as possible.
206
206
207
207
Moreover, feel free to reach out to us at our [support channels](#support-and-feedback-️).
208
208
@@ -215,17 +215,17 @@ This allows us to:
215
215
- Understand how Merlinn is used so we can improve it.
216
216
- Track overall usage for internal purposes and external reporting, such as for fundraising.
217
217
218
-
Rest assured, the data collected is not shared with third parties and does not include any sensitive information. We aim to be transparent, and you can review the specific data we collect [here](https://github.com/merlinn-co/merlinn/blob/main/services/api/src/telemetry/listener.ts).
218
+
Rest assured, the data collected is not shared with third parties and does not include any sensitive information. We aim to be transparent, and you can review the specific data we collect [here](https://github.com/vespper/vespper/blob/main/services/api/src/telemetry/listener.ts).
219
219
220
220
If you prefer not to participate, you can easily opt-out by setting `TELEMETRY_ENABLED=false` inside your `.env`.
221
221
222
222
## License 📃
223
223
224
-
This project is licensed under the Apache 2.0 license - see the [LICENSE](https://github.com/merlinn-co/merlinn/tree/main/LICENSE.md) file for details
224
+
This project is licensed under the Apache 2.0 license - see the [LICENSE](https://github.com/vespper/vespper/tree/main/LICENSE.md) file for details
225
225
226
226
## Learn more 🔍
227
227
228
-
Check out the official website at https://merlinn.cofor more information.
228
+
Check out the official website at https://vespper.comfor more information.
We strongly recommend using the latest version of Merlinn to receive all security updates.
2
2
3
-
For more information, please refer to our [Data Security & Privacy](https://docs.merlinn.co/Data%20Privacy%20&%20Security) page in the documentation or contact security@merlinn.com.
3
+
For more information, please refer to our [Data Security & Privacy](https://docs.vespper.com/Data%20Privacy%20&%20Security) page in the documentation or contact security@vespper.comm.
Copy file name to clipboardexpand all lines: TROUBLESHOOTING.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
# Troubleshooting Merlinn
2
2
3
3
In this document, you can find common scenarios where we're currently have problems. If you're interested in some of these
4
-
issues and want to help, feel free to create an [issue](https://github.com/merlinn-co/merlinn/issues).
4
+
issues and want to help, feel free to create an [issue](https://github.com/vespper/vespper/issues).
5
5
6
6
### `service "X" can't be used with extends as it declare depends_on`
7
7
@@ -18,7 +18,7 @@ Once your `.env` is updated, restart your containers using `docker compose up -d
18
18
19
19
This is not an error, but a scenario where you cannot send messages to Merlinn. It usually means you didn't enable the messages capability. Go to "App Home" and enable "Messages Tab" and "Allow users to send Slash commands and messages from the messages tab".
20
20
21
-
More information can be found in the [Slack guide](https://github.com/merlinn-co/merlinn/tree/main/config/slack).
21
+
More information can be found in the [Slack guide](https://github.com/vespper/vespper/tree/main/config/slack).
Copy file name to clipboardexpand all lines: config/slack/README.md
+6-6
Original file line number
Diff line number
Diff line change
@@ -33,29 +33,29 @@ Once the app is installed, continue to the next section where you'll extract som
33
33
In this section, you will configure some more things and extract these 3 variables: `SLACK_SIGNING_SECRET`, `SLACK_APP_TOKEN` and `SLACK_BOT_TOKEN`. They are needed in order for Merlinn's services to interact with your workspace.
34
34
35
35
1. In the "Basic Information" page, copy the “Signing Secret” from the Slack app settings and paste it into the .env file as `SLACK_SIGNING_SECRET`.
36
-
2. In the same page "Basic Information", go to "App-Level Tokens" and click "Generate Token and Scopes". Give it a meaningful name (e.g merlinn-token) and grant it 2 scopes: `connections:write` and `authorizations:read`. Copy the token and put it in the main `.env` as `SLACK_APP_TOKEN`.
36
+
2. In the same page "Basic Information", go to "App-Level Tokens" and click "Generate Token and Scopes". Give it a meaningful name (e.g vespper-token) and grant it 2 scopes: `connections:write` and `authorizations:read`. Copy the token and put it in the main `.env` as `SLACK_APP_TOKEN`.
37
37
3. In the "OAuth & Permissions", copy the “Bot User OAuth Token” and put it in the main `.env` as `SLACK_BOT_TOKEN`.
38
38
4. Go to "App Home" and enable "Messages Tab" and "Allow users to send Slash commands and messages from the messages tab".
39
39
40
40
### **(Optional)** Customize the Slack app
41
41
42
42
1. You can change the name and background color of the Slackbot in the Slack app settings.
43
-
2. You can use Merlinn's logo as your app's logo. View the logo [here](https://storage.googleapis.com/merlinn-assets/brand/logo-wizard-full.jpg).
43
+
2. You can use Merlinn's logo as your app's logo. View the logo [here](https://storage.googleapis.com/vespper-assets/brand/vespper-cat.png).
44
44
45
45
### Test the Slack app
46
46
47
-
To test the app, you should launch the slackbot & project. Go back to the [readme](https://github.com/merlinn-co/merlinn?tab=readme-ov-file#quick-installation-%EF%B8%8F) and go to step 6 ("launch the project").
47
+
To test the app, you should launch the slackbot & project. Go back to the [readme](https://github.com/vespper/vespper?tab=readme-ov-file#quick-installation-%EF%B8%8F) and go to step 6 ("launch the project").
48
48
49
49
After you launch it, follow these steps to test the Slack app:
50
50
51
51
1. Go to your Slack workspace and go to Merlinn's direct messages.
52
-
2. Write `/merlinn help` in the message bar.
52
+
2. Write `/vespper help` in the message bar.
53
53
54
54
Now you should see the help message of the bot! 🥳
55
55
This means the basic functionality works.
56
56
57
57
## Next Steps
58
58
59
-
If you were redirected to this guide from the main README.md, please continue to setup your environment [there](https://github.com/merlinn-co/merlinn?tab=readme-ov-file#quick-installation-%EF%B8%8F).
59
+
If you were redirected to this guide from the main README.md, please continue to setup your environment [there](https://github.com/vespper/vespper?tab=readme-ov-file#quick-installation-%EF%B8%8F).
60
60
61
-
Also, you can visit our [docs](https://docs.merlinn.co/) for more information.
61
+
Also, you can visit our [docs](https://docs.vespper.com/) for more information.
0 commit comments