mirror of
https://github.com/tobychui/zoraxy.git
synced 2025-11-04 07:54:12 +01:00
ddb1a8773e
- Added restful-api example plugin - Added more plugin docs - Added zoraxy_plugin HandleFunc API
19 lines
844 B
Plaintext
19 lines
844 B
Plaintext
# Zoraxy Plugin
|
|
|
|
## Overview
|
|
This module serves as a template for building your own plugins for the Zoraxy Reverse Proxy. By copying this module to your plugin mod folder, you can create a new plugin with the necessary structure and components.
|
|
|
|
## Instructions
|
|
|
|
1. **Copy the Module:**
|
|
- Copy the entire `zoraxy_plugin` module to your plugin mod folder.
|
|
|
|
2. **Include the Structure:**
|
|
- Ensure that you maintain the directory structure and file organization as provided in this module.
|
|
|
|
3. **Modify as Needed:**
|
|
- Customize the copied module to implement the desired functionality for your plugin.
|
|
|
|
## Directory Structure
|
|
zoraxy_plugin: Handle -introspect and -configuration process required for plugin loading and startup
|
|
embed_webserver: Handle embeded web server routing and injecting csrf token to your plugin served UI pages |