Documentation

Developer Docs_

Pointers mirror the OSS package: declarative XML, Java 11 workloads, Gradle modules, tarball layout, Servit authoring.

Documentation

Documentation Categories

Find the information you need to get started, integrate systems, and deploy production-ready solutions.

Getting Started
Quick start guides, installation instructions, and basic configuration examples.
  • Installation Guide
  • First Integration
  • Basic Configuration
  • Hello World Example
API Reference
Complete API documentation with endpoints, parameters, and response examples.
  • Configuration files overview
  • Resource & channel wiring
  • Route XML snippets
  • Error Codes & Handling
Configuration
Detailed configuration guides for all gateway components and features.
  • config/gateway-config.xml anatomy
  • routes/*/ descriptor layout
  • Filter pipelines in XML
  • JAVA_HOME, GATEWAY_HOME
Documentation Sections

Explore Documentation

Browse through our comprehensive documentation organized by topics and use cases.

Quick Start Guide

Unpack the distribution tarball, wire XML under config/, context/, and routes/, then start the JVM process per the user guide.

1
Installation
Install the JVM distribution tarball and link JAVA_HOME/GATEWAY_HOME
2
Configuration
Bootstrap config/gateway-config.xml and routes/*.xml shells
3
First Route
Validate an HTTP matcher against Servit mocks or stubs
4
Deploy
Deploy to production environment
# Quick start (distribution layout)
# 1. Requirements
Java 11+ (JDK or JRE)
# 2. Unpack release tarball
tar -xzf pocat-gateway-*.tar.gz
cd pocat-gateway-* && export GATEWAY_HOME=$(pwd)
# 3. Author XML config
vi config/gateway-config.xml
vi context/context.xml
vi routes/your-group/*.xml
# 4. Run gateway
$GATEWAY_HOME/bin/start.sh foreground
# 5. Tail logs
tail -f $GATEWAY_HOME/logs/gateway.out
Resources

Additional Resources

Explore additional resources including tutorials, community content, and developer tools.

CLI Documentation
Complete command-line interface reference with examples and usage patterns.
GitHub Repository
Access source code, examples, and contribute to the Pocat Gateway project.
SDK Documentation
Extend the JVM gateway with Java Serbit implementations; other language clients talk to exposed HTTP/MQTT endpoints.
Downloads
Download binaries, Docker images, and installation packages for all platforms.
Community Forum
Join the community, ask questions, and share your integration experiences.
Video Tutorials
Step-by-step video guides for common integration scenarios and advanced features.
Get Started

Ready to Build?

Start building with Pocat Gateway today using our comprehensive documentation and examples.