uwap.ServerPlugin 2.0.0.1

There is a newer version of this package available.
See the version list below for details.
dotnet add package uwap.ServerPlugin --version 2.0.0.1                
NuGet\Install-Package uwap.ServerPlugin -Version 2.0.0.1                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="uwap.ServerPlugin" Version="2.0.0.1" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add uwap.ServerPlugin --version 2.0.0.1                
#r "nuget: uwap.ServerPlugin, 2.0.0.1"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install uwap.ServerPlugin as a Cake Addin
#addin nuget:?package=uwap.ServerPlugin&version=2.0.0.1

// Install uwap.ServerPlugin as a Cake Tool
#tool nuget:?package=uwap.ServerPlugin&version=2.0.0.1                

ServerPlugin

Plugin for WebFramework that adds a simple interface to manage the program and server in general.

The functionality is mainly directed for Linux servers with WF programs that use Wrapper.

All fully logged in users with AccessLevel=ushort.MaxValue (administrators) will have access to this plugin, nobody else can access it.

Website: https://uwap.org/projects/server-plugin

Changelog: https://uwap.org/changes/server-plugin

Main features

  • Log viewing and clearing (requires Wrapper with LogFile=Wrapper.log)
  • SSH management (requires Linux structure for key management, and ufw for port whitelisting)
  • Interface to list, download and restore backups, API to automatically download backups
  • Updating the program and requesting version rollbacks (requires Wrapper, rollbacks require CreateBackup=true)
  • Restarting and exiting the program (requires Wrapper)
  • Reloading the Wrapper configuration (requires Wrapper, obviously)
  • Sending simple emails
  • Restarting the mail server (shouldn't really ever be necessary)
  • Calling the worker
  • Showing how much time is left before the worker runs again
  • Showing that the system needs to be rebooted after a system upgrade (requires Linux)

Installation

You can add this plugin to your WF project by installing the NuGet package: uwap.ServerPlugin

You can also download the source code and reference it in your project file.

Once installed, add the following things to your program start code:

  • Add <code>using uwap.WebFramework.Plugins;</code> to the top, otherwise you have to prepend it to <code>ServerPlugin</code>
  • Create a new object of the plugin: <code>ServerPlugin serverPlugin = new();</code>
  • Map the plugin to a path of your choosing (like any/server): <code>PluginManager.Map("any/server", serverPlugin);</code>

You can do all that with a single line of code before starting the WF server:<br/><code>PluginManager.Map("any/server", new uwap.WebFramework.Plugins.ServerPlugin());</code>

Plans for the future

  • Arranging the menu items in a nicer manner
  • Adding stuff to test WebFramework
  • Whitelisting/management for custom ports
  • Utilizing the sidebar, somehow
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.0.0.2 146 3/4/2024
2.0.0.1 116 3/4/2024
2.0.0 125 3/3/2024
1.4.4 168 11/19/2023
1.4.3.1 123 10/6/2023
1.4.3 140 9/25/2023
1.4.2.1 135 9/17/2023
1.4.2 154 9/15/2023