Documentation

Developer Docs_

Declarative XML for a service, its deploy bindings, and the message bus. Servit classes ship in the service jar.

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
  • First channel binding
API Reference
Servit methods, message fields, and ErrorCode bases.
  • Configuration files overview
  • Resource & channel wiring
  • messagebus bindings
  • Error Codes & Handling
Configuration
service.xml, deploy bindings, and contexts/messagebus.
  • services/<service>/service.xml
  • config/services/<node>/deploy/*.xml
  • contexts/messagebus
  • bin/launch.sh and pocat-launcher.jar
Documentation Sections

Explore Documentation

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

Quick Start Guide

Lay out config/, contexts/messagebus/, and services/<service>/libs/, then start with bin/launch.sh.

1
Installation
Place config, contexts, and services next to bin/launch.sh
2
Configuration
service.xml, deploy.xml, and contexts/messagebus
3
First Route
Bind a messagebus URI to a channel
4
Deploy
Deploy to production environment
# Quick start (distribution layout)
# 1. Requirements
Java runtime for bin/launch.sh
# 2. Unpack release tarball
# deployment root
bin/launch.sh
# 3. Author XML config
vi services/<service>/service.xml
vi contexts/messagebus/connections/rabbit01.xml
vi config/services/<node>/deploy/<service>.xml
# 4. Run gateway
bin/launch.sh
# 5. Tail logs
# launcher: java -jar pocat-launcher.jar
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
Implement io.pocat.platform.service.Servit and package it under services/<service>/libs.
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 from the deployment root: service.xml, deploy bindings, and bin/launch.sh.