swagger-api / swagger-api/swagger-ui

Allow include of extra Nginx configuration files to provide extra paths (i.e. health check paths)

Open
#6,891 1 comment 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
29k
Forks
9.3k
Avg merge
2d 23h
Merged PRs (30d)
25

Description

Content & configuration

OpenApiSpec is not relevant for this feature request. The only thing that is relevant, is the nginx.conf

Is your feature request related to a problem?

I'm unable to configure extra locations, such as health checks for the swaggerapi/swagger-ui Docker image.

Describe the solution you'd like

Add the following to the server section of nginx.conf:

server {
    ...
    include /etc/nginx/config.d/*.conf;
    ...
}

This allows for extra configurations to be provided by the user. Hence, it will also prevent path clashes, as that would be the responsibility of the user.

Describe alternatives you've considered

I'm currently overwriting the nginx.conf, as there's no other way for me provide extra locations.

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 by reading docker/nginx.conf, focusing on its server section and the existing configuration layout. Add support for including user-provided files from /etc/nginx/config.d/*.conf, then verify that the Docker image can provide extra locations such as health check paths without replacing nginx.conf.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, nginx
Domain
devops
Issue type
Feature
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.