IQSS / IQSS/dataverse

Add clear documentation in guides about blocking crucial API endpoints from the outside

Open
#12,050 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Component: Containers Feature: API Feature: API Guide Feature: Container Guide Feature: Installation Guide Size: 3 Type: Feature User Role: Sysadmin
Dominant language
Java
Stars
1.1k
Forks
564
Avg merge
2d 2h
Merged PRs (30d)
29

Description

Check and highlight for production setups in classic and/or containerized installations:

  1. Block /api/admin and /api/builtin-users in Dataverse with a policy
  2. Block these endpoints on the Reverse Proxy as well

Provide example snippets for this for Apache and NGINX (classic installations) as well as Traefik (Docker) and Ingress, Gateway API (Kubernetes).

This should be done in the Installation and Containerization Guides.

Contributor guide

Open the contributing guide

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 with the Installation and Containerization Guides and identify the sections covering classic and containerized production setups. Add example policies and reverse-proxy configurations for /api/admin and /api/builtin-users using Apache, NGINX, Traefik, Ingress, and Gateway API. Done means both guides clearly explain blocking these endpoints and include examples for each requested deployment style.

Written by the indexing model from the issue text.

Assessment

Tech stack
apache, docker, kubernetes, nginx
Domain
devops, documentation, infrastructure, security
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.