documentaiton should include minimum cognitive requirements

Open
#1,027 5 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
linux, mysql
Domain
documentation, security

Research direction

Review the documentation at docs.streama-project.com/about/features/ alongside the streama-app repository and its public-URL requirement. Document the background knowledge, installation effort, connection options, domain or public-server implications, and security risks clearly enough for prospective users to assess whether Streama suits them.

Written by the indexing model from the issue text.

Description

Hello, I saw this project on alternative.to and was thinking of installing but it's difficult to know whether it is reasonable to embark on it given my existing skills. In terms of background knowledge, the documentation says

Easy Setup

On the other hand, this video
STREAMA: Host your own mini-Netflix using Linux says:

you'll also need a solid knowledge of Linux server administration particularly around HTTP concepts like reverse proxies we're going to get into that and a bit of port management

which I guess is "easy" to some people, but is far from universally agreed-upon.

It would be helpful to have a little bit of information about what sort of experience/knowledge is required, how much fiddling around is likely to be required, etc. I can copy/paste to the command line but there's no way I'm going to solve a mysql problem.

From reading the documentation, I can't actually tell, once I theoretically got this installed, how it would work to connect to a TV... I see there is another repo for an app which mentions it "requires a running streama service with a public url." Does that mean I need to buy an set up a domain name? And also that this application opens a server to the whole world? If that's the case I presume there are potential security issues. It makes me wonder if it would be a really bad idea to run on one's main desktop.

Anyway I don't need answers provided for all these questions. the main point is that it's useful for people like me to have a way of assessing how reasonable a project will be before starting it. and if a mismanaged installation could introduce security issues, or be anything other than a waste of time, that should be made extremely clear.

thank you for your time

Dominant language
JavaScript
Stars
9.8k
Forks
978
No merged PRs in 30d

Contributor guide

Open the contributing guide

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.

More from streamaserver/streama

All issues in streamaserver/streama

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.