Skip to content

Latest commit

 

History

History
96 lines (65 loc) · 2.59 KB

README.md

File metadata and controls

96 lines (65 loc) · 2.59 KB

Branch

Code Quality

Table of Contents

Prepares a device for the installation of custom software.

Branch is intended to be installed on devices that will be remotely located and running custom software. Branch handles the following functions through an installation guide:

  • Network connection wizard (wifi, ethernet, bluetooth)
  • Install from GitHub or URL

In addition to providing basic functionality, Branch lays out and enforces best practices for headless devices.

Installation

During installation system packages are installed.

cd /opt/
git clone https://github.com/RecursionSpace/Branch.git
./till.sh

Network Connection Wizard

The first step in the installation process is to connect the device to the network. The network connection wizard will guide the user through the process of connecting the device to the network.

AP Mode

If supported, the device enters AP mode and broadcasts a network that the user can connect to. The user is then navigated to an interface that prompts the user to connect to an existing network or enter a new network.

GUI Wizard

If a display is detected, the device will enter a GUI wizard that will guide the user through the process of connecting the device to the network.

https://superuser.com/questions/610084/putty-x11-proxy-wrong-authorisation-protocol-attempted

Configuration

Branch can be configured via the branch.json file in the root of the branch directory.

{
  "program": {
    "url": "",
    "branch": "",
    "name": "",
  },
}

process

A new user is created that will auto login using lightdm

Create a desktop file branch.desktop under /usr/share/xsessions

[Desktop Entry]
Name=Branch GUI
Comment=Start application on boot
Exec=/opt/Stem/gui_interface/gui.sh
Type=Application

Edit /etc/lightdm/lightdm.conf

[SeatDefaults]
autologin-user=jmerrell
autologin-user-timeout=0
user-session=branch

https://stackoverflow.com/questions/34917237/make-git-clone-with-sudo

Definitions

Stem - This program that allows for branch programs to connect to. Branch - The program that is connected to the stem.