Add troubleshooting hints if frontend is accessed from another machine (not localhost) and missing CSS links in head
Nobody has claimed this yet.
- Dominant language
- Makefile
- Stars
- 106
- Forks
- 190
- Avg merge
- 3d 2h
- Merged PRs (30d)
- 1
Description
Links of affected pages in Plone Documentation, if any.
- Plone Documentation v6 / Admin Guide / Install Plone with Cookieplone
- Related Issue in the Cookieplone Project https://github.com/plone/cookieplone-templates/issues/348
Description
Challenge
After using make backend-start and make frontend-start successfully, accessing the frontend from another machine and not using localhost:3000 on the actual dev box, you may end up without CSS. The HTML source is missing the links to the CSS in the head section. There are some other pitfalls with the firewall that needs to be open for port 3000 and 3001 as well orif configured to a different port, a corresponding port+1.
Solution / Workaround for Development purposes
Start the frontend with the environment variable HOST=MyServerIP set to the IP or a qualified domain name.
Details are linked in the related Cookieplone ticket 52 also pointing to answers to this topic at community.plone.org
Suggestions
In the Cookieplone ticket 52 i describe an approach to avoid the trouble in advance and add the topic in the Cookieplone generated docs in the project.
This should be accompanied by a corresponding part in the main docs here and should be matching in wording, updated in sync and referencing each other in synchronously updated manner. Should be after https://6.docs.plone.org/install/create-project-cookieplone.html#start-plone as #troubleshooting-developer-access-from-other-ip or something else.
Other Aspects and places
- I am not sure which other install method are needing the same hints, when users run into this issue.
- Avoiding doubled efforts to keep this in one place and reference from the occurences would be nice, but explicit hints at every possible troublepoint are useful.
- Is it possible to completely avoid the issue without rising a security weakness?
- Could it be enough to print the hint to the HOST option during startup of the frontend in the last five lines?
I have currently no time to simplify this ticket further and offer a pull request ready solution for the docs at once. Any ideas or simpler approaches welcome.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with docs/install/create-project-cookieplone.md and the related Cookieplone issue 348. Check how the Cookieplone startup and troubleshooting guidance should be referenced from the main documentation, including HOST, ports 3000/3001, and access from another machine. Done means the relevant guidance is added with synchronized cross-references and an appropriate troubleshooting section.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100