Ollama Proxy Service

🚨 Secure Your Data with Ease!

This repository showcases how to protect your Ollama instance using Flask, Flask-Limiter, and Flask-Cors. With this setup, you can ensure robust API key security and safeguard your valuable data.

Features

🔑 API Key Protection with Flask: Ensure only authorized access by requiring a valid API key for each request.
🚦 Rate Limiting with Flask-Limiter: Prevent abuse and ensure fair usage by limiting the number of API requests from a user within a specific time frame.
🌍 Cross-Origin Resource Sharing (CORS) with Flask-Cors: Enable your API to be called safely from different domains, facilitating modern web application interactions.
📊 Systematic Logging: Capture detailed operational data for debugging, monitoring, and security analysis.
🔄 Systemd Integration for Service Management: Manage your API service effectively with capabilities like automatic restarts and dependency management.
🔒 Environment and Dependency Isolation with Virtual Environments: Run your application within a controlled environment to prevent conflicts and ensure consistency.
⚙️ Automated Setup and Deployment Scripts: Simplify the setup process and manage your application more efficiently with automation scripts.
🛡️ Secure Configuration Management: Protect sensitive configuration settings from exposure and manage them securely.

Overview
Installation
Usage
API Documentation
Troubleshooting

Overview

This is a lightweight proxy service that protects Ollama with an API key. It uses Flask as the web framework, Flask-Limiter for rate limiting, and Flask-Cors for enabling cross-origin resource sharing.

Installation

To install this service, follow these steps:

Clone the repository:

git clone https://github.com/rzafiamy/ollama-proxy-service
cd ollama-proxy-service

Install the required dependencies:

For this, you can run your script once as below:

```bash
chmod +x run.sh
./run.sh
```

Set up the service using the setup script:
```
chmod +x setup.sh
./setup.sh install
```

This will create necessary user and group for the service, and configure the systemd service to manage the application.

Usage

Running the Service

To start the service and manage it through systemd, use:

sudo systemctl start ollama-proxy-service.service

For development or manual testing, you can run the service directly:

./run.sh

This will ensure the virtual environment is set up and start the Flask application on the default port 11433. Access it by visiting http://localhost:11433 in your browser.

API Key

To protect Ollama with an API key, set the API_KEY variable in the config.py file:

# config.py
API_KEY = "your_api_key_here"

Ensure that only requests with a valid API key can access Ollama.

Update ollama and keep environment

chmod +x ollama_update.sh
bash ollama_update.sh

API Documentation

API Endpoints

The proxy service supports all standard HTTP methods (GET, POST, PUT, DELETE) and has one endpoint / that proxies requests to the target URL (http://localhost:11434 by default).

API Keys

Include the Authorization header with a value of Bearer <API_KEY> in your request to authenticate. Valid API keys will proceed with the expected response, while invalid ones will result in a 401 Unauthorized error.

Troubleshooting

Error streaming response: Verify that the target URL is responding properly and that there are no network issues.
Invalid API key: Confirm that the API_KEY variable in config.py is set correctly.

Thanks

Special Thanks

This project wouldn't have been possible without the inspiration and guidance from @rzafiamy! His expertise and kindness made a huge difference, and I'm grateful for his contributions. 🙏💖

rzafiamy/ollama-proxy-service