motioneye-project / motioneye

A web frontend for the motion daemon.
GNU General Public License v3.0
3.94k stars 650 forks source link

Pull request for the Wiki: Updated the "Install In Docker" page #3007

Open mdPlusPlus opened 3 months ago

mdPlusPlus commented 3 months ago

I've forked the Wiki (link) according to https://gist.github.com/larrybotha/10650410.
Unfortunately GitHub doesn't let you issue pull requests for wiki pages.
Please check the link above to see how to merge the changes (if deemed adequate). (The resulting repo links are https://github.com/mdPlusPlus/motioneye.wiki.git or git@github.com:mdPlusPlus/motioneye.wiki.git for easy access)

Changes:

Reasoning:
I think a lot of people refrain from installing MotionEye because of the Python2 dependency. A nice way to work around this is Docker. However, until now the images referenced in the wiki were terribly outdated (3+ years) and do not receive updates anymore. The devs have long switched to GHCR as replacement.
Now people who want to try the docker images will be directed to the correct images that will keep getting updated.

mdPlusPlus commented 3 months ago

Apparently there isn't even a Python 2 dependency anymore. In this case there are propably a lot more lines in the wiki that should be changed.

I also assume you want to pass --device /dev/dri to the container, so that it can make use of hardware transcoding capabilities like QuickSync. But again, someone who is more experienced than me with these things should take a look at that.

MichaIng commented 3 months ago

Looks mostly fine. However, I would completely remove method 3 (the Python 2/motionEye v0.42.1 build). We cannot support this ancient versions with its very own problems anymore, and we should not document how to install a dead-end environment. There is the python2 branch, so if someone for whatever reason really needs it, it can be figured out from there.

The timezone list is fine, but it is somehow weird for have the PHP documentation linked. Suggested replacement: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

Generally, it would be great to update and align the README from the Docker dir in the same turn: https://github.com/motioneye-project/motioneye/blob/dev/docker/README.md Not great to have duplicate instructions, but as long as they can be aligned via copy&paste, it is okay for me, so there are instructions when cloning the repo, as well as in the wiki, where people commonly check for when visiting the GitHub page.

Also pinging @MarcelCoding who created the docker image workflow.

MarcelCoding commented 3 months ago

The documentation itself looks great. I would suggest to move the wiki to a docs folder inside the repo which would improve the entrance to contributions and also link the documentation to the appropriate version. Additionally I would replace the wiki just with a link to the markdown files. As a last step the pull request template would be updated to inform contributors that the documentation should be updated in the same pull request as features are added. This could improve the documentation quality and correctness.

MichaIng commented 3 months ago

That is a very good idea. The wiki could still contain some meta information, like the available branches. The benefit of merging all docs into an own directory is that we could generate a versioned MkDocs site with this, using e.g. GitHub Pages.