Skip to content

Latest commit

 

History

History
78 lines (55 loc) · 3.03 KB

README.md

File metadata and controls

78 lines (55 loc) · 3.03 KB
Raw

Pi-Control Mockup

Pi-Control 🥷

Welcome to Pi-Control 🥷.
This is an App for controlling your raspberry pi.
It was designed to help with information gathering, as well as to simplify control.

🛠️ Requirements

  • NodeJS: 16.x
  • Yarn: 1.22.x
  • Npm: not testet (optional)

💎 Compatibility list

Model Version Check Description
Raspberry Pi 4 Model B Rev 1.4 Raspbian GNU/Linux 10 (buster) ✅ developed on it
Raspberry Pi 3 Model B Plus Rev 1.3 Raspbian GNU/Linux 10 (buster) ✅ tested

⚙️ Installation

💻 One-Step Automated Install

Those who want to get started quickly and conveniently may install Pi-Control 🥷 using the following command/script:

curl -sSL https://raw.githubusercontent.com/borsTiHD/pi-control/main/installer/basic-install.sh | sudo bash

The script checks all needed dependencies and will ask you if you want to install an additional service.
With the service you can control the app: sudo service picontrol (start|stop|status)

🤓 Alternative Install Method

Download the latest version from releases: Release / Download
Create and change to the subdirectory /opt/pi-control.
Extract the archive and install dependencies with yarn install.

$ cd /opt/pi-control
$ yarn install # or npm install
$ sudo yarn start # or sudo npm start

This way you need to manually start the app with the sudo yarn start command.
You can also take care of your own way of running the app in the background, etc.
Examples: pm2 ('ecosystem.json' included), node-linux (you can use the script in ./installer/service.cjs), etc.

👀 First time accessing the app

After installation, you can access the app through your browser.
Go to: http://{hostname|ip}:8800

After a fresh installation no user is set up yet. Please follow the registration request.
Your user data will be stored locally and hashed with a unique key.

If you forget your password, you can delete the file with the stored data /opt/pi-control/db.json, then you will be asked to register again.

⌛ Update the app

For updating you can use the same installation script.
It also takes care of transferring your data to the new version.
For a manual update, the old app must be deleted and reinstalled.

🤖 Changing Port

You can change the default port (8800) by creating/editing the /opt/pi-control/.env file and adding the following value there: PORT_PRODUCTION=8888 After the change, you need to restart the app and you can access the app with the new port.
Go to: http://{hostname|ip}:8888

🥰 Contribution

If you want to contribute to this project, please take a look into the wiki:

⭐ Credits