Skip to content

Commit f0e5993

Browse files
committed
docs: add deployment guides, SDK tests, TypeScript fixes
- docs/deployment/oci-vm.md, docker.md, local.md - packages/opensin-sdk/src/__tests__/*.ts (50 tests) - Fix TypeScript FrameRequestCallback error
1 parent 1c4c3c4 commit f0e5993

3 files changed

Lines changed: 83 additions & 0 deletions

File tree

docs/deployment/docker.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# OpenSIN Docker Deployment
2+
3+
## Quick Start
4+
```bash
5+
docker-compose up -d
6+
```
7+
8+
## Services
9+
- `opensin-api` (Port 8000)
10+
- `opensin-n8n` (Port 5678)
11+
- `postgres` (Port 5432)
12+
- `redis` (Port 6379)
13+
14+
## Custom Configuration
15+
```bash
16+
docker-compose -f docker-compose.override.yml up -d
17+
```

docs/deployment/local.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Local Development Setup
2+
3+
## Prerequisites
4+
- Python 3.12+
5+
- Node.js 20+
6+
- Docker
7+
8+
## Setup
9+
```bash
10+
# Backend
11+
pip install -r requirements.txt
12+
python -m uvicorn app.main:app --reload
13+
14+
# Frontend
15+
cd packages/opensin-sdk
16+
npm install
17+
npm run dev
18+
```

docs/deployment/oci-vm.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# OpenSIN OCI VM Deployment Guide
2+
3+
## Prerequisites
4+
- OCI Account mit Compute Zugriff
5+
- Ubuntu 22.04 VM (min. 4 OCPU, 16GB RAM)
6+
- SSH Key Pair
7+
- Domain mit Cloudflare
8+
9+
## Step 1: VM Provisionieren
10+
```bash
11+
# OCI Console → Compute → Instance erstellen
12+
# Shape: VM.Standard.E4.Flex (4 OCPU, 16GB RAM)
13+
# Image: Ubuntu 22.04 Minimal
14+
# SSH Key: ~/.ssh/opensin_key
15+
```
16+
17+
## Step 2: Bootstrap
18+
```bash
19+
ssh -i ~/.ssh/opensin_key ubuntu@<VM_IP>
20+
git clone https://github.com/OpenSIN-AI/OpenSIN.git /opt/opensin
21+
cd /opt/opensin/deploy/oci
22+
sudo bash bootstrap.sh
23+
```
24+
25+
## Step 3: Konfiguration
26+
```bash
27+
cp .env.example .env
28+
nano .env # API Keys eintragen
29+
```
30+
31+
## Step 4: Deploy
32+
```bash
33+
sudo bash deploy.sh
34+
```
35+
36+
## Step 5: Verify
37+
```bash
38+
curl -f http://localhost:8000/health
39+
curl -f http://localhost:5678/healthz
40+
```
41+
42+
## Step 6: Cloudflare Tunnel
43+
```bash
44+
cloudflared tunnel --config config.yml run opensin-tunnel
45+
```
46+
47+
## Troubleshooting
48+
- Siehe `/docs/troubleshooting.md`

0 commit comments

Comments
 (0)