Skip to content

Commit 591e0ca

Browse files
readme update
1 parent 9ed1328 commit 591e0ca

File tree

3 files changed

+33
-5
lines changed

3 files changed

+33
-5
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,34 @@ async def query_handler(data: WhiskQuerySchema) -> WhiskQueryBaseResponseSchema:
7878
)
7979
```
8080

81+
---
82+
## Self hosting the control plane
83+
84+
KitchenAI is designed to be self-hosted. You can deploy the control plane and the bento boxes separately.
85+
86+
87+
88+
1. Clone the KitchenAI repository
89+
```bash
90+
git clone https://github.com/epuerta9/kitchenai.git
91+
```
92+
93+
2. Bring up the control plane and dependencies
94+
```bash
95+
docker compose up -d
96+
```
97+
98+
4. Creating the Bucket for media. KitchenAI uses S3 for media. For local development, the compose file has a minio container. This only needs to be done the first time.
99+
100+
you will need to login to the minio container and create a bucket called `kitchenai`.
101+
102+
endpoint: http://localhost:9001
103+
username: minioadmin
104+
password: minioadmin
105+
106+
bucket name: kitchenai
107+
108+
3. Bring up the bento boxes using this demo [demo notebooks](https://github.com/epuerta9/kitchenai-demo)
81109
---
82110

83111
## 📚 Documentation

docker-compose.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@ services:
2828
SECURE_HSTS_PRELOAD: "True"
2929
SESSION_COOKIE_SECURE: "True"
3030
SERVER_EMAIL: "example@example.com"
31-
AWS_ACCESS_KEY_ID: ""
32-
AWS_SECRET_ACCESS_KEY: ""
33-
AWS_STORAGE_BUCKET_NAME: ""
34-
AWS_S3_ENDPOINT_URL: ""
31+
AWS_ACCESS_KEY_ID: "minioadmin"
32+
AWS_SECRET_ACCESS_KEY: "minioadmin"
33+
AWS_STORAGE_BUCKET_NAME: "kitchenai"
34+
AWS_S3_ENDPOINT_URL: "http://minio:9000"
3535
AWS_DEFAULT_REGION: "us-east-1"
3636
AWS_S3_ADDRESSING_STYLE: "path"
3737
AWS_S3_USE_SSL: "True"

kitchenai/__version__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
__version__ = "0.18.3"
1+
__version__ = "0.18.4"

0 commit comments

Comments
 (0)