restic / restic/rest-server

Make /metrics available without authentication or give the option for metrics-only usernames

Open
#116 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
1.5k
Forks
178
Avg merge
15d 9h
Merged PRs (30d)
2

Description

Output of rest-server --version

rest-server manually compiled with go1.14.7 on linux/amd64
https://github.com/restic/rest-server/commit/84b6955260d9cbaa9b5b7e1cdde76d1c45a131ed

What should rest-server do differently?

A possible solution could be a parameter making /metrics completely public even when authentication is enabled. Another solution would be a parameter that specifies a username that should only be allowed to access /metrics and not store/read backups.

What are you trying to do? What is your use case?

I want to give a service read-only access to the metrics endpoint and avoid giving it more permissions than it needs to have for its purpose.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the /metrics endpoint and the authentication flow, then determine how public metrics access or metrics-only usernames should interact with backup permissions. Define which option is supported, document its configuration, and verify that metrics access works while unauthorized backup operations remain blocked.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
api, backend, observability
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.