Update file README.md
This commit is contained in:
jpd committed
1 parent
e9e08c32a6
commit
afea70d69a
1 file changed
+51
-70
@@ -1,93 +1,74 @@
|
||||
# motion_sync
|
||||
|
||||
...is a little bash script for rpi + a USB webcam that I wrote to upload motioneye vids and pics to you box account every minute for security reasons.
|
||||
|
||||
The idea behind it is that a thief / malicious person might be knowledgeable of the pi / motioneye setup and either cut the power to the premise before breaking in
|
||||
or go to the setup pi / webcam and disconnect it from power / disconnect the USB webcam or the LAN cable...
|
||||
|
||||
With my script even if a break-in happens, the thief / malicious person will be captured and if properly "UPS-ed" (pi+router) have no chance in "not" getting captures
|
||||
uploaded to cloud storage.
|
||||
|
||||
I use motioneye because is open source and free, and lightweight, so can run on a pi.
|
||||
|
||||
I use Box because the free account gives us 10GB
|
||||
|
||||
I use a Pi because it is cheap and has WiFi and LAN and USB, so a cheap WebCam will do.
|
||||
|
||||
It works in conjuction with motioneye and with an rclone box service I also created in /etc/systemd/user/rclone-box.service
|
||||
|
||||
## Getting started
|
||||
|
||||
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
|
||||
Install motioneye, create a box account and do not use it for anything else.
|
||||
|
||||
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
|
||||
Install rclone on the pi and connect it to Box (google it)
|
||||
|
||||
## Add your files
|
||||
Once Motioneye is working and saving to /var/lib/motioneye create a systemd service that keeps Box rclone alive:
|
||||
|
||||
* [Create](https://docs.gitlab.com/user/project/repository/web_editor/#create-a-file) or [upload](https://docs.gitlab.com/user/project/repository/web_editor/#upload-a-file) files
|
||||
* [Add files using the command line](https://docs.gitlab.com/topics/git/add_files/#add-files-to-a-git-repository) or push an existing Git repository with the following command:
|
||||
mkdir -p ~/.config/systemd/user
|
||||
|
||||
```
|
||||
cd existing_repo
|
||||
git remote add origin https://gitlab.com/habiwan/motion_sync.git
|
||||
git branch -M main
|
||||
git push -uf origin main
|
||||
```
|
||||
nano ~/.config/systemd/user/rclone-box.service
|
||||
|
||||
## Integrate with your tools
|
||||
[Unit]
|
||||
Description=Rclone Box Mount
|
||||
Documentation=man:rclone(1)
|
||||
After=network-online.target
|
||||
Wants=network-online.target
|
||||
|
||||
* [Set up project integrations](https://gitlab.com/habiwan/motion_sync/-/settings/integrations)
|
||||
[Service]
|
||||
Type=notify
|
||||
ExecStart=/usr/bin/rclone mount box: %h/box \
|
||||
--config %h/.config/rclone/rclone.conf \
|
||||
--vfs-cache-mode full \
|
||||
--vfs-cache-max-size 10G \
|
||||
--vfs-cache-max-age 24h \
|
||||
--dir-cache-time 72h \
|
||||
--allow-other \
|
||||
--umask 022
|
||||
ExecStop=/bin/fuermount -u %h/box
|
||||
Restart=on-failure
|
||||
RestartSec=10s
|
||||
|
||||
## Collaborate with your team
|
||||
[Install]
|
||||
WantedBy=default.target
|
||||
|
||||
* [Invite team members and collaborators](https://docs.gitlab.com/user/project/members/)
|
||||
* [Create a new merge request](https://docs.gitlab.com/user/project/merge_requests/creating_merge_requests/)
|
||||
* [Automatically close issues from merge requests](https://docs.gitlab.com/user/project/issues/managing_issues/#closing-issues-automatically)
|
||||
* [Enable merge request approvals](https://docs.gitlab.com/user/project/merge_requests/approvals/)
|
||||
* [Set auto-merge](https://docs.gitlab.com/user/project/merge_requests/auto_merge/)
|
||||
Finally, create 2 crontab entries, one to keep the Box OAuth token alive and one to run my script every minute:
|
||||
|
||||
## Test and Deploy
|
||||
sudo crontab -e
|
||||
|
||||
Use the built-in continuous integration in GitLab.
|
||||
# Keep Box OAuth token alive (runs weekly, e.g., every Sunday at 3 AM)
|
||||
0 3 * * 0 rclone lsd box: >/dev/null 2>&1
|
||||
|
||||
* [Get started with GitLab CI/CD](https://docs.gitlab.com/ci/quick_start/)
|
||||
* [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/user/application_security/sast/)
|
||||
* [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/topics/autodevops/requirements/)
|
||||
* [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/user/clusters/agent/)
|
||||
* [Set up protected environments](https://docs.gitlab.com/ci/environments/protected_environments/)
|
||||
# Sync motion recordings and cleanup (runs every minute)
|
||||
* * * * * /home/$USER/sync_motion.sh >/dev/null 2>&1
|
||||
|
||||
***
|
||||
My script does the following for you:
|
||||
|
||||
# Editing this README
|
||||
# 1. Ensures log directory exists
|
||||
|
||||
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
|
||||
# 2. Keeps log file under ~5 MB by trimming it when it gets too large
|
||||
|
||||
## Suggestions for a good README
|
||||
# 3. Remuxes MKV to MP4 (so the videos work on the pi motioneye webserver)
|
||||
|
||||
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
|
||||
# 4. Local cleanup (Batch Trim down to 9GB)
|
||||
|
||||
## Name
|
||||
Choose a self-explaining name for your project.
|
||||
|
||||
## Description
|
||||
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
|
||||
|
||||
## Badges
|
||||
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
|
||||
|
||||
## Visuals
|
||||
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
|
||||
|
||||
## Installation
|
||||
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
|
||||
|
||||
## Usage
|
||||
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
|
||||
|
||||
## Support
|
||||
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
|
||||
|
||||
## Roadmap
|
||||
If you have ideas for releases in the future, it is a good idea to list them in the README.
|
||||
|
||||
## Contributing
|
||||
State if you are open to contributions and what your requirements are for accepting them.
|
||||
|
||||
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
|
||||
|
||||
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
|
||||
|
||||
## Authors and acknowledgment
|
||||
Show your appreciation to those who have contributed to the project.
|
||||
|
||||
## License
|
||||
For open source projects, say how it is licensed.
|
||||
|
||||
## Project status
|
||||
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
|
||||
# 5. Syncs to BOX with rclone (Reflects local 9GB state & deletes missing remote files)
|
||||
Reference in new issue
Block a user