Skip to content
This repository has been archived by the owner on Oct 6, 2022. It is now read-only.

Create best practices documentation #393

Closed
AVGP opened this issue May 7, 2020 · 2 comments
Closed

Create best practices documentation #393

AVGP opened this issue May 7, 2020 · 2 comments
Labels
Docs Issues related to documentation good first issue Good issue to begin contributing to Rendertron help wanted

Comments

@AVGP
Copy link
Collaborator

AVGP commented May 7, 2020

Right now, there is no "docs/best_practices.md" file.
Create this file and describe the best practices for running Rendertron. Some to get started:

  • Run Rendertron behind a firewall or proxy with authentication, because it does not provide an authentication layer.
  • Enable caching to speed up the response times
  • Regularly pre-warm the cache by requesting a render for your most important URLs to make sure that bots get a quick response
@AVGP AVGP added help wanted good first issue Good issue to begin contributing to Rendertron Docs Issues related to documentation labels May 7, 2020
@hheexx
Copy link

hheexx commented Jul 12, 2020

I recommend running rendertron at reverse proxy level, not using middleware.
Because if you use it as middleware and you have reverse proxy in front of it you can not cache pages without having bot detection logic in reverse proxy. If you have bot detection logic in reverse proxy then it makes sense to have it only there for clear separation of concerns. Duplicate code is always pain.

Comments?

we should add link in readme to good nginx config for example this one https://gist.github.com/justindavies/7421d1f112f5c1b606dd27f4fcd8a856#file-nginx-rendertron-conf

@AVGP
Copy link
Collaborator Author

AVGP commented Jul 13, 2020

We do have new docs coming - you can take a look at it in the docs folder.
That contains an nginx example and I'd love to see if you have improvements to that :)

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Docs Issues related to documentation good first issue Good issue to begin contributing to Rendertron help wanted
Projects
None yet
Development

No branches or pull requests

2 participants