Skip to content

Commit

Permalink
separate pi/linux install
Browse files Browse the repository at this point in the history
  • Loading branch information
jflamy committed Jan 7, 2025
1 parent 3dbf14d commit 1a6ffe2
Show file tree
Hide file tree
Showing 16 changed files with 68 additions and 2 deletions.
Binary file added docs/nimg/1110pi/pi_10.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/nimg/1110pi/pi_20.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/nimg/1110pi/pi_30.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/nimg/1110pi/pi_40.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/nimg/1110pi/pi_50.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/nimg/1110pi/pi_60.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/nimg/1110pi/pi_61.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/nimg/1110pi/pi_62.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/nimg/1110pi/pi_70.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/nimg/1110pi/pi_72.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/nimg/1110pi/pi_80.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/nimg/1110pi/pi_90.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/nimg/1110pi/pi_95.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion src/main/markdown/docs/Downloads.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Several options are available for installation, depending on your needs. Additio

| | |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| **Local Setup** <br />This installs the `owlcms` program to run a competition locally, on a master laptop. No internet connection is needed.<ul><li>[Windows Installation Instructions](https://${env.REPO_OWNER}.github.io/${env.O_REPO_NAME}/#/LocalWindowsSetup)<li>[Mac/Linux/Raspberry Installation Instructions](https://${env.REPO_OWNER}.github.io/${env.O_REPO_NAME}/#/LocalLinuxMacSetup)<li><nobr>[Release Notes](https://github.com/${env.REPO_OWNER}/${env.O_REPO_NAME}/releases/tag/${revision})</nobr></ul> | <nobr><i class="material-icons" style="transform: translatey(0.30em)">file_download</i> **[Windows Installer](https://github.com/${env.REPO_OWNER}/${env.O_REPO_NAME}/releases/download/${revision}/owlcms_setup_${revision}.exe)**</nobr><br/><i class="material-icons" style="transform: translatey(0.30em)">file_download</i>[Zip for Mac, Linux or Raspberry](https://github.com/${env.REPO_OWNER}/${env.O_REPO_NAME}/releases/download/${revision}/owlcms_${revision}.zip) |
| **Local Setup** <br />This installs the `owlcms` program to run a competition locally, on a master laptop. No internet connection is needed at the competition site.<ul><li>[Windows Installation Instructions](https://${env.REPO_OWNER}.github.io/${env.O_REPO_NAME}/#/LocalWindowsSetup)<li>[Raspberry Pi/Linux Installation Instructions](https://${env.REPO_OWNER}.github.io/${env.O_REPO_NAME}/#/LocalPiLinuxSetup)<li><li>[Mac Installation Instructions](https://${env.REPO_OWNER}.github.io/${env.O_REPO_NAME}/#/LocalMacSetup)<li><nobr>[Release Notes](https://github.com/${env.REPO_OWNER}/${env.O_REPO_NAME}/releases/tag/${revision})</nobr></ul> | <nobr><i class="material-icons" style="transform: translatey(0.30em)">file_download</i> **[Windows Installer](https://github.com/${env.REPO_OWNER}/${env.O_REPO_NAME}/releases/download/${revision}/owlcms_setup_${revision}.exe)**</nobr><br/><i class="material-icons" style="transform: translatey(0.30em)">file_download</i>[Pi/Linux Launcher](https://github.com/jflamy/owlcms-launcher/releases)<br/><i class="material-icons" style="transform: translatey(0.30em)">file_download</i>[Zip for Mac](https://github.com/${env.REPO_OWNER}/${env.O_REPO_NAME}/releases/download/${revision}/owlcms_${revision}.zip) |
| **Cloud-based Setup**<br />This installs the `owlcms` competition management software in the cloud. Good internet access is needed but no local software is needed. The `publicresults` companion program allows individuals to see the scoreboard on their own phone or tablet no matter where they are located.<ul><li>[Fly.io Cloud Installation Instructions](https://${env.REPO_OWNER}.github.io/${env.O_REPO_NAME}/#/Fly)</li><li><nobr>[Release Notes](https://github.com/${env.REPO_OWNER}/${env.O_REPO_NAME}/releases/tag/${revision})</nobr></li></ul> | |
| **Documentation** | [Documentation site](https://${env.REPO_OWNER}.github.io/${env.O_REPO_NAME}/#/index) |

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## macOS, Linux or RaspberryOS Installation
## macOS Installation

> Pre-requisite: You may need to install the Java language on your computer before installing owlcms. See [Installing Java](#installing-java) section at the bottom of this page to check.
Expand Down
66 changes: 66 additions & 0 deletions src/main/markdown/docs/LocalPiLinuxSetup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
## Raspberry Pi or Linux Installation

### Installation

- Go to the page https://github.com/jflamy/owlcms-launcher/releases.
![pi_10](../../../../docs/nimg/1110pi/pi_10.png)

- **Scroll down and download the installation package by clicking on the file that ends with`pi.deb`.**
If you are installing on Linux, use amd64.deb instead

![pi_20](../../../../docs/nimg/1110pi/pi_20.png)

- **Move your mouse to the right of the download notification. You should see a folder appear, click on it.**
If you don't see it you can use the "..." menu and scroll down to "Downloads" to open the list of downloaded files, and then there is also a small folder icon.

![pi_30](../../../../docs/nimg/1110pi/pi_30.png)

- Once you see the file, **Right-click on the file name** and then **select Package Install**

![pi_40](../../../../docs/nimg/1110pi/pi_40.png)

- Accept the Install prompt

![pi_50](../../../../docs/nimg/1110pi/pi_50.png)

- To install the launcher you need to type the password to your pi account.

![pi_60](../../../../docs/nimg/1110pi/pi_60.png)

- The package will then install, and create a desktop icon, as well as an entry in the "Other" menu.

![pi_61](../../../../docs/nimg/1110pi/pi_61.png)

![pi_62](../../../../docs/nimg/1110pi/pi_62.png)

### Running OWLCMS

- If you double-click the desktop icon, you will be asked what to do; select "Execute".
If you use the Other > owlcms menu entry there is no confirmation required.![pi_70](../../../../docs/nimg/1110pi/pi_70.png)

- The first time the launcher is executed, the current version of the program will be downloaded![pi_72](../../../../docs/nimg/1110pi/pi_72.png)

- You can then select `Launch` to start OWLCMS

![pi_80](../../../../docs/nimg/1110pi/pi_80.png)

- The launcher starts OWLCMS. During the time OWLCMS gets ready, a blank browser page is opened. Once the browser page is populated, everything is ready.

> IMPORTANT:
>
> - **Leave the OWLCMS launcher window open** or minimize it if you want. If you close the windows use the Stop button, then OWLCMS will stop for all users.
> - If you stop OWLCMS by mistake, you can just launch it again. All the browsers on all the laptops will notice OWLCMS is back and refresh automatically.
> - You can close the browser window and restart it at the address "localhost:8080". It just talks to the OWLCMS server
> - When opening other laptops, you will use the "wired" address shown on the browser (localhost:8080 only works on the computer where you ran the launcher)
![pi_90](../../../../docs/nimg/1110pi/pi_90.png)

### Updating OWLMCS

When starting the launcher, if you are connected to the Internet, it will try to fetch the available versions. If you do not have the latest version installed, you will told, and given the option to update.

Updating will copy your existing database as well as changes you may have made to your `local` folder since installing.

> IMPORTANT: As a precaution, if there is important data in your current database, you should always export it before updating. To do so, launch the current version, go to the Prepare Competition page, and use the Export button near the bottom. Then use the launcher to update.
![pi_95](../../../../docs/nimg/1110pi/pi_95.png)

0 comments on commit 1a6ffe2

Please sign in to comment.