update README

Author: blndfsk

.github/workflows/release.yml

@@ -19,10 +19,11 @@ jobs:
     - name: Build
       run: make plugin
     - name: Release
-      uses: actions/upload-artifact@v4
+      uses: softprops/action-gh-release@v2
       with:
-        name: plugin
-        path: target/plugin/**
-        include-hidden-files: true
+        files: |
+          target/plugin/plugin.wasm
+          target/plugin/.traefik.yml
+          target/plugin/LICENSE
 
       

.traefik.yml

@@ -2,7 +2,7 @@ displayName: Demo Plugin Wasm Rust
 runtime: wasm
 type: middleware
 
-summary: '[Demo WASM]'
+summary: 'a starting point for a plugin written in rust'
 
 testData:
   rules:

README.md

@@ -1,5 +1,80 @@
 # plugin-wasm-rust-demo
 
-Demo Traefik plugin written in rust
+Demo Traefik plugin written in rust. Inspired by https://github.com/juliens/traefik-plugin-rust-demo
 
-https://http-wasm.io/http-handler-abi/
+## Examples
+set header and forward to the next middleware
+```rust
+    fn handle_request(&self, request: Request, _response: Response) -> (bool, i32) {
+        request.header().add("X-Foo".as_bytes(), "Bar".as_bytes());
+        (true, 0)
+    }
+```
+
+match uri and respond with error
+```rust
+    fn handle_request(&self, request: Request, response: Response) -> (bool, i32) {
+        match request.uri() {
+            Some(s) if s.starts_with("/.config".as_bytes()) => {
+                response.set_status_code(403);
+                return (false, 0);
+            }
+            _ => {}
+        }
+        (true, 0)
+    }
+```
+
+
+## Building
+
+if not already installed, add the wasm-target
+
+```shell
+rustup target add wasm32-wasip1
+```
+
+Build the plugin with
+
+```shell
+make
+```
+
+The artifacts are found in target/plugin/
+
+## Installation
+
+This Demo is not meant for installation, it is just a showcase. However, traefik supports a manual installation.
+
+```shell
+mkdir -p <traefik>/plugins-local/src/plugindemowasm/
+cp target/plugin/plugin.wasm <traefik>/plugins-local/src/plugindemowasm/
+
+```
+Configure the static configuration (and restart traefik)
+```yaml
+# Static configuration
+
+experimental:
+  localPlugins:
+    plugindemowasm:
+      moduleName: plugindemowasm
+```
+Call the middleware from one of your routers
+```yaml
+# Dynamic configuration
+
+http:
+  routers:
+    my-router:
+    [...]
+      middlewares:
+        - plugindemowasm-mw
+[...]
+  middlewares:
+    plugindemowasm-mw:
+      plugin:
+        plugindemowasm:
+          rules:
+            - ""
+```            

src/main.rs

@@ -1,5 +1,4 @@
 use http_wasm_guest::{
-    feature::{enable_feature, Feature},
     host::{get_config, Request, Response},
     info, register, Guest,
 };
@@ -13,8 +12,14 @@ struct Config {
 struct Plugin {}
 
 impl Guest for Plugin {
-    fn handle_request(&self, request: Request, _response: Response) -> (bool, i32) {
-        info!("uri: {}", to_str(request.uri().as_deref()));
+    fn handle_request(&self, request: Request, response: Response) -> (bool, i32) {
+        match request.uri() {
+            Some(s) if s.starts_with("/.config".as_bytes()) => {
+                response.set_status_code(403);
+                return (false, 0);
+            }
+            _ => {}
+        }
         (true, 0)
     }
 }
@@ -23,14 +28,7 @@ fn main() {
         .and_then(|v| serde_json::from_slice(&v).ok())
         .unwrap();
     info!("rules {:?}", &config.rules);
-    enable_feature(Feature::BufferRequest);
 
     let plugin = Plugin {};
     register(plugin);
 }
-
-fn to_str(vec: Option<&[u8]>) -> String {
-    vec.and_then(|v| std::str::from_utf8(v).ok())
-        .unwrap_or_default()
-        .to_string()
-}