ocelot Installation Guide Installation Guide

ocelot is a free and open-source .NET API gateway. Ocelot provides .NET Core API gateway

Hardware Requirements:

CPU: 2+ cores

RAM: 2GB minimum

Storage: 1GB for config

Network: HTTP/HTTPS

Operating System:

Linux: Any modern distribution (RHEL, Debian, Ubuntu, CentOS, Fedora, Arch, Alpine, openSUSE)

macOS: 10.14+ (Mojave or newer)

Windows: Windows Server 2016+ or Windows 10

FreeBSD: 11.0+

Network Requirements:

Port 5000 (default ocelot port)

None

Dependencies:

See official documentation for specific requirements

System Access: root or sudo privileges required

This guide supports installation on:

RHEL 8/9 and derivatives (CentOS Stream, Rocky Linux, AlmaLinux)

Debian 11/12

Ubuntu 20.04/22.04/24.04 LTS

Arch Linux (rolling release)

Alpine Linux 3.18+

openSUSE Leap 15.5+ / Tumbleweed

SUSE Linux Enterprise Server (SLES) 15+

macOS 12+ (Monterey and later)

FreeBSD 13+

Windows 10/11/Server 2019+ (where applicable)

bash

# Install EPEL repository if needed
sudo dnf install -y epel-release

# Install ocelot
sudo dnf install -y ocelot

# Enable and start service
sudo systemctl enable --now ocelot

# Configure firewall
sudo firewall-cmd --permanent --add-port=5000/tcp
sudo firewall-cmd --reload

# Verify installation
ocelot --version

bash

# Update package index
sudo apt update

# Install ocelot
sudo apt install -y ocelot

# Enable and start service
sudo systemctl enable --now ocelot

# Configure firewall
sudo ufw allow 5000

# Verify installation
ocelot --version

bash

# Install ocelot
sudo pacman -S ocelot

# Enable and start service
sudo systemctl enable --now ocelot

# Verify installation
ocelot --version

bash

# Install ocelot
apk add --no-cache ocelot

# Enable and start service
rc-update add ocelot default
rc-service ocelot start

# Verify installation
ocelot --version

bash

# Install ocelot
sudo zypper install -y ocelot

# Enable and start service
sudo systemctl enable --now ocelot

# Configure firewall
sudo firewall-cmd --permanent --add-port=5000/tcp
sudo firewall-cmd --reload

# Verify installation
ocelot --version

bash

# Using Homebrew
brew install ocelot

# Start service
brew services start ocelot

# Verify installation
ocelot --version

bash

# Using pkg
pkg install ocelot

# Enable in rc.conf
echo 'ocelot_enable="YES"' >> /etc/rc.conf

# Start service
service ocelot start

# Verify installation
ocelot --version

bash

# Using Chocolatey
choco install ocelot

# Or using Scoop
scoop install ocelot

# Verify installation
ocelot --version

bash

# Create configuration directory
sudo mkdir -p /etc/ocelot

# Set up basic configuration
# See official documentation for detailed configuration options

# Test configuration
ocelot --version

bash

# Enable service
sudo systemctl enable ocelot

# Start service
sudo systemctl start ocelot

# Stop service
sudo systemctl stop ocelot

# Restart service
sudo systemctl restart ocelot

# Check status
sudo systemctl status ocelot

# View logs
sudo journalctl -u ocelot -f

bash

# Enable service
rc-update add ocelot default

# Start service
rc-service ocelot start

# Stop service
rc-service ocelot stop

# Restart service
rc-service ocelot restart

# Check status
rc-service ocelot status

bash

# Enable in /etc/rc.conf
echo 'ocelot_enable="YES"' >> /etc/rc.conf

# Start service
service ocelot start

# Stop service
service ocelot stop

# Restart service
service ocelot restart

# Check status
service ocelot status

bash

# Using Homebrew services
brew services start ocelot
brew services stop ocelot
brew services restart ocelot

# Check status
brew services list | grep ocelot

powershell

# Start service
net start ocelot

# Stop service
net stop ocelot

# Using PowerShell
Start-Service ocelot
Stop-Service ocelot
Restart-Service ocelot

# Check status
Get-Service ocelot

See the official documentation for advanced configuration options.

nginx

upstream ocelot_backend {
    server 127.0.0.1:5000;
}

server {
    listen 80;
    server_name ocelot.example.com;
    return 301 https://$server_name$request_uri;
}

server {
    listen 443 ssl http2;
    server_name ocelot.example.com;

    ssl_certificate /etc/ssl/certs/ocelot.example.com.crt;
    ssl_certificate_key /etc/ssl/private/ocelot.example.com.key;

    location / {
        proxy_pass http://ocelot_backend;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
    }
}

apache

<VirtualHost *:80>
    ServerName ocelot.example.com
    Redirect permanent / https://ocelot.example.com/
</VirtualHost>

<VirtualHost *:443>
    ServerName ocelot.example.com
    
    SSLEngine on
    SSLCertificateFile /etc/ssl/certs/ocelot.example.com.crt
    SSLCertificateKeyFile /etc/ssl/private/ocelot.example.com.key
    
    ProxyRequests Off
    ProxyPreserveHost On
    
    ProxyPass / http://127.0.0.1:5000/
    ProxyPassReverse / http://127.0.0.1:5000/
