From 217e643faf2df714289312f6bc3ae3da3f7eb776 Mon Sep 17 00:00:00 2001
From: Hendrik Schlehlein
Date: Fri, 2 Feb 2024 04:37:30 +0000
Subject: [PATCH] rewrite: everything (#202)
* revise: codebase
* fix: remove old .vscode and .github dir
* feat: cache status response packet
* add scripts folder with a simple test script inside of it
* simplefy `RespondeToServerRequest` a little
* improve readability hash implemetation of status cache
* Implement sending proxy protocol header to backend server for login requests.
* remove redundant test script
* remove pk.WriteTo(hash) statement and remove redundant Sum64 call of hash
* don't expose cacheResponse method for now
* refactor: one port to bind them all (#197)
* refactor: listener to only one
* refactor: into methods
* feat: add config file loading (#194)
* feat: add rate limiter (#201)
* feat: add server addresses
* feat: add config file loading
* fix: proxy protocol
Signed-off-by: haveachin
* feat: add rate limiter
Signed-off-by: haveachin
* refactor: middleware to filter
Signed-off-by: haveachin
* refactor: more testability
* refactor: listener to only one
* refactor: config files
* feat: add config file loading
* refactor: filter for only one listener
* feat: add docs
* docs: add config docs
* refactor: file loading
* refactor: remove unnecessary mutex
* docs: clean up readme
* feat: add linting, ci and release automation
* docs: add rate limiter
* fix: linting errors
* fix: linting errors
* fix: linting errors
* chore: clean up
* refactor: ServerRequester
* feat: add zerolog
* chore: clean up
---------
Signed-off-by: haveachin
---------
Signed-off-by: haveachin
Co-authored-by: realDragonium
---
.github/FUNDING.yml | 12 +
.github/ISSUE_TEMPLATE/bug_report.md | 27 -
.github/ISSUE_TEMPLATE/feature_request.md | 20 -
.github/workflows/ci.yml | 52 +
.github/workflows/lint.yml | 46 +
.github/workflows/release.yml | 49 +
.github/workflows/test-build-release.yml | 140 --
.gitignore | 31 +-
.golangci.yml | 330 ++++
.goreleaser.yml | 95 ++
CONTRIBUTING.md | 45 +
Dockerfile | 12 -
LICENSE | 862 +++++++---
Makefile | 33 +
README.md | 355 +---
api/api.go | 115 --
build/packages/Dockerfile | 12 +
build/packages/Dockerfile.goreleaser | 4 +
callback/callback.go | 86 -
callback/callback_test.go | 159 --
callback/event.go | 60 -
callback/event_test.go | 37 -
cmd/infrared/.goreleaser.yml | 48 -
cmd/infrared/config.go | 32 +
cmd/infrared/main.go | 190 +--
config.go | 476 ------
configs/config.yml | 26 +
configs/embed.go | 6 +
configs/haproxy.cfg | 37 +
configs/proxy.yml | 16 +
conn.go | 122 --
deployments/docker-compose.dev.yml | 45 +
deployments/docker-compose.yml | 11 +
docker-compose.yml | 17 -
docs/.vitepress/config.mts | 95 ++
docs/.vitepress/theme/custom.css | 24 +
docs/.vitepress/theme/index.js | 5 +
docs/assets/agplv3_logo.svg | 28 +
docs/assets/logo.svg | 48 +
docs/assets/logo_black_text.svg | 60 +
docs/assets/logo_white_text.svg | 60 +
docs/branding.md | 19 +
docs/config/cli-and-env-vars.md | 25 +
docs/config/index.md | 18 +
docs/config/proxies.md | 21 +
docs/features/filters.md | 20 +
docs/features/forward-player-ips.md | 16 +
docs/features/rate-limit-ips.md | 20 +
docs/getting-started.md | 79 +
docs/index.md | 29 +
docs/package-lock.json | 1506 +++++++++++++++++
docs/package.json | 10 +
gateway.go | 219 ---
gateway_test.go | 635 -------
go.mod | 37 +-
go.sum | 517 +-----
grafana/README.md | 38 -
grafana/dashboard.json | 741 --------
grafana/dashboard.png | Bin 345785 -> 0 bytes
pkg/infrared/config/file.go | 147 ++
pkg/infrared/conn.go | 102 ++
pkg/infrared/filter.go | 65 +
pkg/infrared/infrared.go | 317 ++++
pkg/infrared/infrared_test.go | 81 +
{protocol => pkg/infrared/protocol}/errors.go | 0
.../handshaking/serverbound_handshake.go | 140 ++
.../handshaking/serverbound_handshake_test.go | 149 +-
.../protocol/login/clientbound_disconnect.go | 16 +
.../login/clientbound_disconnect_test.go | 17 +-
.../login/clientbound_encryptionrequest.go | 32 +
.../login/serverbound_encryptionresponse.go | 29 +
.../protocol/login/serverbound_loginstart.go | 95 ++
.../login/serverbound_loginstart_test.go | 19 +-
pkg/infrared/protocol/packet.go | 118 ++
pkg/infrared/protocol/peeker.go | 40 +
.../infrared/protocol}/peeker_test.go | 37 +-
.../protocol/play/clientbound_disconnect.go | 16 +
.../protocol/status/clientbound_response.go | 98 ++
.../status/clientbound_response_test.go | 28 +-
.../protocol/status/serverbound_request.go | 13 +
.../status/serverbound_request_test.go | 32 +
pkg/infrared/protocol/types.go | 265 +++
pkg/infrared/protocol/types_test.go | 174 ++
pkg/infrared/protocol/versions.go | 31 +
pkg/infrared/rate_limiter.go | 245 +++
pkg/infrared/server.go | 315 ++++
process/docker.go | 90 -
process/portainer.go | 148 --
process/process.go | 14 -
protocol/handshaking/serverbound_handshake.go | 99 --
protocol/login/clientbound_disconnect.go | 18 -
protocol/login/serverbound_loginstart.go | 25 -
protocol/packet.go | 93 -
protocol/packet_test.go | 237 ---
protocol/peeker.go | 40 -
protocol/status/clientbound_response.go | 61 -
protocol/status/serverbound_request.go | 15 -
protocol/status/serverbound_request_test.go | 29 -
protocol/types.go | 256 ---
protocol/types_test.go | 415 -----
proxy.go | 448 -----
tools/dos/main.go | 135 ++
tools/malpk/main.go | 51 +
103 files changed, 6502 insertions(+), 6171 deletions(-)
create mode 100644 .github/FUNDING.yml
delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md
delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md
create mode 100644 .github/workflows/ci.yml
create mode 100644 .github/workflows/lint.yml
create mode 100644 .github/workflows/release.yml
delete mode 100644 .github/workflows/test-build-release.yml
create mode 100644 .golangci.yml
create mode 100644 .goreleaser.yml
create mode 100644 CONTRIBUTING.md
delete mode 100644 Dockerfile
create mode 100644 Makefile
delete mode 100644 api/api.go
create mode 100644 build/packages/Dockerfile
create mode 100644 build/packages/Dockerfile.goreleaser
delete mode 100644 callback/callback.go
delete mode 100644 callback/callback_test.go
delete mode 100644 callback/event.go
delete mode 100644 callback/event_test.go
delete mode 100644 cmd/infrared/.goreleaser.yml
create mode 100644 cmd/infrared/config.go
delete mode 100644 config.go
create mode 100644 configs/config.yml
create mode 100644 configs/embed.go
create mode 100644 configs/haproxy.cfg
create mode 100644 configs/proxy.yml
delete mode 100644 conn.go
create mode 100644 deployments/docker-compose.dev.yml
create mode 100644 deployments/docker-compose.yml
delete mode 100644 docker-compose.yml
create mode 100644 docs/.vitepress/config.mts
create mode 100644 docs/.vitepress/theme/custom.css
create mode 100644 docs/.vitepress/theme/index.js
create mode 100644 docs/assets/agplv3_logo.svg
create mode 100644 docs/assets/logo.svg
create mode 100644 docs/assets/logo_black_text.svg
create mode 100644 docs/assets/logo_white_text.svg
create mode 100644 docs/branding.md
create mode 100644 docs/config/cli-and-env-vars.md
create mode 100644 docs/config/index.md
create mode 100644 docs/config/proxies.md
create mode 100644 docs/features/filters.md
create mode 100644 docs/features/forward-player-ips.md
create mode 100644 docs/features/rate-limit-ips.md
create mode 100644 docs/getting-started.md
create mode 100644 docs/index.md
create mode 100644 docs/package-lock.json
create mode 100644 docs/package.json
delete mode 100644 gateway.go
delete mode 100644 gateway_test.go
delete mode 100644 grafana/README.md
delete mode 100644 grafana/dashboard.json
delete mode 100644 grafana/dashboard.png
create mode 100644 pkg/infrared/config/file.go
create mode 100644 pkg/infrared/conn.go
create mode 100644 pkg/infrared/filter.go
create mode 100644 pkg/infrared/infrared.go
create mode 100644 pkg/infrared/infrared_test.go
rename {protocol => pkg/infrared/protocol}/errors.go (100%)
create mode 100644 pkg/infrared/protocol/handshaking/serverbound_handshake.go
rename {protocol => pkg/infrared/protocol}/handshaking/serverbound_handshake_test.go (53%)
create mode 100644 pkg/infrared/protocol/login/clientbound_disconnect.go
rename {protocol => pkg/infrared/protocol}/login/clientbound_disconnect_test.go (65%)
create mode 100644 pkg/infrared/protocol/login/clientbound_encryptionrequest.go
create mode 100644 pkg/infrared/protocol/login/serverbound_encryptionresponse.go
create mode 100644 pkg/infrared/protocol/login/serverbound_loginstart.go
rename {protocol => pkg/infrared/protocol}/login/serverbound_loginstart_test.go (56%)
create mode 100644 pkg/infrared/protocol/packet.go
create mode 100644 pkg/infrared/protocol/peeker.go
rename {protocol => pkg/infrared/protocol}/peeker_test.go (79%)
create mode 100644 pkg/infrared/protocol/play/clientbound_disconnect.go
create mode 100644 pkg/infrared/protocol/status/clientbound_response.go
rename {protocol => pkg/infrared/protocol}/status/clientbound_response_test.go (69%)
create mode 100644 pkg/infrared/protocol/status/serverbound_request.go
create mode 100644 pkg/infrared/protocol/status/serverbound_request_test.go
create mode 100644 pkg/infrared/protocol/types.go
create mode 100644 pkg/infrared/protocol/types_test.go
create mode 100644 pkg/infrared/protocol/versions.go
create mode 100644 pkg/infrared/rate_limiter.go
create mode 100644 pkg/infrared/server.go
delete mode 100644 process/docker.go
delete mode 100644 process/portainer.go
delete mode 100644 process/process.go
delete mode 100644 protocol/handshaking/serverbound_handshake.go
delete mode 100644 protocol/login/clientbound_disconnect.go
delete mode 100644 protocol/login/serverbound_loginstart.go
delete mode 100644 protocol/packet.go
delete mode 100644 protocol/packet_test.go
delete mode 100644 protocol/peeker.go
delete mode 100644 protocol/status/clientbound_response.go
delete mode 100644 protocol/status/serverbound_request.go
delete mode 100644 protocol/status/serverbound_request_test.go
delete mode 100644 protocol/types.go
delete mode 100644 protocol/types_test.go
delete mode 100644 proxy.go
create mode 100644 tools/dos/main.go
create mode 100644 tools/malpk/main.go
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
new file mode 100644
index 00000000..4ac9da1d
--- /dev/null
+++ b/.github/FUNDING.yml
@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: haveachin
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: haveachin
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: https://paypal.me/hendrikschlehlein # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
deleted file mode 100644
index 70e3a2cf..00000000
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ /dev/null
@@ -1,27 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: bug
-assignees: ''
-
----
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-What OS are you using?
-What version of Infrared are you using?
-What do your Infrared proxy config(s) look like?
-How do you trigger the bug/issue?
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Screenshots** (Optional)
-If applicable, add screenshots to help explain your problem.
-A copy of your logs would be nice, but please be sure to censor any information that you don't want to be public.
-
-**Additional context** (Optional)
-Add any other context of the problem here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
deleted file mode 100644
index c9608331..00000000
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ /dev/null
@@ -1,20 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: ''
-labels: enhancement
-assignees: ''
-
----
-
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. E.g.: "I'm always frustrated when [...]"
-
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
-
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
-
-**Additional context**
-Add any other context or screenshots regarding the feature request here.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
new file mode 100644
index 00000000..007e7e7e
--- /dev/null
+++ b/.github/workflows/ci.yml
@@ -0,0 +1,52 @@
+name: CI
+
+on:
+ push:
+ branches:
+ - master
+ - main
+ pull_request:
+
+permissions:
+ contents: read
+
+env:
+ GO_VERSION: 1.21
+
+jobs:
+ test:
+ name: Test
+ strategy:
+ matrix:
+ os: [ ubuntu-latest, macos-latest, windows-latest ]
+ runs-on: ${{ matrix.os }}
+ steps:
+ - name: Install Go
+ uses: actions/setup-go@v3
+ with:
+ go-version: ${{ env.GO_VERSION }}
+ - name: Checkout code
+ uses: actions/checkout@v3
+ - name: Test
+ run: make test
+
+ build:
+ name: Build
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v4
+ with:
+ fetch-depth: 0
+ - name: Set up Go
+ uses: actions/setup-go@v4
+ with:
+ go-version: ${{ env.GO_VERSION }}
+ - name: Set up Docker Buildx
+ uses: docker/setup-buildx-action@v3
+ - name: Run GoReleaser
+ uses: goreleaser/goreleaser-action@v5
+ with:
+ # either 'goreleaser' (default) or 'goreleaser-pro'
+ distribution: goreleaser
+ args: build --snapshot
\ No newline at end of file
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
new file mode 100644
index 00000000..c5ea5b91
--- /dev/null
+++ b/.github/workflows/lint.yml
@@ -0,0 +1,46 @@
+name: Lint
+
+on:
+ push:
+ branches:
+ - master
+ - main
+ pull_request:
+
+permissions:
+ contents: read
+ pull-requests: read
+ checks: write
+
+env:
+ GO_VERSION: 1.21
+
+jobs:
+ golangci:
+ name: Lint
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v3
+ - uses: actions/setup-go@v4
+ with:
+ go-version: ${{ env.GO_VERSION }}
+ cache: false
+ - name: golangci-lint
+ uses: golangci/golangci-lint-action@v3
+ with:
+ # Require: The version of golangci-lint to use.
+ # When `install-mode` is `binary` (default) the value can be v1.2 or v1.2.3 or `latest` to use the latest version.
+ # When `install-mode` is `goinstall` the value can be v1.2.3, `latest`, or the hash of a commit.
+ version: v1.55.2
+
+ # Optional: working directory, useful for monorepos
+ # working-directory: somedir
+
+ # Optional: golangci-lint command line arguments.
+ #
+ # Note: By default, the `.golangci.yml` file should be at the root of the repository.
+ # The location of the configuration file can be changed by using `--config=`
+ # args: --timeout=30m --config=/my/path/.golangci.yml --issues-exit-code=0
+
+ # Optional: show only new issues if it's a pull request. The default value is `false`.
+ only-new-issues: true
\ No newline at end of file
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
new file mode 100644
index 00000000..1d1a4214
--- /dev/null
+++ b/.github/workflows/release.yml
@@ -0,0 +1,49 @@
+name: Release
+
+on:
+ push:
+ tags:
+ - "*"
+
+permissions:
+ contents: write
+ packages: write
+
+env:
+ GO_VERSION: 1.21
+
+jobs:
+ release:
+ name: Build & Release
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v4
+ with:
+ fetch-depth: 0
+ - name: Set up Go
+ uses: actions/setup-go@v4
+ with:
+ go-version: ${{ env.GO_VERSION }}
+ - name: Set up Docker Buildx
+ uses: docker/setup-buildx-action@v3
+ - name: Login to Docker Hub
+ uses: docker/login-action@v3
+ with:
+ username: ${{ secrets.DOCKERHUB_USERNAME }}
+ password: ${{ secrets.DOCKERHUB_TOKEN }}
+ - name: Login to GitHub Container Registry
+ uses: docker/login-action@v2
+ with:
+ registry: ghcr.io
+ username: ${{ github.actor }}
+ password: ${{ secrets.GITHUB_TOKEN }}
+ - name: Run GoReleaser
+ uses: goreleaser/goreleaser-action@v5
+ with:
+ # either 'goreleaser' (default) or 'goreleaser-pro'
+ distribution: goreleaser
+ version: latest
+ args: release --clean
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/test-build-release.yml b/.github/workflows/test-build-release.yml
deleted file mode 100644
index e126208d..00000000
--- a/.github/workflows/test-build-release.yml
+++ /dev/null
@@ -1,140 +0,0 @@
-name: Test, Build, Release
-
-on:
- push:
- branches: [ 'master', 'pre-release' ]
- pull_request:
- branches: [ 'master', 'dev', 'pre-release' ]
-
-env:
- GH_REGISTRY: ghcr.io
- REPOSITORY_NAME: ${{ github.repository }}
-
-jobs:
-
- # Build job runs on every PR into dev and master and pushes to master
- test:
- name: Test
- strategy:
- matrix:
- go-version: [ 1.16.x ]
- os: [ ubuntu-latest, macos-latest, windows-latest ]
- runs-on: ${{ matrix.os }}
- steps:
- - name: Install Go
- uses: actions/setup-go@v2
- with:
- go-version: ${{ matrix.go-version }}
- - name: Checkout code
- uses: actions/checkout@v2
- - name: Test
- run: go test ./...
-
- # Build job runs on every PR into dev and master and pushes to master
- # Depends on test job
- build-docker:
- runs-on: ubuntu-latest
- name: Build
- needs: [ test ]
- steps:
- - name: Checkout repository
- uses: actions/checkout@v2
-
- - name: Set up Docker Buildx
- id: buildx
- uses: docker/setup-buildx-action@master
-
- - name: Build Docker Images
- uses: docker/build-push-action@v2
- with:
- context: .
- builder: ${{ steps.buildx.outputs.name }}
- pull: true
- push: false
- tags: ${{ steps.meta.outputs.tags }}
- labels: ${{ steps.meta.outputs.labels }}
- cache-from: type=gha
- cache-to: type=gha,mode=max
-
- # Release job runs on every push to master
- # Depends on build job
- release-docker:
- runs-on: ubuntu-latest
- name: Release
- if: ${{ github.ref == 'refs/heads/master' || github.ref == 'refs/heads/pre-release' }}
- needs: [ build-docker ]
- steps:
- - name: Checkout repository
- uses: actions/checkout@v2
-
- # Create semver tag and changelog
- - name: Bump version and push tag
- id: tag_version
- uses: mathieudutour/github-tag-action@v5.6
- with:
- github_token: ${{ secrets.GITHUB_TOKEN }}
- release_branches: master
- pre_release_branches: pre-release
-
- # Build Docker Images
- - name: Set up Docker Buildx
- id: buildx
- uses: docker/setup-buildx-action@master
-
- - name: Extract metadata for Docker
- id: meta
- uses: docker/metadata-action@v3
- with:
- images: |
- ${{ env.GH_REGISTRY }}/${{ env.REPOSITORY_NAME }}
- ${{ env.REPOSITORY_NAME }}
- tags: |
- type=semver,pattern={{version}},value=${{ steps.tag_version.outputs.new_tag }}
-
- - name: Login to DockerHub
- uses: docker/login-action@v1
- with:
- username: ${{ secrets.DOCKERHUB_USERNAME }}
- password: ${{ secrets.DOCKERHUB_TOKEN }}
-
- - name: Login to GitHub Container Registry
- uses: docker/login-action@v1
- with:
- registry: ${{ env.GH_REGISTRY }}
- username: ${{ github.actor }}
- password: ${{ secrets.GITHUB_TOKEN }}
-
- - name: Build and push version ${{ steps.tag_version.outputs.new_tag }}
- uses: docker/build-push-action@v2
- with:
- context: .
- builder: ${{ steps.buildx.outputs.name }}
- tags: ${{ steps.meta.outputs.tags }}
- labels: ${{ steps.meta.outputs.labels }}
- push: true
- cache-from: type=gha
- cache-to: type=gha,mode=max
-
- # Create GitHub release once images have been pushed
- - name: Create a GitHub release ${{ steps.tag_version.outputs.new_tag }}
- uses: ncipollo/release-action@v1
- with:
- tag: ${{ steps.tag_version.outputs.new_tag }}
- name: Release ${{ steps.tag_version.outputs.new_tag }}
- body: ${{ steps.tag_version.outputs.changelog }}
- prerelease: contains( ${{ steps.tag_version.outputs.release_type }} , 'pre' )
-
- # Build Go Release
- - run: git tag ${{ steps.tag_version.outputs.new_tag }}
- - name: Set up Go
- uses: actions/setup-go@v2
- with:
- go-version: 1.16
- - name: Run GoReleaser ${{ steps.tag_version.outputs.new_tag }}
- uses: goreleaser/goreleaser-action@v2
- with:
- version: latest
- args: release
- workdir: ./cmd/infrared/.
- env:
- GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.gitignore b/.gitignore
index 55123b3e..a4636156 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,17 +1,24 @@
-# Binaries for programs and plugins
-*.exe
-*.exe~
-*.dll
-*.so
-*.dylib
+# Artifacts
+out/
+__debug_bin*
+dist/
-# Test binary, build with `go test -c`
+# Benchmark/Profiler
+*.bench
*.test
+*.prof
-# Output of the go coverage tool, specifically when used with LiteIDE
-*.out
+# Local Dev Files
+.dev/
+cmd/infrared/config.yml
-# Config files
-*.yaml
+# VSCode Dev Files
+.vscode/
-.idea
+# IntelliJ Dev Files
+.idea/
+
+# Docs
+docs/node_modules/
+docs/.vitepress/cache/
+docs/.vitepress/dist/
\ No newline at end of file
diff --git a/.golangci.yml b/.golangci.yml
new file mode 100644
index 00000000..dea3674a
--- /dev/null
+++ b/.golangci.yml
@@ -0,0 +1,330 @@
+# This code is licensed under the terms of the MIT license https://opensource.org/license/mit
+# Copyright (c) 2021 Marat Reymers
+
+## Golden config for golangci-lint v1.55.2
+#
+# This is the best config for golangci-lint based on my experience and opinion.
+# It is very strict, but not extremely strict.
+# Feel free to adapt and change it for your needs.
+
+run:
+ # Timeout for analysis, e.g. 30s, 5m.
+ # Default: 1m
+ timeout: 3m
+
+
+# This file contains only configs which differ from defaults.
+# All possible options can be found here https://github.com/golangci/golangci-lint/blob/master/.golangci.reference.yml
+linters-settings:
+ cyclop:
+ # The maximal code complexity to report.
+ # Default: 10
+ max-complexity: 30
+ # The maximal average package complexity.
+ # If it's higher than 0.0 (float) the check is enabled
+ # Default: 0.0
+ package-average: 10.0
+
+ errcheck:
+ # Report about not checking of errors in type assertions: `a := b.(MyStruct)`.
+ # Such cases aren't reported by default.
+ # Default: false
+ check-type-assertions: true
+
+ exhaustive:
+ # Program elements to check for exhaustiveness.
+ # Default: [ switch ]
+ check:
+ - switch
+ - map
+
+ exhaustruct:
+ # List of regular expressions to exclude struct packages and names from check.
+ # Default: []
+ exclude:
+ # std libs
+ - "^net/http.Client$"
+ - "^net/http.Cookie$"
+ - "^net/http.Request$"
+ - "^net/http.Response$"
+ - "^net/http.Server$"
+ - "^net/http.Transport$"
+ - "^net/url.URL$"
+ - "^os/exec.Cmd$"
+ - "^reflect.StructField$"
+ # public libs
+ - "^github.com/Shopify/sarama.Config$"
+ - "^github.com/Shopify/sarama.ProducerMessage$"
+ - "^github.com/mitchellh/mapstructure.DecoderConfig$"
+ - "^github.com/prometheus/client_golang/.+Opts$"
+ - "^github.com/spf13/cobra.Command$"
+ - "^github.com/spf13/cobra.CompletionOptions$"
+ - "^github.com/stretchr/testify/mock.Mock$"
+ - "^github.com/testcontainers/testcontainers-go.+Request$"
+ - "^github.com/testcontainers/testcontainers-go.FromDockerfile$"
+ - "^golang.org/x/tools/go/analysis.Analyzer$"
+ - "^google.golang.org/protobuf/.+Options$"
+ - "^gopkg.in/yaml.v3.Node$"
+
+ funlen:
+ # Checks the number of lines in a function.
+ # If lower than 0, disable the check.
+ # Default: 60
+ lines: 100
+ # Checks the number of statements in a function.
+ # If lower than 0, disable the check.
+ # Default: 40
+ statements: 50
+ # Ignore comments when counting lines.
+ # Default false
+ ignore-comments: true
+
+ gocognit:
+ # Minimal code complexity to report.
+ # Default: 30 (but we recommend 10-20)
+ min-complexity: 20
+
+ gocritic:
+ # Settings passed to gocritic.
+ # The settings key is the name of a supported gocritic checker.
+ # The list of supported checkers can be find in https://go-critic.github.io/overview.
+ settings:
+ captLocal:
+ # Whether to restrict checker to params only.
+ # Default: true
+ paramsOnly: false
+ underef:
+ # Whether to skip (*x).method() calls where x is a pointer receiver.
+ # Default: true
+ skipRecvDeref: false
+
+ gomnd:
+ # List of function patterns to exclude from analysis.
+ # Values always ignored: `time.Date`,
+ # `strconv.FormatInt`, `strconv.FormatUint`, `strconv.FormatFloat`,
+ # `strconv.ParseInt`, `strconv.ParseUint`, `strconv.ParseFloat`.
+ # Default: []
+ ignored-functions:
+ - flag.Arg
+ - flag.Duration.*
+ - flag.Float.*
+ - flag.Int.*
+ - flag.Uint.*
+ - os.Chmod
+ - os.Mkdir.*
+ - os.OpenFile
+ - os.WriteFile
+ - prometheus.ExponentialBuckets.*
+ - prometheus.LinearBuckets
+
+ gomodguard:
+ blocked:
+ # List of blocked modules.
+ # Default: []
+ modules:
+ - github.com/golang/protobuf:
+ recommendations:
+ - google.golang.org/protobuf
+ reason: "see https://developers.google.com/protocol-buffers/docs/reference/go/faq#modules"
+ - github.com/satori/go.uuid:
+ recommendations:
+ - github.com/google/uuid
+ reason: "satori's package is not maintained"
+ - github.com/gofrs/uuid:
+ recommendations:
+ - github.com/google/uuid
+ reason: "gofrs' package is not go module"
+
+ govet:
+ # Enable all analyzers.
+ # Default: false
+ enable-all: true
+ # Disable analyzers by name.
+ # Run `go tool vet help` to see all analyzers.
+ # Default: []
+ disable:
+ - fieldalignment # too strict
+ # Settings per analyzer.
+ settings:
+ shadow:
+ # Whether to be strict about shadowing; can be noisy.
+ # Default: false
+ strict: true
+
+ nakedret:
+ # Make an issue if func has more lines of code than this setting, and it has naked returns.
+ # Default: 30
+ max-func-lines: 0
+
+ nolintlint:
+ # Exclude following linters from requiring an explanation.
+ # Default: []
+ allow-no-explanation: [ funlen, gocognit, lll ]
+ # Enable to require an explanation of nonzero length after each nolint directive.
+ # Default: false
+ require-explanation: true
+ # Enable to require nolint directives to mention the specific linter being suppressed.
+ # Default: false
+ require-specific: true
+
+ rowserrcheck:
+ # database/sql is always checked
+ # Default: []
+ packages:
+ - github.com/jmoiron/sqlx
+
+ tenv:
+ # The option `all` will run against whole test files (`_test.go`) regardless of method/function signatures.
+ # Otherwise, only methods that take `*testing.T`, `*testing.B`, and `testing.TB` as arguments are checked.
+ # Default: false
+ all: true
+
+
+linters:
+ disable-all: true
+ enable:
+ ## enabled by default
+ - errcheck # checking for unchecked errors, these unchecked errors can be critical bugs in some cases
+ - gosimple # specializes in simplifying a code
+ - govet # reports suspicious constructs, such as Printf calls whose arguments do not align with the format string
+ - ineffassign # detects when assignments to existing variables are not used
+ - staticcheck # is a go vet on steroids, applying a ton of static analysis checks
+ - typecheck # like the front-end of a Go compiler, parses and type-checks Go code
+ - unused # checks for unused constants, variables, functions and types
+ ## disabled by default
+ - asasalint # checks for pass []any as any in variadic func(...any)
+ - asciicheck # checks that your code does not contain non-ASCII identifiers
+ - bidichk # checks for dangerous unicode character sequences
+ - bodyclose # checks whether HTTP response body is closed successfully
+ - cyclop # checks function and package cyclomatic complexity
+ - dupl # tool for code clone detection
+ - durationcheck # checks for two durations multiplied together
+ - errname # checks that sentinel errors are prefixed with the Err and error types are suffixed with the Error
+ - errorlint # finds code that will cause problems with the error wrapping scheme introduced in Go 1.13
+ - execinquery # checks query string in Query function which reads your Go src files and warning it finds
+ - exhaustive # checks exhaustiveness of enum switch statements
+ - exportloopref # checks for pointers to enclosing loop variables
+ - forbidigo # forbids identifiers
+ - funlen # tool for detection of long functions
+ - gocheckcompilerdirectives # validates go compiler directive comments (//go:)
+ - gochecknoinits # checks that no init functions are present in Go code
+ - gochecksumtype # checks exhaustiveness on Go "sum types"
+ - gocognit # computes and checks the cognitive complexity of functions
+ - goconst # finds repeated strings that could be replaced by a constant
+ - gocritic # provides diagnostics that check for bugs, performance and style issues
+ - gocyclo # computes and checks the cyclomatic complexity of functions
+ - godot # checks if comments end in a period
+ - goimports # in addition to fixing imports, goimports also formats your code in the same style as gofmt
+ - gomoddirectives # manages the use of 'replace', 'retract', and 'excludes' directives in go.mod
+ - gomodguard # allow and block lists linter for direct Go module dependencies. This is different from depguard where there are different block types for example version constraints and module recommendations
+ - goprintffuncname # checks that printf-like functions are named with f at the end
+ - gosec # inspects source code for security problems
+ - lll # reports long lines
+ - loggercheck # checks key value pairs for common logger libraries (kitlog,klog,logr,zap)
+ - makezero # finds slice declarations with non-zero initial length
+ - mirror # reports wrong mirror patterns of bytes/strings usage
+ - musttag # enforces field tags in (un)marshaled structs
+ - nakedret # finds naked returns in functions greater than a specified function length
+ - nestif # reports deeply nested if statements
+ - nilerr # finds the code that returns nil even if it checks that the error is not nil
+ - nilnil # checks that there is no simultaneous return of nil error and an invalid value
+ - noctx # finds sending http request without context.Context
+ - nolintlint # reports ill-formed or insufficient nolint directives
+ - nonamedreturns # reports all named returns
+ - nosprintfhostport # checks for misuse of Sprintf to construct a host with port in a URL
+ - perfsprint # checks that fmt.Sprintf can be replaced with a faster alternative
+ - predeclared # finds code that shadows one of Go's predeclared identifiers
+ - promlinter # checks Prometheus metrics naming via promlint
+ - protogetter # reports direct reads from proto message fields when getters should be used
+ - reassign # checks that package variables are not reassigned
+ - revive # fast, configurable, extensible, flexible, and beautiful linter for Go, drop-in replacement of golint
+ - rowserrcheck # checks whether Err of rows is checked successfully
+ - sloglint # ensure consistent code style when using log/slog
+ - sqlclosecheck # checks that sql.Rows and sql.Stmt are closed
+ - stylecheck # is a replacement for golint
+ - tenv # detects using os.Setenv instead of t.Setenv since Go1.17
+ - testableexamples # checks if examples are testable (have an expected output)
+ - testifylint # checks usage of github.com/stretchr/testify
+ - tparallel # detects inappropriate usage of t.Parallel() method in your Go test codes
+ - unconvert # removes unnecessary type conversions
+ - unparam # reports unused function parameters
+ - usestdlibvars # detects the possibility to use variables/constants from the Go standard library
+ - wastedassign # finds wasted assignment statements
+ - whitespace # detects leading and trailing whitespace
+ - prealloc # [premature optimization, but can be used in some cases] finds slice declarations that could potentially be preallocated
+
+ ## you may want to enable
+ #- decorder # checks declaration order and count of types, constants, variables and functions
+ #- exhaustruct # [highly recommend to enable] checks if all structure fields are initialized
+ #- gci # controls golang package import order and makes it always deterministic
+ #- ginkgolinter # [if you use ginkgo/gomega] enforces standards of using ginkgo and gomega
+ #- godox # detects FIXME, TODO and other comment keywords
+ #- goheader # checks is file header matches to pattern
+ #- inamedparam # [great idea, but too strict, need to ignore a lot of cases by default] reports interfaces with unnamed method parameters
+ #- interfacebloat # checks the number of methods inside an interface
+ #- ireturn # accept interfaces, return concrete types
+ #- tagalign # checks that struct tags are well aligned
+ #- varnamelen # [great idea, but too many false positives] checks that the length of a variable's name matches its scope
+ #- wrapcheck # checks that errors returned from external packages are wrapped
+ #- zerologlint # detects the wrong usage of zerolog that a user forgets to dispatch zerolog.Event
+ #- gochecknoglobals # checks that no global variables exist
+ #- gomnd # detects magic numbers
+ #- testpackage # makes you use a separate _test package
+
+ ## disabled
+ #- containedctx # detects struct contained context.Context field
+ #- contextcheck # [too many false positives] checks the function whether use a non-inherited context
+ #- depguard # [replaced by gomodguard] checks if package imports are in a list of acceptable packages
+ #- dogsled # checks assignments with too many blank identifiers (e.g. x, _, _, _, := f())
+ #- dupword # [useless without config] checks for duplicate words in the source code
+ #- errchkjson # [don't see profit + I'm against of omitting errors like in the first example https://github.com/breml/errchkjson] checks types passed to the json encoding functions. Reports unsupported types and optionally reports occasions, where the check for the returned error can be omitted
+ #- forcetypeassert # [replaced by errcheck] finds forced type assertions
+ #- goerr113 # [too strict] checks the errors handling expressions
+ #- gofmt # [replaced by goimports] checks whether code was gofmt-ed
+ #- gofumpt # [replaced by goimports, gofumports is not available yet] checks whether code was gofumpt-ed
+ #- gosmopolitan # reports certain i18n/l10n anti-patterns in your Go codebase
+ #- grouper # analyzes expression groups
+ #- importas # enforces consistent import aliases
+ #- maintidx # measures the maintainability index of each function
+ #- misspell # [useless] finds commonly misspelled English words in comments
+ #- nlreturn # [too strict and mostly code is not more readable] checks for a new line before return and branch statements to increase code clarity
+ #- paralleltest # [too many false positives] detects missing usage of t.Parallel() method in your Go test
+ #- tagliatelle # checks the struct tags
+ #- thelper # detects golang test helpers without t.Helper() call and checks the consistency of test helpers
+ #- wsl # [too strict and mostly code is not more readable] whitespace linter forces you to use empty lines
+
+ ## deprecated
+ #- deadcode # [deprecated, replaced by unused] finds unused code
+ #- exhaustivestruct # [deprecated, replaced by exhaustruct] checks if all struct's fields are initialized
+ #- golint # [deprecated, replaced by revive] golint differs from gofmt. Gofmt reformats Go source code, whereas golint prints out style mistakes
+ #- ifshort # [deprecated] checks that your code uses short syntax for if-statements whenever possible
+ #- interfacer # [deprecated] suggests narrower interface types
+ #- maligned # [deprecated, replaced by govet fieldalignment] detects Go structs that would take less memory if their fields were sorted
+ #- nosnakecase # [deprecated, replaced by revive var-naming] detects snake case of variable naming and function name
+ #- scopelint # [deprecated, replaced by exportloopref] checks for unpinned variables in go programs
+ #- structcheck # [deprecated, replaced by unused] finds unused struct fields
+ #- varcheck # [deprecated, replaced by unused] finds unused global variables and constants
+
+
+issues:
+ # Maximum count of issues with the same text.
+ # Set to 0 to disable.
+ # Default: 3
+ max-same-issues: 50
+
+ exclude-rules:
+ - source: "(noinspection|TODO)"
+ linters: [ godot ]
+ - source: "//noinspection"
+ linters: [ gocritic ]
+ - path: "_test\\.go"
+ linters:
+ - bodyclose
+ - dupl
+ - funlen
+ - goconst
+ - gosec
+ - noctx
+ - wrapcheck
+ - text: 'shadow: declaration of "(err|ctx)" shadows declaration at'
+ linters: [ govet ]
\ No newline at end of file
diff --git a/.goreleaser.yml b/.goreleaser.yml
new file mode 100644
index 00000000..8ca7cf81
--- /dev/null
+++ b/.goreleaser.yml
@@ -0,0 +1,95 @@
+# Make sure to check the documentation at https://goreleaser.com
+
+version: 1
+
+env:
+ - REPO_URL=https://github.com/haveachin/infrared
+ - DOCKER_IMAGE_NAME=haveachin/infrared
+
+before:
+ hooks:
+ - go mod tidy
+
+builds:
+ - main: ./cmd/infrared
+ env:
+ - CGO_ENABLED=0
+ binary: infrared
+ goos:
+ - linux
+ - windows
+ - darwin
+
+archives:
+ - format: tar.gz
+ # this name template makes the OS and Arch compatible with the results of `uname`.
+ name_template: >-
+ {{ .ProjectName }}_
+ {{- title .Os }}_
+ {{- if eq .Arch "amd64" }}x86_64
+ {{- else if eq .Arch "386" }}i386
+ {{- else }}{{ .Arch }}{{ end }}
+ {{- if .Arm }}v{{ .Arm }}{{ end }}
+ # use zip for windows archives
+ format_overrides:
+ - goos: windows
+ format: zip
+
+dockers:
+ - image_templates:
+ - "docker.io/{{ .Env.DOCKER_IMAGE_NAME }}:{{ .Version }}-amd64"
+ - "docker.io/{{ .Env.DOCKER_IMAGE_NAME }}:latest-amd64"
+ - "ghcr.io/{{ .Env.DOCKER_IMAGE_NAME }}:{{ .Version }}-amd64"
+ - "ghcr.io/{{ .Env.DOCKER_IMAGE_NAME }}:latest-amd64"
+ use: buildx
+ dockerfile: build/packages/Dockerfile.goreleaser
+ build_flag_templates:
+ - "--pull"
+ - "--platform=linux/amd64"
+ - "--label=org.opencontainers.image.created={{ .Date }}"
+ - "--label=org.opencontainers.image.title={{ .ProjectName }}"
+ - "--label=org.opencontainers.image.revision={{ .FullCommit }}"
+ - "--label=org.opencontainers.image.version={{ .Version }}"
+ - "--label=org.opencontainers.image.source={{ .Env.REPO_URL }}"
+ - image_templates:
+ - "docker.io/{{ .Env.DOCKER_IMAGE_NAME }}:{{ .Version }}-arm64v8"
+ - "docker.io/{{ .Env.DOCKER_IMAGE_NAME }}:latest-arm64v8"
+ - "ghcr.io/{{ .Env.DOCKER_IMAGE_NAME }}:{{ .Version }}-arm64v8"
+ - "ghcr.io/{{ .Env.DOCKER_IMAGE_NAME }}:latest-arm64v8"
+ use: buildx
+ goarch: arm64
+ dockerfile: build/packages/Dockerfile.goreleaser
+ build_flag_templates:
+ - "--pull"
+ - "--platform=linux/arm64/v8"
+ - "--label=org.opencontainers.image.created={{ .Date }}"
+ - "--label=org.opencontainers.image.title={{ .ProjectName }}"
+ - "--label=org.opencontainers.image.revision={{ .FullCommit }}"
+ - "--label=org.opencontainers.image.version={{ .Version }}"
+ - "--label=org.opencontainers.image.source={{ .Env.REPO_URL }}"
+
+docker_manifests:
+ - name_template: "{{ .Env.DOCKER_IMAGE_NAME }}:{{ .Version }}"
+ image_templates:
+ - "{{ .Env.DOCKER_IMAGE_NAME }}:{{ .Version }}-amd64"
+ - "{{ .Env.DOCKER_IMAGE_NAME }}:{{ .Version }}-arm64v8"
+ - name_template: "{{ .Env.DOCKER_IMAGE_NAME }}:latest"
+ image_templates:
+ - "{{ .Env.DOCKER_IMAGE_NAME }}:latest-amd64"
+ - "{{ .Env.DOCKER_IMAGE_NAME }}:latest-arm64v8"
+ - name_template: "ghcr.io/{{ .Env.DOCKER_IMAGE_NAME }}:{{ .Version }}"
+ image_templates:
+ - "ghcr.io/{{ .Env.DOCKER_IMAGE_NAME }}:{{ .Version }}-amd64"
+ - "ghcr.io/{{ .Env.DOCKER_IMAGE_NAME }}:{{ .Version }}-arm64v8"
+ - name_template: "ghcr.io/{{ .Env.DOCKER_IMAGE_NAME }}:latest"
+ image_templates:
+ - "ghcr.io/{{ .Env.DOCKER_IMAGE_NAME }}:latest-amd64"
+ - "ghcr.io/{{ .Env.DOCKER_IMAGE_NAME }}:latest-arm64v8"
+
+changelog:
+ sort: asc
+ filters:
+ exclude:
+ - "^docs:"
+ - "^test:"
+ - "^chore:"
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000..3427c012
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,45 @@
+# Contributing
+
+Feel free to add or modify the source code. On GitHub the best way of doing this is by forking this repository, then cloning your fork with Git to your local system. After adding or modifying the source code, push it back to your fork and open a pull request in this repository.
+
+If you can't contribute by adding or modifying the source code, then you might be able to reach out to someone who can.
+You can also contribute indirectly by donation.
+
+## Tools
+
+- Coding
+ - [Go](https://go.dev/)
+ - [GNUMake](https://www.gnu.org/software/make/) (Optional)
+ - [Docker](https://www.docker.com/get-started/) (Optional)
+ - [golangci-lint](https://golangci-lint.run/) (Optional)
+- Docs
+ - [Node.js](https://nodejs.org/)
+
+
+## Contributing
+
+TL;DR
+
+- [Project Layout](https://github.com/golang-standards/project-layout) - where it makes sense.
+- [Code Style](https://github.com/uber-go/guide/blob/master/style.md) - where it makes sense.
+- [Commit Messages](https://www.conventionalcommits.org/en/v1.0.0/) - only the summary is good enough.
+- [Versioning](https://semver.org/)
+
+### Project Layout
+
+We try to use [golang-standards/project-layout](https://github.com/golang-standards/project-layout) as a reference. This should give Infrared a good foundation to grow on.
+
+### Commit Messages
+
+When contributing to this project please follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
+specification for writing commit messages, so that changelogs and release versions can be generated automatically.
+
+Examples can be found here: https://www.conventionalcommits.org/en/v1.0.0/#examples
+
+Some tooling that can help you author those commit messages are the following plugins:
+
+- JetBrains Plugin [Conventional Commit](https://plugins.jetbrains.com/plugin/13389-conventional-commit)
+ by [Edoardo Luppi](https://github.com/lppedd)
+- Visual Studio Code
+ Plugin [Conventional Commits](https://marketplace.visualstudio.com/items?itemName=vivaxy.vscode-conventional-commits)
+ by [vivaxy](https://marketplace.visualstudio.com/publishers/vivaxy)
\ No newline at end of file
diff --git a/Dockerfile b/Dockerfile
deleted file mode 100644
index e4387afc..00000000
--- a/Dockerfile
+++ /dev/null
@@ -1,12 +0,0 @@
-FROM golang:1.16.0-buster AS builder
-LABEL stage=intermediate
-COPY . /infrared
-WORKDIR /infrared/cmd/infrared
-ENV GO111MODULE=on
-RUN CGO_ENABLED=1 GOOS=linux GOARCH=amd64 go build -a --installsuffix cgo -v -tags netgo -ldflags '-extldflags "-static"' -o /main .
-
-FROM scratch
-LABEL maintainer="Hendrik Jonas Schlehlein "
-WORKDIR /
-COPY --from=builder /main ./
-ENTRYPOINT [ "./main" ]
\ No newline at end of file
diff --git a/LICENSE b/LICENSE
index 261eeb9e..be3f7b28 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,201 +1,661 @@
- 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 [yyyy] [name of copyright owner]
-
- 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.
+ GNU AFFERO GENERAL PUBLIC LICENSE
+ Version 3, 19 November 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc.
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU Affero General Public License is a free, copyleft license for
+software and other kinds of works, specifically designed to ensure
+cooperation with the community in the case of network server software.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+our General Public Licenses are intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+ Developers that use our General Public Licenses protect your rights
+with two steps: (1) assert copyright on the software, and (2) offer
+you this License which gives you legal permission to copy, distribute
+and/or modify the software.
+
+ A secondary benefit of defending all users' freedom is that
+improvements made in alternate versions of the program, if they
+receive widespread use, become available for other developers to
+incorporate. Many developers of free software are heartened and
+encouraged by the resulting cooperation. However, in the case of
+software used on network servers, this result may fail to come about.
+The GNU General Public License permits making a modified version and
+letting the public access it on a server without ever releasing its
+source code to the public.
+
+ The GNU Affero General Public License is designed specifically to
+ensure that, in such cases, the modified source code becomes available
+to the community. It requires the operator of a network server to
+provide the source code of the modified version running there to the
+users of that server. Therefore, public use of a modified version, on
+a publicly accessible server, gives the public access to the source
+code of the modified version.
+
+ An older license, called the Affero General Public License and
+published by Affero, was designed to accomplish similar goals. This is
+a different license, not a version of the Affero GPL, but Affero has
+released a new version of the Affero GPL which permits relicensing under
+this license.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU Affero General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Remote Network Interaction; Use with the GNU General Public License.
+
+ Notwithstanding any other provision of this License, if you modify the
+Program, your modified version must prominently offer all users
+interacting with it remotely through a computer network (if your version
+supports such interaction) an opportunity to receive the Corresponding
+Source of your version by providing access to the Corresponding Source
+from a network server at no charge, through some standard or customary
+means of facilitating copying of software. This Corresponding Source
+shall include the Corresponding Source for any work covered by version 3
+of the GNU General Public License that is incorporated pursuant to the
+following paragraph.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the work with which it is combined will remain governed by version
+3 of the GNU General Public License.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU Affero General Public License from time to time. Such new versions
+will be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU Affero General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU Affero General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU Affero General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+
+ Copyright (C)
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Affero General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU Affero General Public License for more details.
+
+ You should have received a copy of the GNU Affero General Public License
+ along with this program. If not, see .
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If your software can interact with users remotely through a computer
+network, you should also make sure that it provides a way for users to
+get its source. For example, if your program is a web application, its
+interface could display a "Source" link that leads users to an archive
+of the code. There are many ways you could offer source, and different
+solutions will be better for different programs; see section 13 for the
+specific requirements.
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU AGPL, see
+.
diff --git a/Makefile b/Makefile
new file mode 100644
index 00000000..43567afb
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,33 @@
+.PHONY: docs
+
+test:
+ go test -race -timeout 10s ./...
+
+build:
+ CGO_ENABLED=0 go build -ldflags "-s -w" -o ./out/infrared ./cmd/infrared
+
+all: test build
+
+run: build
+ ./out/infrared -w .dev/infrared
+
+bench:
+ go test -bench=. -run=x -benchmem -memprofile mem.prof -cpuprofile cpu.prof -benchtime=10s > 0.bench
+ go tool pprof cpu.prof
+
+dev:
+ docker compose -f deployments/docker-compose.dev.yml -p infrared up --force-recreate --remove-orphans
+
+dos:
+ CGO_ENABLED=0 go build -ldflags "-s -w" -o ./out/dos ./tools/dos
+ ./out/dos
+
+malpk:
+ CGO_ENABLED=0 go build -ldflags "-s -w" -o ./out/malpk ./tools/malpk
+ ./out/malpk
+
+docs:
+ cd ./docs && npm i && npm run docs:dev
+
+lint:
+ golangci-lint run
diff --git a/README.md b/README.md
index fcf4a3ac..155118b7 100644
--- a/README.md
+++ b/README.md
@@ -1,319 +1,74 @@
+
+> [!WARNING]
+> Infrared is currently under active development: breaking changes can happen.
+> Feedback and contributions are welcome.
+
+An ultra lightweight Minecraft reverse proxy and status placeholder:
Ever wanted to have only one exposed port on your server for multiple Minecraft servers?
Then Infrared is the tool you need!
-Infrared works as a reverse proxy using a subdomain to connect clients to a specific Minecraft server.
-It works similar to Nginx for those of you who are familiar.
+Infrared works as a reverse proxy using a sub-/domains to connect clients to a specific Minecraft server.
## Features
-- [x] Reverse Proxy
-- [x] Display Placeholder Server
-- [x] Autostart Server when pinged
-- [x] Logger Callback URLs
-- [x] HAProxy Protocol Support
-- [x] TCPShield/RealIP Protocol Support
-- [X] Prometheus Support
-- [X] REST API
-
-## Deploy
-
-```shell script
-$ docker build --no-cache -t haveachin/infrared:latest https://github.com/haveachin/infrared.git &&
- docker image prune -f --filter label=stage=intermediate &&
- docker run -d --name infrared --restart=unless-stopped -it -v /usr/local/infrared/configs/:/configs -p 25565:25565/tcp --expose 25565 haveachin/infrared:latest
-```
-
-## Update
-
-```shell script
-$ docker build --no-cache -t haveachin/infrared:latest https://github.com/haveachin/infrared.git &&
- docker image prune -f --filter label=stage=intermediate &&
- docker stop infrared &&
- docker rm infrared &&
- docker run -d --name infrared --restart=unless-stopped -it -v /usr/local/infrared/configs/:/configs -p 25565:25565/tcp --expose 25565 haveachin/infrared:latest
-```
-
-## Environment Variables
-
-**Info**: Command-line flags override environment variables.
-
-`INFRARED_CONFIG_PATH` is the path to all your server configs [default: `"./configs/"`]
-`INFRARED_RECEIVE_PROXY_PROTOCOL` if Infrared should be able to receive proxy protocol [default: `"false"`]
-
-`INFRARED_API_ENABLED` if the api should be enabled [default: `"false"`]\
-`INFRARED_API_BIND` change the http bind option [default: `"127.0.0.1:8080"`]
-
-`INFRARED_PROMETHEUS_ENABLED` enables the Prometheus stats exporter [default: `"false"`]\
-`INFRARED_PROMETHEUS_BIND` specifies what the Prometheus HTTP server should bind to [default: `":9100"`]
-
-## Command-Line Flags
-
-`-config-path` specifies the path to all your server configs [default: `"./configs/"`]
-
-`-receive-proxy-protocol` if Infrared should be able to receive proxy protocol [default: `false`]
-
-`-enable-prometheus` enables the Prometheus stats exporter [default: `false`]
-
-`-prometheus-bind` specifies what the Prometheus HTTP server should bind to [default: `:9100`]
-
-### Example Usage
-
-`./infrared -config-path="." -receive-proxy-protocol=true -enable-prometheus -prometheus-bind="localhost:9123"`
-
-## Proxy Config
-| Field Name | Type | Required | Default | Description |
-|-------------------|---------|----------|------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| domainName | String | true | localhost | Should be [fully qualified domain name](https://en.wikipedia.org/wiki/Domain_name). Note: Every string is accepted. So `localhost` is also valid. |
-| listenTo | String | true | :25565 | The address (usually just the port; so short term `:port`) that the proxy should listen to for incoming connections. Accepts basically every address format you throw at it. Valid examples: `:25565`, `localhost:25565`, `0.0.0.0:25565`, `127.0.0.1:25565`, `example.de:25565` |
-| proxyTo | String | true | | The address that the proxy should send incoming connections to. Accepts Same formats as the `listenTo` field. |
-| proxyBind | String | false | | The local IP that is being used to dail to the server on `proxyTo`. (Same as Nginx `proxy-bind`) |
-| disconnectMessage | String | false | Sorry {{username}}, but the server is offline. | The message a client sees when he gets disconnected from Infrared due to the server on `proxyTo` won't respond. Currently available placeholders: - `username` the username of player that tries to connect - `now` the current server time - `remoteAddress` the address of the client that tries to connect - `localAddress` the local address of the server - `domain` the domain of the proxy (same as `domainName`) - `proxyTo` the address that the proxy proxies to (same as `proxyTo`) - `listenTo` the address that Infrared listens on (same as `listenTo`) |
-| timeout | Integer | true | 1000 | The time in milliseconds for the proxy to wait for a ping response before the host (the address you proxyTo) will be declared as offline. This "online check" will be resend for every new connection. |
-| spoofForcedHost | String | false | | If Infrared should modify the handshake packet to spoof BungeeCords forced_hosts option. |
-| proxyProtocol | Boolean | false | false | If Infrared should use HAProxy's Proxy Protocol for IP **forwarding**. Warning: You should only ever set this to true if you now that the server you `proxyTo` is compatible. |
-| realIp | Boolean | false | false | If Infrared should use TCPShield/RealIP Protocol for IP **forwarding**. Warning: You should only ever set this to true if you now that the server you `proxyTo` is compatible. |
-| docker | Object | false | See [Docker](#Docker) | Optional Docker configuration to automatically start a container and stop it again if unused. Note: Infrared will not take direct connections into account. Be sure to route all traffic that connects to the container through Infrared. |
-| onlineStatus | Object | false | | This is the response that Infrared will give when a client asks for the server status and the server is online. |
-| offlineStatus | Object | false | See [Response Status](#response-status) | This is the response that Infrared will give when a client asks for the server status and the server is offline. |
-| callbackServer | Object | false | See [Callback Server](#callback-server) | Optional callback server configuration to send events as a POST request to a specified URL. |
-
-### Docker
-
-| Field Name | Type | Required | Default | Description |
-|---------------|--------|----------|------------|-----------------------------------------------------------------------------|
-| dnsServer | String | false | 127.0.0.11 | The address of the DNS that resolves the container names. |
-| containerName | String | true | | The name of the container that should be automatically started/stopped. |
-| portainer | Object | false | | Optional [Portainer](#Portainer) configuration for authorization management.|
-
-#### Portainer
-
-More info on [Portainer](https://www.portainer.io/).
-
-| Field Name | Type | Required | Default | Description |
-|------------|--------|----------|---------|-------------------------------------------------------------------------------|
-| address | String | true | | URL of the Portainer instance. |
-| endpointId | String | true | | The ID typically an integer of the docker endpoint in the portainer instance. |
-| username | String | true | | Username for the Portainer user. |
-| password | String | true | | Password for the Portainer user. |
-
-### Response Status
-
-| Field Name | Type | Required | Default | Description |
-|----------------|---------|----------|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------|
-| versionName | String | false | Infrared 1.18 | The version name of the Minecraft Server. |
-| protocolNumber | Integer | true | 757 | The protocol version number. |
-| maxPlayers | Integer | false | 20 | The maximum number of players that can join the server. Note: Infrared will not limit more players from joining. This number is just for display. |
-| playersOnline | Integer | false | 0 | The number of online players. Note: Infrared will not that this number is also just for display. |
-| playerSamples | Array | false | | An array of player samples. See [Player Sample](#Player Sample). |
-| iconPath | String | false | | The path to the server icon. |
-| motd | String | false | | The motto of the day, short MOTD. |
-
-#### Player Sample
-
-| Field Name | Type | Required | Default | Description |
-|------------|--------|----------|---------|-------------------------|
-| Name | String | true | | Username of the player. |
-| uuid | String | false | | UUID of the player. |
-
-### Callback Server
-
-| Field Name | Type | Required | Default | Description |
-|------------|--------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| url | String | true | | URL of the callback server URL. |
-| events | Array | true | | A string array of event names. Currently available event names are: - `Error` will send error logs - `PlayerJoin` will send player joins - `PlayerLeave` will send player leaves - `ContainerStart` will send container starts - `ContainerStop` will send container stops |
-
-### Examples
+- [X] Reverse Proxy
+ - [X] Wildcards Support
+ - [X] Multi-Domain Support
+- [X] Status Response Caching
+- [X] Proxy Protocol Support
+- [X] Ratelimiter
-#### Minimal Config
+## Useful Links
-
-min.example.com
+- **[Docs](https://infrared.dev)**
+- **[Ask Questions](https://github.com/haveachin/infrared/discussions)**
+- [Latest Release](https://github.com/haveachin/infrared/releases/latest)
+- [Discord Invite](https://discord.gg/r98YPRsZAx)
+- [Contributing](CONTRIBUTING.md)
-```json
-{
- "domainName": "mc.example.com",
- "proxyTo": ":8080"
-}
-```
-
-
-
-#### Full Config
-
-
-full.example.com
-
-```json
-{
- "domainName": "mc.example.com",
- "listenTo": ":25565",
- "proxyTo": ":8080",
- "proxyBind": "0.0.0.0",
- "proxyProtocol": false,
- "realIp": false,
- "timeout": 1000,
- "disconnectMessage": "Username: {{username}}\nNow: {{now}}\nRemoteAddress: {{remoteAddress}}\nLocalAddress: {{localAddress}}\nDomain: {{domain}}\nProxyTo: {{proxyTo}}\nListenTo: {{listenTo}}",
- "docker": {
- "dnsServer": "127.0.0.11",
- "containerName": "mc",
- "timeout": 30000,
- "portainer": {
- "address": "localhost:9000",
- "endpointId": "1",
- "username": "admin",
- "password": "foobar"
- }
- },
- "onlineStatus": {
- "versionName": "1.18",
- "protocolNumber": 757,
- "maxPlayers": 20,
- "playersOnline": 2,
- "playerSamples": [
- {
- "name": "Steve",
- "uuid": "8667ba71-b85a-4004-af54-457a9734eed7"
- },
- {
- "name": "Alex",
- "uuid": "ec561538-f3fd-461d-aff5-086b22154bce"
- }
- ],
- "motd": "Join us!"
- },
- "offlineStatus": {
- "versionName": "1.18",
- "protocolNumber": 757,
- "maxPlayers": 20,
- "playersOnline": 0,
- "motd": "Server is currently offline"
- },
- "callbackServer": {
- "url": "https://mc.example.com/callback",
- "events": [
- "Error",
- "PlayerJoin",
- "PlayerLeave",
- "ContainerStart",
- "ContainerStop"
- ]
- }
-}
-```
-
-
-
-## Rest API
-
-**The API should not be accessible from the internet!**
+## Build
-### Enabling API
+Requirements:
+- [Go](https://go.dev/) 1.21+
-To enable the API the environment variable `INFRARED_API_ENABLED` must be set to `"true"`. To change the http bind, set
-the env variable `INFRARED_API_BIND` to something like `"0.0.0.0:3000"` the default value is `"127.0.0.1:8080"`
-
-### API Methods
-
-#### Create new config
-
-POST `/proxies`\
-Body must contain:
-```json
-{
-"domainName": "mc.example.com",
-"proxyTo": ":8080"
-}
```
-But all values (like in a normal config file) can be set.
-
-The API then will create a file with the name of the domain (if the file exists it will be overwritten) and write the body to it. The proxy can now be visited.
-
------
-POST `/proxies/{fileName}`\
-Body must contain:
-```json
-{
-"domainName": "mc.example.com",
-"proxyTo": ":8080"
-}
+CGO_ENABLED=0 go build -ldflags "-s -w" -o ./out/infrared ./cmd/infrared
```
-But all values (like in a normal config file) can be set.
-
-The server will create a file with the given filename (if the file exists it will be overwritten) and store the config in it.
-
-
-### Remove config
-DELETE `/proxies/{fileName}`\
-Replace `:file` with the name of the proxy configuration file.
-
-If the file was found it will be unloaded and deleted. Open connections do not close, but no new player can connect anymore.
+or `make all` (requires GNU Make). The binary is in the `out/` directory.
-## Prometheus exporter
-The built-in prometheus exporter can be used to view metrics about infrareds operation.
-When the command line flag `-enable-prometheus` is enabled it will bind to `:9100` by default, if you would like to use another port or use an application like [node_exporter](https://github.com/prometheus/node_exporter) that also uses port 9100 on the same machine you can change the port with the `-prometheus-bind` command line flag, example: `-prometheus-bind=":9070"`.
-It is recommended to firewall the prometheus exporter with an application like *ufw* or *iptables* to make it only accessible by your own Prometheus instance.
-### Prometheus configuration:
-Example prometheus.yml configuration:
-```yaml
-scrape_configs:
- - job_name: infrared
- static_configs:
- - targets: ['infrared-exporter-hostname:port']
-```
-
-### Metrics:
-* infrared_connected: show the amount of connected players per instance and proxy:
- * **Example response:** `infrared_connected{host="proxy.example.com",instance="vps1.example.com:9070",job="infrared"} 10`
- * **host:** listenTo domain as specified in the infrared configuration.
- * **instance:** what infrared instance the amount of players are connected to.
- * **job:** what job was specified in the prometheus configuration.
-* infrared_proxies: show the amount of active infrared proxies:
- * **Example response:** `infrared_proxies{instance="vps1.example.com:9070",job="infrared"} 5`
- * **instance:** what infrared instance has that amount of active proxies.
- * **job:** what job was specified in the prometheus configuration.
-
-## Coding Guidelines
-
-### Commit Messages
-
-When contributing to this project please follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
-specification for writing commit messages, so that changelogs and release versions can be generated automatically.
-
-**Example commit message**
-
-```
-fix: prevent racing of requests
-
-Introduce a request id and a reference to latest request. Dismiss
-incoming responses other than from latest request.
-
-Remove timeouts which were used to mitigate the racing issue but are
-obsolete now.
-
-Reviewed-by: Z
-Refs: #123
-```
+## Similar Projects
-Some tooling that can help you author those commit messages are the following plugins:
+* https://github.com/itzg/mc-router
-* JetBrains Plugin [Conventional Commit](https://plugins.jetbrains.com/plugin/13389-conventional-commit)
- by [Edoardo Luppi](https://github.com/lppedd)
-* Visual Studio
- Plugin [Conventional Commits](https://marketplace.visualstudio.com/items?itemName=vivaxy.vscode-conventional-commits)
- by [vivaxy](https://marketplace.visualstudio.com/publishers/vivaxy)
+## Attributions
-## Similar Projects
+- [Free Software Foundation](https://commons.wikimedia.org/wiki/File:AGPLv3_Logo.svg), Public domain, via Wikimedia Commons
+- [Tnze/go-mc](https://github.com/Tnze/go-mc) 🚀, MIT
+- [IGLOU-EU/go-wildcard](https://github.com/IGLOU-EU/go-wildcard), Apache-2.0
+- [cespare/xxhash](https://github.com/cespare/xxhash), MIT
+- [google/uuid](https://github.com/google/uuid), BSD-3-Clause
+- [pires/go-proxyproto](https://github.com/pires/go-proxyproto), Apache-2.0
+- [spf13/pflag](https://github.com/spf13/pflag), BSD-3-Clause
+- [go-yaml/yaml](https://github.com/go-yaml/yaml), Apache-2.0, MIT
+- [vitepress](https://github.com/vuejs/vitepress), MIT
+- [tollbooth](https://github.com/didip/tollbooth), MIT
-* https://github.com/itzg/mc-router
+
+