From 3c10c37788868f164ff62f22132783c576f8d595 Mon Sep 17 00:00:00 2001 From: Antoine Gravelot Date: Thu, 29 Apr 2021 20:54:29 +0200 Subject: [PATCH] Initial commit --- .github/workflows/go-cross.yml | 42 ++++++ .github/workflows/main.yml | 74 ++++++++++ .gitignore | 2 + .golangci.toml | 45 ++++++ .traefik.yml | 11 ++ LICENSE | 202 ++++++++++++++++++++++++++ Makefile | 20 +++ demo.go | 66 +++++++++ demo_test.go | 49 +++++++ go.mod | 3 + readme.md | 254 +++++++++++++++++++++++++++++++++ 11 files changed, 768 insertions(+) create mode 100644 .github/workflows/go-cross.yml create mode 100644 .github/workflows/main.yml create mode 100644 .gitignore create mode 100644 .golangci.toml create mode 100644 .traefik.yml create mode 100644 LICENSE create mode 100644 Makefile create mode 100644 demo.go create mode 100644 demo_test.go create mode 100644 go.mod create mode 100644 readme.md diff --git a/.github/workflows/go-cross.yml b/.github/workflows/go-cross.yml new file mode 100644 index 0000000..f579d66 --- /dev/null +++ b/.github/workflows/go-cross.yml @@ -0,0 +1,42 @@ +name: Go Matrix +on: [push, pull_request] + +jobs: + + cross: + name: Go + runs-on: ${{ matrix.os }} + env: + CGO_ENABLED: 0 + + strategy: + matrix: + go-version: [ 1.15, 1.x ] + os: [ubuntu-latest, macos-latest, windows-latest] + + steps: + # https://github.com/marketplace/actions/setup-go-environment + - name: Set up Go ${{ matrix.go-version }} + uses: actions/setup-go@v2 + with: + go-version: ${{ matrix.go-version }} + + # https://github.com/marketplace/actions/checkout + - name: Checkout code + uses: actions/checkout@v2 + + # https://github.com/marketplace/actions/cache + - name: Cache Go modules + uses: actions/cache@v2 + with: + path: | + ~/go/pkg/mod # Module download cache + ~/.cache/go-build # Build cache (Linux) + ~/Library/Caches/go-build # Build cache (Mac) + '%LocalAppData%\go-build' # Build cache (Windows) + key: ${{ runner.os }}-${{ matrix.go-version }}-go-${{ hashFiles('**/go.sum') }} + restore-keys: | + ${{ runner.os }}-${{ matrix.go-version }}-go- + + - name: Test + run: go test -v -cover ./... diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml new file mode 100644 index 0000000..630b69a --- /dev/null +++ b/.github/workflows/main.yml @@ -0,0 +1,74 @@ +name: Main + +on: + push: + branches: + - master + tags: + - v* + pull_request: + +jobs: + + main: + name: Main Process + runs-on: ubuntu-latest + env: + GO_VERSION: 1.15 + GOLANGCI_LINT_VERSION: v1.33.0 + YAEGI_VERSION: v0.9.8 + CGO_ENABLED: 0 + defaults: + run: + working-directory: ${{ github.workspace }}/go/src/github.com/${{ github.repository }} + + steps: + + # https://github.com/marketplace/actions/setup-go-environment + - name: Set up Go ${{ env.GO_VERSION }} + uses: actions/setup-go@v2 + with: + go-version: ${{ env.GO_VERSION }} + + # https://github.com/marketplace/actions/checkout + - name: Check out code + uses: actions/checkout@v2 + with: + path: go/src/github.com/${{ github.repository }} + fetch-depth: 0 + + # https://github.com/marketplace/actions/cache + - name: Cache Go modules + uses: actions/cache@v2 + with: + path: ${{ github.workspace }}/go/pkg/mod + key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }} + restore-keys: | + ${{ runner.os }}-go- + + # https://golangci-lint.run/usage/install#other-ci + - name: Install golangci-lint ${{ env.GOLANGCI_LINT_VERSION }} + run: curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin ${GOLANGCI_LINT_VERSION} + + - name: Install Yaegi ${{ env.YAEGI_VERSION }} + run: curl -sfL https://raw.githubusercontent.com/traefik/yaegi/master/install.sh | bash -s -- -b $(go env GOPATH)/bin ${YAEGI_VERSION} + + - name: Setup GOPATH + run: go env -w GOPATH=${{ github.workspace }}/go + + - name: Check and get dependencies + run: | + go mod tidy + git diff --exit-code go.mod + # git diff --exit-code go.sum + go mod download + go mod vendor + # git diff --exit-code ./vendor/ + + - name: Lint and Tests + run: make + + - name: Run tests with Yaegi + run: make yaegi_test + env: + GOPATH: ${{ github.workspace }}/go diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..f32e31a --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +.idea/ +.DS_Store diff --git a/.golangci.toml b/.golangci.toml new file mode 100644 index 0000000..c9010b3 --- /dev/null +++ b/.golangci.toml @@ -0,0 +1,45 @@ +[run] + timeout = "3m" + skip-files = [] + skip-dirs = [] + +[linters-settings] + + [linters-settings.govet] + check-shadowing = false + + [linters-settings.golint] + min-confidence = 0.0 + + [linters-settings.gocyclo] + min-complexity = 12.0 + + [linters-settings.maligned] + suggest-new = true + + [linters-settings.goconst] + min-len = 3.0 + min-occurrences = 4.0 + + [linters-settings.misspell] + locale = "US" + + [linters-settings.funlen] + lines = 60 # default 60 + statements = 40 # default 40 + +[linters] + enable-all = true + disable = [ + "goerr113", + "nlreturn", + "testpackage", + "paralleltest", + "tparallel", + ] + +[issues] + exclude-use-default = false + max-per-linter = 0 + max-same-issues = 0 + exclude = [] diff --git a/.traefik.yml b/.traefik.yml new file mode 100644 index 0000000..2fcbfe8 --- /dev/null +++ b/.traefik.yml @@ -0,0 +1,11 @@ +displayName: Demo Plugin +type: middleware + +import: github.com/traefik/plugindemo + +summary: '[Demo] Add Request Header' + +testData: + Headers: + X-Demo: test + X-URL: '{{URL}}' diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..253cb53 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2020 Containous SAS + Copyright 2020 Traefik Labs + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..04f6f05 --- /dev/null +++ b/Makefile @@ -0,0 +1,20 @@ +.PHONY: lint test vendor clean + +export GO111MODULE=on + +default: lint test + +lint: + golangci-lint run + +test: + go test -v -cover ./... + +yaegi_test: + yaegi test -v . + +vendor: + go mod vendor + +clean: + rm -rf ./vendor \ No newline at end of file diff --git a/demo.go b/demo.go new file mode 100644 index 0000000..88d8c18 --- /dev/null +++ b/demo.go @@ -0,0 +1,66 @@ +// Package plugindemo a demo plugin. +package plugindemo + +import ( + "bytes" + "context" + "fmt" + "net/http" + "text/template" +) + +// Config the plugin configuration. +type Config struct { + Headers map[string]string `json:"headers,omitempty"` +} + +// CreateConfig creates the default plugin configuration. +func CreateConfig() *Config { + return &Config{ + Headers: make(map[string]string), + } +} + +// Demo a Demo plugin. +type Demo struct { + next http.Handler + headers map[string]string + name string + template *template.Template +} + +// New created a new Demo plugin. +func New(ctx context.Context, next http.Handler, config *Config, name string) (http.Handler, error) { + if len(config.Headers) == 0 { + return nil, fmt.Errorf("headers cannot be empty") + } + + return &Demo{ + headers: config.Headers, + next: next, + name: name, + template: template.New("demo").Delims("[[", "]]"), + }, nil +} + +func (a *Demo) ServeHTTP(rw http.ResponseWriter, req *http.Request) { + for key, value := range a.headers { + tmpl, err := a.template.Parse(value) + if err != nil { + http.Error(rw, err.Error(), http.StatusInternalServerError) + return + } + + writer := &bytes.Buffer{} + + err = tmpl.Execute(writer, req) + if err != nil { + http.Error(rw, err.Error(), http.StatusInternalServerError) + return + } + + req.Header.Set(key, writer.String()) + } + + a.next.ServeHTTP(rw, req) +} diff --git a/demo_test.go b/demo_test.go new file mode 100644 index 0000000..dd0edcf --- /dev/null +++ b/demo_test.go @@ -0,0 +1,49 @@ +package plugindemo_test + +import ( + "context" + "net/http" + "net/http/httptest" + "testing" + + "github.com/traefik/plugindemo" +) + +func TestDemo(t *testing.T) { + cfg := plugindemo.CreateConfig() + cfg.Headers["X-Host"] = "[[.Host]]" + cfg.Headers["X-Method"] = "[[.Method]]" + cfg.Headers["X-URL"] = "[[.URL]]" + cfg.Headers["X-URL"] = "[[.URL]]" + cfg.Headers["X-Demo"] = "test" + + ctx := context.Background() + next := http.HandlerFunc(func(rw http.ResponseWriter, req *http.Request) {}) + + handler, err := plugindemo.New(ctx, next, cfg, "demo-plugin") + if err != nil { + t.Fatal(err) + } + + recorder := httptest.NewRecorder() + + req, err := http.NewRequestWithContext(ctx, http.MethodGet, "http://localhost", nil) + if err != nil { + t.Fatal(err) + } + + handler.ServeHTTP(recorder, req) + + assertHeader(t, req, "X-Host", "localhost") + assertHeader(t, req, "X-URL", "http://localhost") + assertHeader(t, req, "X-Method", "GET") + assertHeader(t, req, "X-Demo", "test") +} + +func assertHeader(t *testing.T, req *http.Request, key, expected string) { + t.Helper() + + if req.Header.Get(key) != expected { + t.Errorf("invalid header value: %s", req.Header.Get(key)) + } +} diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..45d5478 --- /dev/null +++ b/go.mod @@ -0,0 +1,3 @@ +module github.com/traefik/plugindemo + +go 1.15 diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..bb2379d --- /dev/null +++ b/readme.md @@ -0,0 +1,254 @@ +# Developing a Traefik plugin + +[Traefik](https://traefik.io) plugins are developed using the [Go language](https://golang.org). + +A [Traefik](https://traefik.io) middleware plugin is just a [Go package](https://golang.org/ref/spec#Packages) that provides an `http.Handler` to perform specific processing of requests and responses. + +Rather than being pre-compiled and linked, however, plugins are executed on the fly by [Yaegi](https://github.com/traefik/yaegi), an embedded Go interpreter. + +## Usage + +For a plugin to be active for a given Traefik instance, it must be declared in the static configuration. + +Plugins are parsed and loaded exclusively during startup, which allows Traefik to check the integrity of the code and catch errors early on. +If an error occurs during loading, the plugin is disabled. + +For security reasons, it is not possible to start a new plugin or modify an existing one while Traefik is running. + +Once loaded, middleware plugins behave exactly like statically compiled middlewares. +Their instantiation and behavior are driven by the dynamic configuration. + +Plugin dependencies must be [vendored](https://golang.org/ref/mod#tmp_25) for each plugin. +Vendored packages should be included in the plugin's GitHub repository. ([Go modules](https://blog.golang.org/using-go-modules) are not supported.) + +### Configuration + +For each plugin, the Traefik static configuration must define the module name (as is usual for Go packages). + +The following declaration (given here in YAML) defines an plugin: + +```yaml +# Static configuration +pilot: + token: xxxxx + +experimental: + plugins: + example: + moduleName: github.com/traefik/plugindemo + version: v0.2.1 +``` + +Here is an example of a file provider dynamic configuration (given here in YAML), where the interesting part is the `http.middlewares` section: + +```yaml +# Dynamic configuration + +http: + routers: + my-router: + rule: host(`demo.localhost`) + service: service-foo + entryPoints: + - web + middlewares: + - my-plugin + + services: + service-foo: + loadBalancer: + servers: + - url: http://127.0.0.1:5000 + + middlewares: + my-plugin: + plugin: + example: + headers: + Foo: Bar +``` + +### Dev Mode + +Traefik also offers a developer mode that can be used for temporary testing of plugins not hosted on GitHub. +To use a plugin in dev mode, the Traefik static configuration must define the module name (as is usual for Go packages) and a path to a [Go workspace](https://golang.org/doc/gopath_code.html#Workspaces), which can be the local GOPATH or any directory. + +```yaml +# Static configuration +pilot: + token: xxxxx + +experimental: + devPlugin: + goPath: /plugins/go + moduleName: github.com/traefik/plugindemo +``` + +(In the above example, the `plugindemo` plugin will be loaded from the path `/plugins/go/src/github.com/traefik/plugindemo`.) + +```yaml +# Dynamic configuration + +http: + routers: + my-router: + rule: host(`demo.localhost`) + service: service-foo + entryPoints: + - web + middlewares: + - my-plugin + + services: + service-foo: + loadBalancer: + servers: + - url: http://127.0.0.1:5000 + + middlewares: + my-plugin: + plugin: + dev: + headers: + Foo: Bar +``` + +#### Dev Mode Limitations + +Note that only one plugin can be tested in dev mode at a time, and when using dev mode, Traefik will shut down after 30 minutes. + +## Defining a Plugin + +A plugin package must define the following exported Go objects: + +- A type `type Config struct { ... }`. The struct fields are arbitrary. +- A function `func CreateConfig() *Config`. +- A function `func New(ctx context.Context, next http.Handler, config *Config, name string) (http.Handler, error)`. + +```go +// Package example a example plugin. +package example + +import ( + "context" + "net/http" +) + +// Config the plugin configuration. +type Config struct { + // ... +} + +// CreateConfig creates the default plugin configuration. +func CreateConfig() *Config { + return &Config{ + // ... + } +} + +// Example a plugin. +type Example struct { + next http.Handler + name string + // ... +} + +// New created a new plugin. +func New(ctx context.Context, next http.Handler, config *Config, name string) (http.Handler, error) { + // ... + return &Example{ + // ... + }, nil +} + +func (e *Example) ServeHTTP(rw http.ResponseWriter, req *http.Request) { + // ... + e.next.ServeHTTP(rw, req) +} +``` + +## Traefik Pilot + +Traefik plugins are stored and hosted as public GitHub repositories. + +Every 30 minutes, the Traefik Pilot online service polls Github to find plugins and add them to its catalog. + +### Prerequisites + +To be recognized by Traefik Pilot, your repository must meet the following criteria: + +- The `traefik-plugin` topic must be set. +- The `.traefik.yml` manifest must exist, and be filled with valid contents. + +If your repository fails to meet either of these prerequisites, Traefik Pilot will not see it. + +### Manifest + +A manifest is also mandatory, and it should be named `.traefik.yml` and stored at the root of your project. + +This YAML file provides Traefik Pilot with information about your plugin, such as a description, a full name, and so on. + +Here is an example of a typical `.traefik.yml`file: + +```yaml +# The name of your plugin as displayed in the Traefik Pilot web UI. +displayName: Name of your plugin + +# For now, `middleware` is the only type available. +type: middleware + +# The import path of your plugin. +import: github.com/username/my-plugin + +# A brief description of what your plugin is doing. +summary: Description of what my plugin is doing + +# Medias associated to the plugin (optional) +iconPath: foo/icon.png +bannerPath: foo/banner.png + +# Configuration data for your plugin. +# This is mandatory, +# and Traefik Pilot will try to execute the plugin with the data you provide as part of its startup validity tests. +testData: + Headers: + Foo: Bar +``` + +Properties include: + +- `displayName` (required): The name of your plugin as displayed in the Traefik Pilot web UI. +- `type` (required): For now, `middleware` is the only type available. +- `import` (required): The import path of your plugin. +- `summary` (required): A brief description of what your plugin is doing. +- `testData` (required): Configuration data for your plugin. This is mandatory, and Traefik Pilot will try to execute the plugin with the data you provide as part of its startup validity tests. +- `iconPath` (optional): A local path in the repository to the icon of the project. +- `bannerPath` (optional): A local path in the repository to the image that will be used when you will share your plugin page in social medias. + +There should also be a `go.mod` file at the root of your project. Traefik Pilot will use this file to validate the name of the project. + +### Tags and Dependencies + +Traefik Pilot gets your sources from a Go module proxy, so your plugins need to be versioned with a git tag. + +Last but not least, if your plugin middleware has Go package dependencies, you need to vendor them and add them to your GitHub repository. + +If something goes wrong with the integration of your plugin, Traefik Pilot will create an issue inside your Github repository and will stop trying to add your repo until you close the issue. + +## Troubleshooting + +If Traefik Pilot fails to recognize your plugin, you will need to make one or more changes to your GitHub repository. + +In order for your plugin to be successfully imported by Traefik Pilot, consult this checklist: + +- The `traefik-plugin` topic must be set on your repository. +- There must be a `.traefik.yml` file at the root of your project describing your plugin, and it must have a valid `testData` property for testing purposes. +- There must be a valid `go.mod` file at the root of your project. +- Your plugin must be versioned with a git tag. +- If you have package dependencies, they must be vendored and added to your GitHub repository. + +## Sample Code + +This repository includes an example plugin, `demo`, for you to use as a reference for developing your own plugins. + +[![Build Status](https://github.com/traefik/plugindemo/workflows/Main/badge.svg?branch=master)](https://github.com/traefik/plugindemo/actions)