openreplay / openreplay/documentation

Please add the full-online requirement / warning for installation steps

Open Beginner friendly
#231 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
MDX
Stars
16
Forks
23
Avg merge
39m
Merged PRs (30d)
3

Description

Hi,

After spending a weekend trying to figure out why is my brand new installation of OpenReplay v1.23 failing to setup correctly on AWS EC2 Ubuntu 22 LTS, I have learned the hard way that OpenReplay requires full internet access both ways or otherwise it hangs on /api/health checks and returns error 502, restarting chalice in the process.

So, if you are installing OpenReplay on an air-gapped of firewalled machine, expect this error to happen.

Yes, of course, nobody can run OpenReplay in production like that, that's true, but it is also true that many servers, while they are being provisioned are air-gapped/firewalled for the first few hours.

Hence, please add to the documentation here and here a section/warning about OpenReplay requiring outside connectivity.

Mentioned in the issues: #3945 and #2934 and #2151.

Thanks.

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 AWS deployment and deployment-issues documentation pages linked in the issue, then review the referenced issues #3945, #2934, and #2151 for context. Add a clear warning about the connectivity requirement to both pages, and consider the work done when installers can find that warning in each relevant location.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, ubuntu
Domain
cloud, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
Half a day
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.