🦥 Lazy Helper !

A simple interface to help lazy people like me to shut down/reboot/sleep/lock/etc. their computer remotely.

- USAGE

If you're a lazy guy, like me. or a busy one, you may leave your PC on when you're going to sleep or watch a movie on TV.

There you are! This is the solution you're looking for :)

Just install and run LazyHelper; after that, you can shut down your Linux PC with your mobile!

- API

LazyHelper API is described Here

- Pre-requirements

python  v3.6  //  or higher
node.js v16   //  or higher

- Installation

git clone https://github.com/mehdiirh/LazyHelper.git && cd LazyHelper

LazyHelper🦥 likes lazy people, so because you're too lazy to install step by step, it will install itself :)

You will be asked to create a superuser, please do it to use the authentication system.

Execute:

sudo bash install.sh && source venv/bin/activate

After that:

cd templates/
npm install
npm run build
cd ..

Yay !

To use "copy to clipboard" feature, you need to install xclip

Now you can run your LazyHelper:

./manage.py runserver 0.0.0.0:8081  # <- you can change the port

Connect your phone and PC to the same network and access it from your PC's local IP address :

192.168.*.*:<port>

- [Optional] Set host name

sudo nano /etc/hosts

Add this line after 127.0.0.1 localhost:

127.0.0.1    <your-host-name>  # like: mehdi

Execute this command:

hostnamectl set-hostname <your-host-name>

Reboot!

Now you can access your PC from your-host-name.local ( like mehdi.local ) from any device on your network.

- Daemonize

sudo nano /etc/systemd/system/LazyHelper.service

Edit this service based on your configs, then hit Ctrl+X and Enter to save

[Unit]
Description=LazyHelper
After=network.target

[Service]
WorkingDirectory=  # Like: /home/mehdi/python/projects/LazyHelper
ExecStart= # Like: /home/mehdi/python/projects/LazyHelper/venv/bin/python manage.py runserver 0.0.0.0:8081
Restart=always

[Install]
WantedBy=multi-user.target

Execute:

sudo systemctl enable LazyHelper
sudo systemctl start LazyHelper

Done !

- Add Custom Commands and Buttons

For security reasons, any custom command that you want to execute must be pre-defined in the admin panel.

To add custom commands, go through these steps:

Add custom commands:

Login

Go to admin panel (/admin/).

In the CONFIG section click on Commands and add your custom commands.

Now you are allowed to use these commands using API,

If you want to see these commands as buttons on your homepage, do these steps:

Add custom buttons

Login

Go to admin panel (/admin/).

In the CONFIG section click on Buttons and add your custom buttons.

- Disable authentication ( NOT RECOMMENDED )

To use LazyHelper, you have to log in by default, if you want to disable this behavior, go to the "settings" section, disable "login-required" and save

❗️SECURITY WARNING

By disabling authentication, anyone on your network can access your PC.
They can execute every defined command.

Especially if you're on a public network, never disable authentication.

- License

This project is licensed under the MIT License - see the LICENSE.md file for details

- Acknowledgments

I appreciate Fatemeh's works, because of designing the awesome UX for LazyHelper.

Your Pull Requests are so welcome !

Currently, I have no idea how to make this work on Windows. If you know, please submit a PR.

Also, any UI/UX improvements are welcome

mehdiirh / lazyhelper Goto Github PK

lazyhelper's Introduction