starred/motioneye

Fork 0

mirror of https://github.com/motioneye-project/motioneye.git synced 2026-03-02 22:57:06 -05:00

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

New issue

Open

opened 2026-02-28 01:14:15 -05:00 by deekerman · 4 comments

deekerman commented

2026-02-28 01:14:15 -05:00

Owner

Originally created by @mdPlusPlus on GitHub (Jun 12, 2024).

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:

replaced all references of the terribly outdated Docker Hub repository with the GitHub Container Registry one
replaced all mentions of https://github.com/ccrisan/motioneye with https://github.com/motioneye-project/motioneye
removed the instructions for building and running on the Raspberry Pi as the GHCR images work differently (should probably be readded by someone who knows more about the Pi building process than me)
improved syntax and aesthetics

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.

Originally created by @mdPlusPlus on GitHub (Jun 12, 2024). I've forked the Wiki ([link](https://github.com/mdPlusPlus/motioneye/wiki/Install-In-Docker)) 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: - replaced all references of the terribly outdated Docker Hub repository with the GitHub Container Registry one - replaced all mentions of https://github.com/ccrisan/motioneye with https://github.com/motioneye-project/motioneye - removed the instructions for building and running on the Raspberry Pi as the GHCR images work differently (should probably be readded by someone who knows more about the Pi building process than me) - improved syntax and aesthetics 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.

deekerman added the

docker

documentation

labels

2026-02-28 01:14:15 -05:00

deekerman commented

2026-02-28 01:14:17 -05:00

Author

Owner

@mdPlusPlus commented on GitHub (Jun 13, 2024):

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.

@mdPlusPlus commented on GitHub (Jun 13, 2024): 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.

deekerman commented

2026-02-28 01:14:21 -05:00

Author

Owner

@MichaIng commented on GitHub (Jun 15, 2024):

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.

@MichaIng commented on GitHub (Jun 15, 2024): 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.

deekerman commented

2026-02-28 01:14:21 -05:00

Author

Owner

@MarcelCoding commented on GitHub (Jun 16, 2024):

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.

@MarcelCoding commented on GitHub (Jun 16, 2024): 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.

deekerman commented

2026-02-28 01:14:21 -05:00

Author

Owner

@MichaIng commented on GitHub (Jun 16, 2024):

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.

@MichaIng commented on GitHub (Jun 16, 2024): 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.

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

starred/motioneye#2542

No description provided.

Rows
Columns