Plugin Server

Contents

• Using the Plugin Server
  • Endpoints and Routes
  • Features
  • Principle of Operation
• Configuration
  • Sections and Values
  • Required Sections and key,value Pairs
  • Serving Static Files
  • Example INI file
• Plugins
  • Plugin Naming
  • BasePlugin
  • Plugin Examples
• File Serving
  • Files and Content
  • Path Resuolution
  • Error Handling
  • Plugin Configuraiton
• Authentication
  • Configuring Authentication
  • Authentication Methods for Clients
• CORS Configuration
  • Summary of CORS
  • CORS within Plugin Server
• SSL Configuration
  • Why use a properly signed certificate?
  • Why not use self-signed cerficates?
  • Pitfalls With self-signed certificates.
• Sessions
  • Sessman API
  • Configuration
  • Example Javascript Session Class

Plugin Server is a Python script and library to manage a REST-like API server utilizing a plugin system to handle requests to API routes. It is built upon Python async and aiohttp. These API routes get served as an endpoint, with proto://server.domain.tld:port/route.

Warning: This is alpha level code, some of the examples may not work. Please stand by!

Intended Audience

This document and code are intended for people familiar with Linux, System Administration and the Python programming language.

Installing Plugin Server

To install the stable version of this project, use PyPi with:

pip install pluginserver

To install the latest commits to Plugin Server, use the following command:

pip install git+https://github.com/nicciniamh/pluginserver.git

Or you can clone https://github.com/nicciniamh/pluginserver.git and install with pip install pluginserver

If you just want the example rsysinfo service, clone:

git clone https://github.com/nicciniamh/pluginserver_examples.git

This code has been tested under Debian 12 Bookworm and Pi OS Bookworm. Other than a unix-like system, there is no other system dependent code.