Skip to content

Commit 3fa8a1e

Browse files
committed
Update docs
1 parent 064dd60 commit 3fa8a1e

File tree

1 file changed

+24
-7
lines changed

1 file changed

+24
-7
lines changed

web/docs/getting-started/intro.md

Lines changed: 24 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,33 @@ Check out our Cloud offering at [Promptly](https://trypromptly.com) or follow th
1111

1212
## Prerequisites
1313

14-
- [Docker](https://docs.docker.com/engine/install/)
15-
- [Git](https://git-scm.com/downloads) (optional)
14+
- [Python](https://www.python.org/downloads/) (version 3.8 or above)
1615

1716
## Quickstart
1817

19-
Download the latest release from LLMStack's [releases page](https://github.com/trypromptly/LLMStack/releases) and extract it. Navigate to the extracted directory and create your `.env` file and update `SECRET_KEY`, `CIPHER_SALT` and `DATABASE_PASSWORD`:
18+
You can install LLMStack locally using the following command:
19+
20+
```
21+
pip install llmstack
22+
```
23+
24+
:::info
25+
LLMStack comes with a default admin account whose credentials are `admin` and `promptly`. _Be sure to change the password from admin panel after logging in_.
26+
:::
27+
28+
Once installed, you can start LLMStack using the following command:
29+
30+
```
31+
llmstack
32+
```
33+
34+
LLMStack should automatically open your browser and point it to login page on [http://localhost:3000](http://localhost:3000). You can also alternatively open [http://localhost:3000](http://localhost:3000) to login into the platform.
35+
36+
LLMStack creates a config file in your home directory at `~/.llmstack/config` to store the configuration. You can change the port and other settings from this file. Refer to the [configuration](config.md) section for more information.
37+
38+
### Docker
39+
40+
You can also run LLMStack in docker. Download the latest release from LLMStack's [releases page](https://github.com/trypromptly/LLMStack/releases) and extract it. Navigate to the extracted directory and create your `.env` file and update `SECRET_KEY`, `CIPHER_SALT` and `DATABASE_PASSWORD`:
2041

2142
```
2243
cp .env.prod .env
@@ -32,10 +53,6 @@ Run LLMStack using the following command:
3253
3354
Once LLMStack is up and ready, it should automatically open your browser and point it to login page on [http://localhost:3000](http://localhost:3000). You can also alternatively use `docker compose up --pull always` to manually start the containers and open [http://localhost:3000](http://localhost:3000) to login into the platform. Make sure to wait for the API server to be ready before trying to load LLMStack.
3455

35-
:::info
36-
LLMStack comes with a default admin account whose credentials are `admin` and `promptly`. _Be sure to change the password from admin panel after logging in_.
37-
:::
38-
3956
<ReactPlayer
4057
playing
4158
controls

0 commit comments

Comments
 (0)