Skip to content

Commit

Permalink
rebranding
Browse files Browse the repository at this point in the history
  • Loading branch information
topaztee committed Sep 23, 2024
1 parent deb2fb0 commit 63d5184
Show file tree
Hide file tree
Showing 87 changed files with 885 additions and 1,107 deletions.
4 changes: 2 additions & 2 deletions .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ POSTGRES_CONNECTION_URL=postgres://${POSTGRES_USER}:${POSTGRES_PASSWORD}@postgre

# MongoDB
MONGO_PORT=27017
MONGO_URI=mongodb://mongo:${MONGO_PORT}/merlinn-db
MONGO_URI=mongodb://mongo:${MONGO_PORT}/vespper-db

# ChromaDB
CHROMA_PORT=8000
Expand Down Expand Up @@ -130,4 +130,4 @@ PAGERDUTY_SECRET="put your secret"

# Log parser
LOG_PARSER_PORT=3004
LOG_PARSER_URL=${ENVOY_URL}/log-parser
LOG_PARSER_URL=${ENVOY_URL}/log-parser
6 changes: 3 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ data
*.launch
.settings/
*.sublime-workspace
merlinn.iml
vespper.iml

# IDE - VSCode
.vscode/*
Expand Down Expand Up @@ -55,5 +55,5 @@ config/litellm/.env
.terraform.tfstate.lock.info
terraform.tfstate
terraform.tfstate.backup
merlinn-aws
merlinn-aws.pub
vespper-aws
vespper-aws.pub
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Here’s how you can help out:

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.

Got questions? We are hanging out on [Slack](https://join.slack.com/t/merlinncommunity/signup), ready to help.
Got questions? We are hanging out on [Slack](https://join.slack.com/t/vesppercommunity/signup), ready to help.

If you’re short on time for coding, no worries! You can still support Merlinn in other ways:

Expand Down Expand Up @@ -123,7 +123,7 @@ Additionally, if you want to work on our Python services (currently only the `da
```bash
yarn install
```
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).
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).
3. Run the infrastructure services using docker:
```bash
docker compose --profile infra up
Expand Down
58 changes: 29 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,34 @@
# Merlinn - open-source AI on-call developer

<div align="center">
<a href="https://merlinn.co">
<a href="https://vespper.co">
<img src="./assets/logo-wizard.jpg" alt="Merlinn-logo" width="30%"/>
</a>
</div>
<br />
<div align="center">
<div>
<a href="https://docs.merlinn.co"><strong>Docs</strong></a> ·
<a href="https://docs.vespper.com"><strong>Docs</strong></a> ·
<a href="https://www.loom.com/share/85dc64d021cc40c4b1064389c20782a6?sid=91b063df-8111-40f0-9ea4-793d5fbe3f6f"><strong>Demo</strong></a> ·
<a href="https://github.com/merlinn-co/merlinn/issues"><strong>Report Bug</strong></a> ·
<a href="https://github.com/orgs/merlinn-co/discussions"><strong>Feature Request</strong></a> ·
<a href="https://merlinn.co/blog"><strong>Blog</strong></a> ·
<a href="https://join.slack.com/t/merlinncommunity/signup"><strong>Slack</strong></a>
<a href="https://github.com/vespper/vespper/issues"><strong>Report Bug</strong></a> ·
<a href="https://github.com/orgs/vespper/discussions"><strong>Feature Request</strong></a> ·
<a href="https://vespper.com/blog"><strong>Blog</strong></a> ·
<a href="https://join.slack.com/t/vesppercommunity/signup"><strong>Slack</strong></a>
</div>
</div>
<br />
<div style="display: flex" style="margin-bottom: 20px">
<a href="https://merlinn.co/?utm_source=github"><img src="https://img.shields.io/badge/Website-blue?logo=googlechrome&logoColor=orange"/></a>
<a href="https://calendly.com/dudu-merlinn/45-minute-meeting"><img src="https://img.shields.io/badge/Book%20a%20Call-blue" /></a>
<a href="https://github.com/merlinn-co/merlinn/blob/main/LICENSE.md"><img src="https://img.shields.io/badge/License-Apache 2.0-red.svg?style=flat-square" alt="Apache 2.0 License"></a>
<a href="https://github.com/merlinn-co/merlinn/actions/workflows/ci.yml/badge.svg?branch=main">
<img src="https://github.com/merlinn-co/merlinn/actions/workflows/ci.yml/badge.svg?branch=main" alt="main-workflow">
<a href="https://vespper.com/?utm_source=github"><img src="https://img.shields.io/badge/Website-blue?logo=googlechrome&logoColor=orange"/></a>
<a href="https://calendly.com/dudu-vespper/45-minute-meeting"><img src="https://img.shields.io/badge/Book%20a%20Call-blue" /></a>
<a href="https://github.com/vespper/vespper/blob/main/LICENSE.md"><img src="https://img.shields.io/badge/License-Apache 2.0-red.svg?style=flat-square" alt="Apache 2.0 License"></a>
<a href="https://github.com/vespper/vespper/actions/workflows/ci.yml/badge.svg?branch=main">
<img src="https://github.com/vespper/vespper/actions/workflows/ci.yml/badge.svg?branch=main" alt="main-workflow">
</a>
<a href="https://github.com/prettier/prettier">
<img src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square" alt="code style: prettier">
</a>
<a href="https://join.slack.com/t/merlinncommunity/signup">
<img src="https://img.shields.io/badge/slack-merlinn-E01E5A.svg?logo=slack" alt="slack-logo" />
<a href="https://join.slack.com/t/vesppercommunity/signup">
<img src="https://img.shields.io/badge/slack-vespper-E01E5A.svg?logo=slack" alt="slack-logo" />
</a>
</div>

Expand All @@ -49,11 +49,11 @@ Most people don't like to do on-call shifts. It requires engineers to be swift a
- [Getting started](#getting-started-)
- [Prerequisites](#prerequisites-)
- [Quick Installation](#quick-installation-)
- [Updating Merlinn](#updating-merlinn-️-)
- [Updating Merlinn](#updating-vespper-️-)
- [Deployment](#deployment-)
- [Visualize Knowledge Base](#visualize-knowledge-base-)
- [Support and feedback](#support-and-feedback-️)
- [Contributing to Merlinn](#contributing-to-merlinn-️)
- [Contributing to Merlinn](#contributing-to-vespper-️)
- [Troubleshooting](#troubleshooting-️)
- [Telemetry](#telemetry-)
- [License](#license-)
Expand Down Expand Up @@ -91,7 +91,7 @@ You can find the installation video [here](https://www.loom.com/share/1f562cb067
1. Clone the repository:

```bash
git clone git@github.com:merlinn-co/merlinn.git && cd merlinn
git clone git@github.com:vespper/vespper.git && cd vespper
```

2. Configure LiteLLM Proxy Server:
Expand Down Expand Up @@ -121,7 +121,7 @@ You can find the installation video [here](https://www.loom.com/share/1f562cb067
5. Update these variables:
- `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.
- `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.
- (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`.

Expand All @@ -133,25 +133,25 @@ You can find the installation video [here](https://www.loom.com/share/1f562cb067
That's it. You should be able to visit Merlinn's dashboard in http://localhost:5173.
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-️).

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 💫
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 💫

#### Using DockerHub images

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.
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.

In order to do that, follow these steps:

1. Download configuration files:

```bash
curl https://raw.githubusercontent.com/merlinn-co/merlinn/main/tools/scripts/download_env_files.sh | sh
curl https://raw.githubusercontent.com/vespper/vespper/main/tools/scripts/download_env_files.sh | sh
```

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`.
3. Spin up the environment using docker compose:
```bash
curl https://raw.githubusercontent.com/merlinn-co/merlinn/main/tools/scripts/start.sh | sh
curl https://raw.githubusercontent.com/vespper/vespper/main/tools/scripts/start.sh | sh
```
That's it 💫 You should be able to visit Merlinn's dashboard in http://localhost:5173.
Expand All @@ -172,7 +172,7 @@ That's it 💫 You should be able to visit Merlinn's dashboard in http://localho
### Deployment ☁️
Visit our [example guides](https://github.com/merlinn-co/merlinn/tree/main/examples) in order to deploy Merlinn to your cloud.
Visit our [example guides](https://github.com/vespper/vespper/tree/main/examples) in order to deploy Merlinn to your cloud.
### Visualize Knowledge Base 🗺️
Expand All @@ -193,16 +193,16 @@ To learn how to use VectorAdmin, visit the [docs](https://github.com/Mintplex-La
In order of preference the best way to communicate with us:
- **GitHub Discussions**: Contribute ideas, support requests and report bugs (preferred as there is a static & permanent for other community members).
- **Slack**: community support. Click [here](https://merlinn.co/#community) to join.
- **Privately**: contact at support@merlinn.co
- **Slack**: community support. Click [here](https://vespper.com/#community) to join.
- **Privately**: contact at support@vespper.com
## Contributing to Merlinn ⛑️
If you're interested in contributing to Merlinn, checkout our [`CONTRIBUTING.md`](https://github.com/merlinn-co/merlinn/blob/main/CONTRIBUTING.md) file 💫 🧙‍♂️
If you're interested in contributing to Merlinn, checkout our [`CONTRIBUTING.md`](https://github.com/vespper/vespper/blob/main/CONTRIBUTING.md) file 💫 🧙‍♂️

## Troubleshooting ⚒️

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.
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.

Moreover, feel free to reach out to us at our [support channels](#support-and-feedback-️).

Expand All @@ -215,17 +215,17 @@ This allows us to:
- Understand how Merlinn is used so we can improve it.
- Track overall usage for internal purposes and external reporting, such as for fundraising.

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).
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).

If you prefer not to participate, you can easily opt-out by setting `TELEMETRY_ENABLED=false` inside your `.env`.

## License 📃

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
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

## Learn more 🔍

Check out the official website at https://merlinn.co for more information.
Check out the official website at https://vespper.com for more information.

## Contributors ✨

Expand Down
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
We strongly recommend using the latest version of Merlinn to receive all security updates.

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.
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.
4 changes: 2 additions & 2 deletions TROUBLESHOOTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Troubleshooting Merlinn

In this document, you can find common scenarios where we're currently have problems. If you're interested in some of these
issues and want to help, feel free to create an [issue](https://github.com/merlinn-co/merlinn/issues).
issues and want to help, feel free to create an [issue](https://github.com/vespper/vespper/issues).

### `service "X" can't be used with extends as it declare depends_on`

Expand All @@ -18,7 +18,7 @@ Once your `.env` is updated, restart your containers using `docker compose up -d

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".

More information can be found in the [Slack guide](https://github.com/merlinn-co/merlinn/tree/main/config/slack).
More information can be found in the [Slack guide](https://github.com/vespper/vespper/tree/main/config/slack).

### `An API error occured: invalid_auth`

Expand Down
2 changes: 1 addition & 1 deletion config/litellm/config.example.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
### LLM Setup file ####
#########################

# In order to use merlinn, you need to provide 2 models: chat model and an embedding model. Our Opensource version supports OpenAI's models.
# In order to use vespper, you need to provide 2 models: chat model and an embedding model. Our Opensource version supports OpenAI's models.
# You must keep the naming convention of the model_list as it is. Namely, model_name: chat-model and model_name: embedding-model

model_list:
Expand Down
12 changes: 6 additions & 6 deletions config/slack/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,29 +33,29 @@ Once the app is installed, continue to the next section where you'll extract som
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.

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`.
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`.
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`.
3. In the "OAuth & Permissions", copy the “Bot User OAuth Token” and put it in the main `.env` as `SLACK_BOT_TOKEN`.
4. Go to "App Home" and enable "Messages Tab" and "Allow users to send Slash commands and messages from the messages tab".

### **(Optional)** Customize the Slack app

1. You can change the name and background color of the Slackbot in the Slack app settings.
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).
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).

### Test the Slack app

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").
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").

After you launch it, follow these steps to test the Slack app:

1. Go to your Slack workspace and go to Merlinn's direct messages.
2. Write `/merlinn help` in the message bar.
2. Write `/vespper help` in the message bar.

Now you should see the help message of the bot! 🥳
This means the basic functionality works.

## Next Steps

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).
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).

Also, you can visit our [docs](https://docs.merlinn.co/) for more information.
Also, you can visit our [docs](https://docs.vespper.com/) for more information.
2 changes: 1 addition & 1 deletion config/slack/manifest.self-hosted.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ features:
display_name: Merlinn
always_online: false
slash_commands:
- command: /merlinn
- command: /vespper
description: Manage Merlinn
should_escape: false
oauth_config:
Expand Down
10 changes: 5 additions & 5 deletions docker-compose.images.yml
Original file line number Diff line number Diff line change
Expand Up @@ -49,24 +49,24 @@ services:
extends:
file: docker-compose.common.yml
service: api-common
image: merlinnco/api:latest
image: vespper/api:latest
slackbot:
extends:
file: docker-compose.common.yml
service: slackbot-common
image: merlinnco/slackbot:latest
image: vespper/slackbot:latest
data-processor:
extends:
file: docker-compose.common.yml
service: data-processor-common
image: merlinnco/data-processor:latest
image: vespper/data-processor:latest
log-parser:
extends:
file: docker-compose.common.yml
service: log-parser-common
image: merlinnco/log-parser:latest
image: vespper/log-parser:latest
dashboard:
extends:
file: docker-compose.common.yml
service: dashboard-common
image: merlinnco/dashboard:latest
image: vespper/dashboard:latest
2 changes: 1 addition & 1 deletion examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ In this directory, you can find several examples on how to work with Merlinn.

| Section | Description |
| :---------------------------------------------------------------------------------- | :---------------------------------------: |
| [Deployments](https://github.com/merlinn-co/merlinn/tree/main/examples/deployments) | Learn how to deploy Merlinn to your cloud |
| [Deployments](https://github.com/vespper/vespper/tree/main/examples/deployments) | Learn how to deploy Merlinn to your cloud |
Loading

0 comments on commit 63d5184

Please sign in to comment.