Docs for Key rewrite show invalid example with bucket prefix

[JuroOravec]

Description

The docs for key rewrite suggest the following:

Given this config:

targets:
  - name: test
    # ...
    keyRewriteList:
      - source: ^/file.html$
        target: /redirected/file.html
    bucket:
      # ...
      prefix: "/folder1"

Then GET /file.html should be rewritten to GET /folder1/redirected/file.html.

HOWEVER, it seems that currently, the source regex MUST account also for the prefix.

So, to redirect from /file.html to /folder1/redirected/file.html, given a bucket prefix /folder1, we need to do:

targets:
  - name: test
    # ...
    keyRewriteList:
      - source: ^/folder1/file.html$
        target: /folder1/redirected/file.html
    bucket:
      # ...
      prefix: "/folder1"

The reason for this is because in the code, currently the logic to get the full path including the prefix is called BEFORE the regex matching logic. See

s3-proxy/pkg/s3-proxy/bucket/bucket-req-impl.go

Line 131 in 8f1e39b

key := bri.generateStartKey(input.RequestPath)

Describe the solution you'd like

Update the docs to include the correct examples.

[oxyno-zeta]

Hello,

Thanks for this issue. Yes, documentation is wrong and must be updated.

Oxyno-zeta

[github-actions]

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 10 days

[JuroOravec]

Not stale

[oxyno-zeta]

I've fixed the documentation. Thanks for the issue !