chore: update README.md content
Browse files
README.md
CHANGED
|
@@ -47,36 +47,14 @@ cd docsifer
|
|
| 47 |
```
|
| 48 |
|
| 49 |
### 2. Build and Run with Docker
|
| 50 |
-
|
| 51 |
Make sure Docker is installed and running on your machine.
|
| 52 |
-
|
| 53 |
```bash
|
| 54 |
-
docker build -t
|
| 55 |
-
docker run -p 7860:7860
|
| 56 |
```
|
| 57 |
|
| 58 |
The API will now be accessible at `http://localhost:7860`.
|
| 59 |
|
| 60 |
-
### 3. Environment Variables
|
| 61 |
-
|
| 62 |
-
Set the following environment variables as needed:
|
| 63 |
-
|
| 64 |
-
- `OPENAI_API_KEY`: Your OpenAI API key (optional, for LLM-enhanced features).
|
| 65 |
-
- `OPENAI_BASE_URL`: Custom base endpoint for OpenAI-compatible services (optional).
|
| 66 |
-
- `REDIS_URL`: Upstash Redis URL (default: `redis://localhost:6379/0`).
|
| 67 |
-
- `REDIS_TOKEN`: Upstash Redis token (default: `***`).
|
| 68 |
-
|
| 69 |
-
You can set these in a `.env` file or pass them directly when running the Docker container:
|
| 70 |
-
|
| 71 |
-
```bash
|
| 72 |
-
docker run -p 7860:7860 \
|
| 73 |
-
-e OPENAI_API_KEY=sk-xxxxx \
|
| 74 |
-
-e OPENAI_BASE_URL=https://api.openai.com/v1 \
|
| 75 |
-
-e REDIS_URL=redis://your-upstash-url \
|
| 76 |
-
-e REDIS_TOKEN=your-upstash-token \
|
| 77 |
-
docsifer
|
| 78 |
-
```
|
| 79 |
-
|
| 80 |
## π API Overview
|
| 81 |
|
| 82 |
### Endpoints
|
|
@@ -119,7 +97,7 @@ docker run -p 7860:7860 \
|
|
| 119 |
|
| 120 |
## π₯ Contributors
|
| 121 |
|
| 122 |
-
- **lamhieu / lh0x00** β Creator and Maintainer ([GitHub](https://github.com/lh0x00))
|
| 123 |
|
| 124 |
Contributions are welcome! Check out the [contribution guidelines](https://github.com/lh0x00/docsifer/blob/main/CONTRIBUTING.md).
|
| 125 |
|
|
|
|
| 47 |
```
|
| 48 |
|
| 49 |
### 2. Build and Run with Docker
|
|
|
|
| 50 |
Make sure Docker is installed and running on your machine.
|
|
|
|
| 51 |
```bash
|
| 52 |
+
docker build -t lightweight-embeddings .
|
| 53 |
+
docker run -p 7860:7860 lightweight-embeddings
|
| 54 |
```
|
| 55 |
|
| 56 |
The API will now be accessible at `http://localhost:7860`.
|
| 57 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 58 |
## π API Overview
|
| 59 |
|
| 60 |
### Endpoints
|
|
|
|
| 97 |
|
| 98 |
## π₯ Contributors
|
| 99 |
|
| 100 |
+
- **lamhieu / lh0x00** β Creator and Maintainer ([GitHub](https://github.com/lh0x00), [HuggingFace](https://huggingface.co/lamhieu))
|
| 101 |
|
| 102 |
Contributions are welcome! Check out the [contribution guidelines](https://github.com/lh0x00/docsifer/blob/main/CONTRIBUTING.md).
|
| 103 |
|