APISIX Custom Plugin Downloader

This plugin allows to download other plugins from remote repositories, via HTTP/HTTPS.

See this comment to see how to set SSL certificates.

Table of Contents

• APISIX Custom Plugin Downloader
  • Table of Contents
  • Plugin Usage
    • Installation
    • Configuration
      • Attributes
    • Enable Plugin
      • Traditional
      • Standalone
    • Example Usage
  • Testing
    • CI
  • Examples
    • Standalone Example
  • Learn More

Plugin Usage

Installation

To install custom plugins in APISIX there are 2 methods:

• placing them alongside other built-in plugins, in ${APISIX_INSTALL_DIRECTORY}/apisix/plugins/ (by default /usr/local/apisix/apisix/plugins/);
• placing them in a custom directory and setting apisix.extra_lua_path to point that directory, in config.yaml.

The example below shows how to setup the plugin in a Standalone deployment, using the second method (extra_lua_path).

Configuration

You can configure this plugin for Routes or Global Rules.

Attributes

Name	Type	Required	Default	Valid values	Description

TODO

Enable Plugin

TODO

Traditional

TODO

Standalone

TODO

Example Usage

TODO

Back to TOC

Testing

CI

TODO

The ci.yml workflow runs the tests cases in the t/ folder and can be triggered by a workflow_dispatch event, from GitHub: Actions | CI.

Back to TOC

Examples

Folder examples/ contains a simple example that shows how to setup APISIX locally on Docker, and load the plugin(s).

For more examples, have a look at github.com/mikyll/apisix-examples.

Standalone Example

TODO

Back to TOC

Learn More

• APISIX Source Code
• APISIX Deployment Modes
• Developing custom APISIX plugins
• APISIX testing framework
• APISIX debug mode
• NGiNX variables
• APISIX Examples