Skip to content

Commit

Permalink
adding quickstart to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sanjay920 committed Feb 9, 2024
1 parent ba3b411 commit 29b49cb
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions docs/docs/quickstart.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
sidebar_position: 1
title: Quick Start Guide
---

This guide will help you quickly launch Rubra with default options. The [installation section](./category/installation) covers in greater detail how Rubra can be set up.


## Prerequisites
* M-series Mac or Linux with GPU
* 16 GB Ram
* 10 GB Disk Space
* [Docker](https://docs.docker.com/get-docker/) and `docker compose`

## Install Script

Rubra provides a 1-command installation script. Run the following:

```bash
curl -sfL https://raw.githubusercontent.com/acorn-io/rubra/main/quickstart.sh | sh -s -- start
```

Once the installation script is complete, the Rubra UI will be accessible at http://localhost:8501

Enjoy! Start chatting with the Welcome Assistant and ask it a question that requires a web browser. Learn more about how you can [use Rubra here](/category/using-rubra).

0 comments on commit 29b49cb

Please sign in to comment.