</VirtualHost>

haproxy

frontend ocelot_frontend
    bind *:80
    bind *:443 ssl crt /etc/ssl/certs/ocelot.pem
    redirect scheme https if !{ ssl_fc }
    default_backend ocelot_backend

backend ocelot_backend
    balance roundrobin
    server ocelot1 127.0.0.1:5000 check

bash

# Set appropriate permissions
sudo chown -R ocelot:ocelot /etc/ocelot
sudo chmod 750 /etc/ocelot

# Configure firewall
sudo firewall-cmd --permanent --add-port=5000/tcp
sudo firewall-cmd --reload

# Enable SELinux policies (if applicable)
sudo setsebool -P httpd_can_network_connect on

See official documentation for database configuration requirements.

bash

# Basic system tuning
echo 'net.core.somaxconn = 65535' | sudo tee -a /etc/sysctl.conf
echo 'net.ipv4.tcp_max_syn_backlog = 65535' | sudo tee -a /etc/sysctl.conf
sudo sysctl -p

bash

# Check service status
sudo systemctl status ocelot

# View logs
sudo journalctl -u ocelot -f

# Monitor resource usage
top -p $(pgrep ocelot)

bash

#!/bin/bash
# Basic backup script
BACKUP_DIR="/backup/ocelot"
DATE=$(date +%Y%m%d_%H%M%S)

mkdir -p "$BACKUP_DIR"
tar -czf "$BACKUP_DIR/ocelot-backup-$DATE.tar.gz" /etc/ocelot /var/lib/ocelot

echo "Backup completed: $BACKUP_DIR/ocelot-backup-$DATE.tar.gz"

bash

# Stop service
sudo systemctl stop ocelot

# Restore from backup
tar -xzf /backup/ocelot/ocelot-backup-*.tar.gz -C /

# Start service
sudo systemctl start ocelot

1. Service won't start:

bash

# Check logs
sudo journalctl -u ocelot -n 100
sudo tail -f /var/log/ocelot/ocelot.log

# Check configuration
ocelot --version

# Check permissions
ls -la /etc/ocelot

2. Connection issues:

bash

# Check if service is listening
sudo ss -tlnp | grep 5000

# Test connectivity
telnet localhost 5000

# Check firewall
sudo firewall-cmd --list-all

3. Performance issues:

bash

# Check resource usage
top -p $(pgrep ocelot)

# Check disk I/O
iotop -p $(pgrep ocelot)

# Check connections
ss -an | grep 5000

yaml

version: '3.8'
services:
  ocelot:
    image: ocelot:latest
    ports:
      - "5000:5000"
    volumes:
      - ./config:/etc/ocelot
      - ./data:/var/lib/ocelot
    restart: unless-stopped

Maintenance

bash

# RHEL/CentOS/Rocky/AlmaLinux
sudo dnf update ocelot

# Debian/Ubuntu
sudo apt update && sudo apt upgrade ocelot

# Arch Linux
sudo pacman -Syu ocelot

# Alpine Linux
apk update && apk upgrade ocelot

# openSUSE
sudo zypper update ocelot

# FreeBSD
pkg update && pkg upgrade ocelot

# Always backup before updates
tar -czf /backup/ocelot-pre-update-$(date +%Y%m%d).tar.gz /etc/ocelot

# Restart after updates
sudo systemctl restart ocelot

Regular Maintenance

bash

# Log rotation
sudo logrotate -f /etc/logrotate.d/ocelot

# Clean old logs
find /var/log/ocelot -name "*.log" -mtime +30 -delete

# Check disk usage
du -sh /var/lib/ocelot

Official Documentation: https://docs.ocelot.org/

GitHub Repository: https://github.com/ocelot/ocelot

Community Forum: https://forum.ocelot.org/

Best Practices Guide: https://docs.ocelot.org/best-practices

---

Note: This guide is part of the HowToMgr collection. Always refer to official documentation for the most up-to-date information.

1. Prerequisites

2. Supported Operating Systems

3. Installation

RHEL/CentOS/Rocky Linux/AlmaLinux

Debian/Ubuntu

Arch Linux

Alpine Linux

openSUSE/SLES

macOS

FreeBSD

Windows

Initial Configuration

Basic Configuration

5. Service Management

systemd (RHEL, Debian, Ubuntu, Arch, openSUSE)

OpenRC (Alpine Linux)

rc.d (FreeBSD)

launchd (macOS)

Windows Service Manager

Advanced Configuration

Reverse Proxy Setup

nginx Configuration

Apache Configuration

HAProxy Configuration

Security Configuration

Basic Security Setup

Database Setup

Performance Optimization

System Tuning

Monitoring

Basic Monitoring

9. Backup and Restore

Backup Script

Restore Procedure

6. Troubleshooting

Common Issues

Integration Examples

Docker Compose Example

Maintenance

Update Procedures

Regular Maintenance

Additional Resources

Related Api gateways Guides

fusio Installation Guide

gloo Installation Guide

gravitee Installation Guide