vaadin / vaadin/docs

Create instructions for serving static files from reverse proxy

Open
#4,708 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

flow
Dominant language
AsciiDoc
Stars
38
Forks
225
Avg merge
1d 4h
Merged PRs (30d)
170

Description

Serving static files (like the generated front-end bundle) directly from reverse proxy or from a server designed primarily for serving files is faster and saves resources from the actual application server to more meaningful actions. This can be meaningful especially if a lot of users enter the application at the same time (and they will all request a "number of files").

This page could have a section for it:

https://vaadin.com/docs/latest/flow/production/reverse-proxy

In most simplest form we could just list which files from the artifact to move to apache/nginx/... or we could even provide an example buildstep as a basis for deployment automation (copies relevant files).

Listing "static content" would also help people to configure modern "smart proxies" (clouldflare etc) so that they could event geo-loadbalance those.

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 reverse-proxy page at https://vaadin.com/docs/latest/flow/production/reverse-proxy and review how its deployment guidance is structured. Document which artifact files can be served by Apache or nginx, and consider whether an example buildstep is appropriate. Done means the page explains the static-content setup clearly enough to support reverse proxies and smart proxies.

Written by the indexing model from the issue text.

Assessment

Tech stack
apache, nginx
Domain
devops, documentation, infrastructure
Issue type
Documentation
Difficulty
2/5
Estimated time
Half a day
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.