diff --git a/docs/docs/quickstart.md b/docs/docs/quickstart.md new file mode 100644 index 0000000..12bfbf4 --- /dev/null +++ b/docs/docs/quickstart.md @@ -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). \ No newline at end of file