nginx-proxy / nginx-proxy/nginx-proxy

[Question/Docs] `vhost.d/example.com` examples and redirects

Open
#967 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
19.9k
Forks
3k
Avg merge
2d 11h
Merged PRs (30d)
1

Description

The examples for vhost configs for server/location blocks on the README only provide settings, they don't seem to explain much about intended content/blocks.

  • Are settings for server blocks only relevant?(LetsEncrypt companion seems to insert location blocks instead of using _location file)
  • Adding location blocks in example.com_location would be nested blocks presumably or only for settings for including into a default location block by nginx-proxy?
  • Do 301 redirects and other location blocks not belong in nginx-proxy, are they advised to be handled by each separate container frontend(nginx/apache/etc) instead? If so any reason why?(while not better isolated, using nginx-proxy keeps the related configs in a consistent format and location without additional hassle of modifying various thirdparty nginx/apache configs to accomodate the inclusions), perhaps in some setups, this doesn't work well with the vhost container?
  • Is there a reason that multiple files or symlinks need to be created for a container with multiple vhost values? An env var to have nginx-proxy symlink all vhost to a config wouldn't make sense?

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 with the README examples for server and location blocks, then inspect the documented vhost.d/example.com and example.com_location conventions. Compare those examples with the LetsEncrypt companion behavior described in the issue and determine which questions can be answered from existing generated configuration. Done means clarifying the intended block contents, redirects, and multi-vhost setup in the documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, nginx
Domain
devops, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.