FlyingFish
FlyingFish on GitHub
  • FlyingFish
    • About the project
    • Screenshots
    • Installation
      • Quick Setup
      • Quick Update
      • Create Backup
      • Long setup
        • Env
        • Docker compose
          • Ports
          • Network
      • Storage management
      • FAQ
    • Configurations
      • Which user type am I
      • Listen
        • Port forwarding
        • Proxy protocol
        • IP Access
        • Gateway identifiers
        • UPnP Nat
      • Domains
        • DynDns Clients
        • Own DNS Server
        • Discussions Subdomains
        • DynDns Server
      • Routes
    • Examples
      • SSH hidden on HTTPS
      • FlyingFish to other reverse proxy
      • Backup Server, SSH to Nas
      • Own DynDNS Server - Fritzbox
      • Inventree - Route
    • Developer
      • Ideas, requests and bugs
      • Project structure
        • Under the hood
        • Service structure
        • Schema
        • Object name rules
      • Image build
      • Plugins
    • Contribution
Powered by GitBook
On this page
  • Introduction
  • Setup
Edit on GitHub
  1. FlyingFish
  2. Developer

Plugins

Plugins can be loaded to services.

PreviousImage buildNextContribution

Last updated 1 year ago

Since version v1.0.24 we already support plugins in selected areas.

Introduction

The plugins for FlyingFish are intended to expand functionality and create connections to third-party services. The function can be expanded by anyone. Since this is a critical service structure, a plugin cannot simply be loaded (e.g. from the front end). Installation only takes place in the backend (if desired by hand). If the plugin code is disclosed, and we work together (in consultation with me), the plugin can also be included as a standard in the FlyingFish Docker image (write me an in GitHub/).

Examples of plugins:

Name
Description

A demo plugin that shows what the implementation interfaces look like.

The creation for the certificates has been removed from core and moved to the plugin. There may be more providers later. This is a standard plugin included in the Docker image.

Setup

To install a plugin, enter the corresponding FlyingFish container, for example 'flyingfish_service'.

docker exec -it flyingfish_service /bin/bash

Now go to the backend folder where the plugin should be installed.

cd /opt/flyingfish/backend

You can now install the plugin there using npm.

npm install git+https://github.com/PluginUrl/Plugin.git

Now drop the container and restart the Docker container.

exit
docker restart flyingfish_service

If there is an update, you will have to reinstall the plugins. If the plugins are important, it is recommended to create a new image with the expansion of the plugin installation.

Issue
Discussions
Demo
Lets Encrypt