Skip to content

Commit 8b8dbc3

Browse files
author
sun
committed
chore(docs): update api startup commands to uvicorn and remove outdated files
1 parent 1dd158d commit 8b8dbc3

5 files changed

Lines changed: 22 additions & 15 deletions

File tree

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,9 @@ Compileo implements an **"Auto-Lock"** security model designed for zero-config s
8888
1. **GUI (Recommended)**: Launch Compileo, go to **Settings > 🔗 API Configuration**, enter one or more **API Keys**, and click **Save**. The system locks instantly.
8989
2. **CLI**: Start the API with the `--api-key` flag:
9090
```bash
91-
python -m src.compileo.api.main --api-key your_secret_key
91+
uvicorn src.compileo.api.main:app --host 0.0.0.0 --port 8000
9292
```
93+
*Note: Set API keys via GUI Settings after startup.*
9394
3. **Environment**: Define `COMPILEO_API_KEY=your_secret_key` in your `.env` or Docker configuration.
9495

9596
#### **How to Connect to a Secured Instance:**
@@ -117,13 +118,13 @@ Ideal for local development, CLI automation, or custom integrations.
117118
```
118119
3. **Start Services**:
119120
```bash
120-
# 1. Start the API server (Optionally secure it with --api-key)
121-
python -m src.compileo.api.main --api-key my_secret_token
122-
121+
# 1. Start the API server
122+
uvicorn src.compileo.api.main:app --host 0.0.0.0 --port 8000
123+
123124
# 2. Start the Web GUI (In a new terminal)
124-
streamlit run src/compileo/features/gui/main.py
125+
streamlit run src/compileo/features/gui/main.py --server.port 8501 --server.address 0.0.0.0
125126
```
126-
*Note: If you secured the API in step 1, you must enter the same key in the GUI Settings to connect.*
127+
*Note: For API security, set API keys via the GUI Settings after startup.*
127128

128129
---
129130

docs/index.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -114,13 +114,18 @@ Ideal for local development, CLI automation, or custom integrations.
114114
```
115115
3. **Start Services**:
116116
```bash
117-
# 1. Start the API server (Optionally secure it with --api-key)
118-
python -m src.compileo.api.main --api-key my_secret_token
119-
120-
# 2. Start the Web GUI (In a new terminal)
121-
streamlit run src/compileo/features/gui/main.py
117+
# Option A: Start services separately (recommended for production)
118+
# 1. Start the API server (in one terminal)
119+
uvicorn src.compileo.api.main:app --host 0.0.0.0 --port 8000
120+
121+
# 2. Start the Web GUI (in another terminal)
122+
streamlit run src/compileo/features/gui/main.py --server.port 8501 --server.address 0.0.0.0
123+
124+
# Option B: Start both in same terminal (API in background)
125+
uvicorn src.compileo.api.main:app --host 0.0.0.0 --port 8000 &
126+
streamlit run src/compileo/features/gui/main.py --server.port 8501 --server.address 0.0.0.0
122127
```
123-
*Note: If you secured the API in step 1, you must enter the same key in the GUI Settings to connect.*
128+
*Note: For API security, set API keys via the GUI Settings after startup.*
124129

125130
---
126131

docs/userGuide/api_authentication.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,9 @@ Compileo uses an "Auto-Lock" security model for maximum user-friendliness:
3636
### 2. Via CLI
3737
You can pass a static API key when starting the backend server:
3838
```bash
39-
python -m src.compileo.api.main --api-key your_secret_key
39+
uvicorn src.compileo.api.main:app --host 0.0.0.0 --port 8000
4040
```
41+
*Note: Set API keys via GUI Settings after startup.*
4142

4243
### 3. Via Environment Variables
4344
Set these in your shell, `.env` file, or Docker configuration:

docs/userGuide/gui_user_guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The Compileo GUI provides a user-friendly web interface for document processing,
77
## Getting Started
88

99
### Prerequisites
10-
- Running Compileo API server (`python -m src.compileo.api.main`)
10+
- Running Compileo API server (`uvicorn src.compileo.api.main:app --host 0.0.0.0 --port 8000`)
1111
- API keys configured for AI services (Gemini, Grok, etc.)
1212
- At least one project created
1313

src/compileo/features/jobhandle/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ pip install redis rq rq-scheduler psutil
200200
docker run -d -p 6379:6379 redis:alpine
201201

202202
# Run development server
203-
python -m src.compileo.api.main
203+
uvicorn src.compileo.api.main:app --host 0.0.0.0 --port 8000 --reload
204204
```
205205

206206
### Production Deployment

0 commit comments

Comments
 (0)