Containers simple install instructions prevent Volto frontend access from remote hosts
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Domain
- documentation
Research direction
Update docs/install/containers/index.md, focusing on the Volto frontend start command using RAZZLE_API_PATH. Check the suggested hostname guidance against the linked forum background, and consider the documentation complete when remote-host browsers can reach the backend API using the container host's fully qualified hostname.
Written by the indexing model from the issue text.
Description
Plone Documentation versions affected
- 5.x
- 6.x
Description
In the current version of https://github.com/plone/documentation/blob/6-dev/docs/install/containers/index.md the command for starting the Volto frontend results in a frontend that malfunctions mysteriously for visits by browsers not running on the same host as the containers.
Specifically, RAZZLE_API_PATH=http://localhost:8080/Plone causes Volto code running in the browser to do API calls to the Plone backend running on localhost:8080, which is incorrect. The correct value would include the fully qualified domain name of the container host, which in many cases can be expressed as RAZZLE_API_PATH=http://$HOSTNAME:8080/Plone.
To provide for cases where the hostname on the container host is not properly configured with the fully qualified domain name, it would be helpful to include a bit of explanation suggesting checking that echo $HOSTNAME yields the fully qualified domain name, and if not then substitute for $HOSTNAME in the frontend start command.
For background on this issue, see my forum posting describing the problem and the specific and related measures that solved the problem: https://community.plone.org/t/need-help-solving-weird-plone-6-volto-frontend-problem/15829/7
- Dominant language
- Makefile
- Stars
- 106
- Forks
- 190
- Avg merge
- 3d 2h
- Merged PRs (30d)
- 1
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.
More from plone/documentation
-
Difficulty 1/5 Under an hour Newbie friendliness 62/100
plone/documentation#2077 · 1 comment ·
-
99 tag: sprint
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
plone/documentation#1336 · 9 comments ·
-
31 needs: help 41 lvl: easy 99 tag: good first issue 99 tag: hacktoberfest 99 tag: Plone 6.x dependencies
Difficulty 3/5 1-2 days Newbie friendliness 68/100
plone/documentation#2100 ·
-
plone/documentation#2076 · 1 assignee ·
-
33 needs: docs 41 lvl: easy 99 tag: good first issue 99 tag: hacktoberfest
Difficulty 3/5 1-2 days Newbie friendliness 55/100
plone/documentation#2065 · 8 comments · 1 reaction ·
All issues in plone/documentation
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
bancolombia/sentinel#22 ·
-
test md OpenCI
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
optimization optimization:agents-md-curator
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
githubnext/gh-aw-cao#13143 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 94/100
objectionary/hone-maven-plugin#1061 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
redhat-developer/rhdh-plugins#4887 · 2 comments ·