Commit
·
278bd24
1
Parent(s):
fce8999
docs: simplified setup
Browse filesRemoved the section about environment variables. In docker removed the production build. Both of these can still be found in the docs.
README.md
CHANGED
@@ -95,34 +95,6 @@ Clone the repository using Git:
|
|
95 |
git clone -b stable https://github.com/stackblitz-labs/bolt.diy
|
96 |
```
|
97 |
|
98 |
-
### (Optional) Configure Environment Variables
|
99 |
-
|
100 |
-
Most environment variables can be configured directly through the settings menu of the application. However, if you need to manually configure them:
|
101 |
-
|
102 |
-
1. Rename `.env.example` to `.env.local`.
|
103 |
-
2. Add your LLM API keys. For example:
|
104 |
-
|
105 |
-
```env
|
106 |
-
GROQ_API_KEY=YOUR_GROQ_API_KEY
|
107 |
-
OPENAI_API_KEY=YOUR_OPENAI_API_KEY
|
108 |
-
ANTHROPIC_API_KEY=YOUR_ANTHROPIC_API_KEY
|
109 |
-
```
|
110 |
-
|
111 |
-
**Note**: Ollama does not require an API key as it runs locally.
|
112 |
-
|
113 |
-
3. Optionally, set additional configurations:
|
114 |
-
|
115 |
-
```env
|
116 |
-
# Debugging
|
117 |
-
VITE_LOG_LEVEL=debug
|
118 |
-
|
119 |
-
# Ollama settings (example: 8K context, localhost port 11434)
|
120 |
-
OLLAMA_API_BASE_URL=http://localhost:11434
|
121 |
-
DEFAULT_NUM_CTX=8192
|
122 |
-
```
|
123 |
-
|
124 |
-
**Important**: Do not commit your `.env.local` file to version control. This file is already included in `.gitignore`.
|
125 |
-
|
126 |
---
|
127 |
|
128 |
## Run the Application
|
@@ -155,27 +127,30 @@ DEFAULT_NUM_CTX=8192
|
|
155 |
|
156 |
Use the provided NPM scripts:
|
157 |
```bash
|
158 |
-
npm run dockerbuild
|
159 |
-
npm run dockerbuild:prod # Production build
|
160 |
```
|
161 |
|
162 |
Alternatively, use Docker commands directly:
|
163 |
```bash
|
164 |
-
docker build . --target bolt-ai-development
|
165 |
-
docker build . --target bolt-ai-production # Production build
|
166 |
```
|
167 |
|
168 |
2. **Run the Container**:
|
169 |
Use Docker Compose profiles to manage environments:
|
170 |
```bash
|
171 |
-
docker-compose --profile development up
|
172 |
-
docker-compose --profile production up # Production
|
173 |
```
|
174 |
|
175 |
- With the development profile, changes to your code will automatically reflect in the running container (hot reloading).
|
176 |
|
177 |
---
|
178 |
|
|
|
|
|
|
|
|
|
|
|
|
|
179 |
### Update Your Local Version to the Latest
|
180 |
|
181 |
To keep your local version of bolt.diy up to date with the latest changes, follow these steps for your operating system:
|
|
|
95 |
git clone -b stable https://github.com/stackblitz-labs/bolt.diy
|
96 |
```
|
97 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
98 |
---
|
99 |
|
100 |
## Run the Application
|
|
|
127 |
|
128 |
Use the provided NPM scripts:
|
129 |
```bash
|
130 |
+
npm run dockerbuild
|
|
|
131 |
```
|
132 |
|
133 |
Alternatively, use Docker commands directly:
|
134 |
```bash
|
135 |
+
docker build . --target bolt-ai-development
|
|
|
136 |
```
|
137 |
|
138 |
2. **Run the Container**:
|
139 |
Use Docker Compose profiles to manage environments:
|
140 |
```bash
|
141 |
+
docker-compose --profile development up
|
|
|
142 |
```
|
143 |
|
144 |
- With the development profile, changes to your code will automatically reflect in the running container (hot reloading).
|
145 |
|
146 |
---
|
147 |
|
148 |
+
### Entering API Keys
|
149 |
+
|
150 |
+
All of your API Keys can be configured directly in the application. Just selecte the provider you want from the dropdown and click the pencile icon to enter your API key.
|
151 |
+
|
152 |
+
---
|
153 |
+
|
154 |
### Update Your Local Version to the Latest
|
155 |
|
156 |
To keep your local version of bolt.diy up to date with the latest changes, follow these steps for your operating system:
|