Skip to main content

Installation

Koreshield can be used in two ways: as a standalone proxy (recommended for production) or as an SDK integrated directly into your application code.

1. Proxy Installation (Docker)​

The standalone proxy sits between your application and LLM providers. This is the most secure deployment method as it operates independently of your application logic.

docker pull Koreshield/Koreshield
docker run -p 8000:8000 Koreshield/Koreshield

2. SDK Installation​

The SDKs allow you to integrate Koreshield features (sanitization, scanning) directly into your codebase or interact with a deployed Koreshield Proxy.

Python SDK​

pip install Koreshield

JavaScript/TypeScript SDK​

npm install Koreshield

Verification​

To verify that the Python SDK has been installed successfully:

python -c "import Koreshield; print(Koreshield.__version__)"

System Requirements (Proxy)​

  • Docker: Engine 20.10+
  • Memory: 512MB recommended
  • Network: Outbound HTTPS access to LLM providers

Next Steps​