rick/LEDMatrix
1
0
Fork 0
mirror of https://github.com/ChuckBuilds/LEDMatrix.git synced 2026-04-10 21:03:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README to simplify web interface installation (#168)

Browse Source 
Removed outdated instructions for running the web interface and permissions setup.

Signed-off-by: Chuck <33324927+ChuckBuilds@users.noreply.github.com>
This commit is contained in:
Chuck
2026-01-02 22:16:04 -05:00
committed by GitHub
parent 67197635c9
commit 9f1711f9a3
1 changed files with 6 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@@ -800,18 +800,11 @@ To get these credentials:
------------------------------------------------------------------------------------ ------------------------------------------------------------------------------------
## Before Running the Display
- To allow the script to properly access fonts, you need to set the correct permissions on your home directory:
```bash
sudo chmod o+x /home/ledpi
```
- Replace ledpi with your actual username, if different.
You can confirm your username by executing:
`whoami`
## Running the Display ## Running the Display
I recommend using the web-ui to control the Display but you can also run the following commands via ssh:
From the project root directory: From the project root directory:
```bash ```bash
sudo python3 display_controller.py sudo python3 display_controller.py
@@ -827,7 +820,7 @@ This will start the display cycle but only stays active as long as your ssh sess
## Run on Startup Automatically with Systemd Service Installation ## Run on Startup Automatically with Systemd Service Installation
The first time install will handle this:
The LEDMatrix can be installed as a systemd service to run automatically at boot and be managed easily. The service runs as root to ensure proper hardware timing access for the LED matrix. The LEDMatrix can be installed as a systemd service to run automatically at boot and be managed easily. The service runs as root to ensure proper hardware timing access for the LED matrix.
### Installing the Service (this is included in the first_time_install.sh) ### Installing the Service (this is included in the first_time_install.sh)
@@ -898,9 +891,9 @@ sudo ./stop_display.sh
</details> </details>
----------------------------------------------------------------------------------- -----------------------------------------------------------------------------------
## Web Interface Installation (V2) ## Web Interface Installation
The first time install will handle this:
The LEDMatrix system includes Web Interface V2 that runs on port 5000 and provides real-time display preview, configuration management, and on-demand display controls. The LEDMatrix system includes Web Interface that runs on port 5000 and provides real-time display preview, configuration management, and on-demand display controls.
### Installing the Web Interface Service ### Installing the Web Interface Service
@@ -1204,28 +1197,6 @@ For `display_controller.py` and `stop_display.sh`, ensure their file permissions
</details> </details>
## Web Interface V2 (simplified quick start)
### 1) Run the helper (does the above and starts the server):
```
python3 start_web_v2.py
```
### 2) Start the web UI v2
```
python web_interface_v2.py
```
### 3) Autostart (recommended)
Set `"web_display_autostart": true` in `config/config.json`.
Ensure your systemd service calls `start_web_conditionally.py` (installed by `install_service.sh`).
### 4) Permissions (optional but recommended)
- Add the service user to `systemd-journal` for viewing logs without sudo.
- Configure passwordless sudo for actions (start/stop service, reboot, shutdown) if desired.
- Required for web Ui actions, look in the section above for the commands to run (chmod +x scripts/install/configure_web_sudo.sh & sudo ./scripts/install/configure_web_sudo.sh)
## Final Notes ## Final Notes