Sfoglia il codice sorgente

RemoteIp module name

1668/default-disable-prometheus
Alexander Strizhakov 3 anni fa
parent
commit
3be8ab5103
Non sono state trovate chiavi note per questa firma nel database ID Chiave GPG: 22896A53AEF1381
8 ha cambiato i file con 11 aggiunte e 11 eliminazioni
  1. +1
    -1
      config/config.exs
  2. +2
    -2
      config/description.exs
  3. +1
    -1
      config/test.exs
  4. +3
    -3
      docs/configuration/cheatsheet.md
  5. +1
    -1
      lib/pleroma/web/endpoint.ex
  6. +1
    -1
      lib/pleroma/web/plugs/remote_ip.ex
  7. +1
    -1
      test/pleroma/web/plugs/rate_limiter_test.exs
  8. +1
    -1
      test/pleroma/web/plugs/remote_ip_test.exs

+ 1
- 1
config/config.exs Vedi File

@@ -677,7 +677,7 @@ config :pleroma, :rate_limit,

config :pleroma, Pleroma.Workers.PurgeExpiredActivity, enabled: true, min_lifetime: 600

config :pleroma, Pleroma.Plugs.RemoteIp,
config :pleroma, Pleroma.Web.Plugs.RemoteIp,
enabled: true,
headers: ["x-forwarded-for"],
proxies: [],


+ 2
- 2
config/description.exs Vedi File

@@ -3250,10 +3250,10 @@ config :pleroma, :config_description, [
},
%{
group: :pleroma,
key: Pleroma.Plugs.RemoteIp,
key: Pleroma.Web.Plugs.RemoteIp,
type: :group,
description: """
`Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
`Pleroma.Web.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
**If your instance is not behind at least one reverse proxy, you should not enable this plug.**
""",
children: [


+ 1
- 1
config/test.exs Vedi File

@@ -113,7 +113,7 @@ config :pleroma, Pleroma.Gun, Pleroma.GunMock

config :pleroma, Pleroma.Emails.NewUsersDigestEmail, enabled: true

config :pleroma, Pleroma.Plugs.RemoteIp, enabled: false
config :pleroma, Pleroma.Web.Plugs.RemoteIp, enabled: false

config :pleroma, Pleroma.Web.ApiSpec.CastAndValidate, strict: true



+ 3
- 3
docs/configuration/cheatsheet.md Vedi File

@@ -416,12 +416,12 @@ This will make Pleroma listen on `127.0.0.1` port `8080` and generate urls start
* ``referrer_policy``: The referrer policy to use, either `"same-origin"` or `"no-referrer"`.
* ``report_uri``: Adds the specified url to `report-uri` and `report-to` group in CSP header.

### Pleroma.Plugs.RemoteIp
### Pleroma.Web.Plugs.RemoteIp

!!! warning
If your instance is not behind at least one reverse proxy, you should not enable this plug.

`Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
`Pleroma.Web.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.

Available options:

@@ -434,7 +434,7 @@ Available options:
### :rate_limit

!!! note
If your instance is behind a reverse proxy ensure [`Pleroma.Plugs.RemoteIp`](#pleroma-plugs-remoteip) is enabled (it is enabled by default).
If your instance is behind a reverse proxy ensure [`Pleroma.Web.Plugs.RemoteIp`](#pleroma-plugs-remoteip) is enabled (it is enabled by default).

A keyword list of rate limiters where a key is a limiter name and value is the limiter configuration. The basic configuration is a tuple where:



+ 1
- 1
lib/pleroma/web/endpoint.ex Vedi File

@@ -122,7 +122,7 @@ defmodule Pleroma.Web.Endpoint do
extra: extra
)

plug(Pleroma.Plugs.RemoteIp)
plug(Pleroma.Web.Plugs.RemoteIp)

defmodule Instrumenter do
use Prometheus.PhoenixInstrumenter


+ 1
- 1
lib/pleroma/web/plugs/remote_ip.ex Vedi File

@@ -2,7 +2,7 @@
# Copyright © 2017-2020 Pleroma Authors <https://pleroma.social/>
# SPDX-License-Identifier: AGPL-3.0-only

defmodule Pleroma.Plugs.RemoteIp do
defmodule Pleroma.Web.Plugs.RemoteIp do
@moduledoc """
This is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
"""


+ 1
- 1
test/pleroma/web/plugs/rate_limiter_test.exs Vedi File

@@ -19,7 +19,7 @@ defmodule Pleroma.Web.Plugs.RateLimiterTest do

describe "config" do
@limiter_name :test_init
setup do: clear_config([Pleroma.Plugs.RemoteIp, :enabled])
setup do: clear_config([Pleroma.Web.Plugs.RemoteIp, :enabled])

test "config is required for plug to work" do
Config.put([:rate_limit, @limiter_name], {1, 1})


+ 1
- 1
test/pleroma/web/plugs/remote_ip_test.exs Vedi File

@@ -6,7 +6,7 @@ defmodule Pleroma.Web.Plugs.RemoteIpTest do
use ExUnit.Case
use Plug.Test

alias Pleroma.Plugs.RemoteIp
alias Pleroma.Web.Plugs.RemoteIp

import Pleroma.Tests.Helpers, only: [clear_config: 2]



Loading…
Annulla
Salva