uaf-t3 / t3x

The cuddly waffle toolset for T3 Raspberry Pi image creation & maintance.
Other
4 stars 0 forks source link

T3X

The cuddly waffle toolset for T3 Raspberry Pi image creation & maintenance.

This tool augments the Alaska T3 program and the T3 Alliance Raspberry Pi (RPi) ecosystem by providing the t3x tool to assist in creating a standardized T3 Raspberry Pi platform. The project has a few goals:

[!note] Safe, Secure, Accessible & Fun: The core mission of this project is to provide an interface that allows T3 learners to fortify the security and configuration of their devices, protecting them from potential cyber threats. It's not just about providing technology; it's about delivering safe and secure technology. Doing this should also be fun and adaptable to the evolving needs of the T3 community and their projects.

Installation

Fully manual clone steps:

git clone git@github.com:uaf-t3/t3x
cd t3x
# Review the scripts starting with bootstrap.sh
./scripts/bootstrap.sh

Trust the T3X CHEESE lab team? Recommended easy method:

curl https://raw.githubusercontent.com/uaf-t3/t3x/main/scripts/bootstrap.sh | bash -e

Changes/Impacts of installing T3X

Beyond that the impacts of T3X will depend on what tools from it you run.

t3x Usage

The t3x command offers an interface to a collection of scripts and tools.

Scripts

t3x bootstrap or $HOME/t3x/scripts/bootstrap.sh

t3x update

t3x sanity

Tools

t3x pi

Tools to manage our pi. Includes fun gems like:

t3x starship

A tool to ensure our T3 RPis have a cool custom prompt and fonts for maximum enjoyment. See the tools/starship/README.md for more details.

t3x starship setup

t3x starship launch

License

We want this tool to be available for T3 sites and others to use under an open-source license. We picked the Apache 2.0 license that provides the following features to users. Any contributions to this project must be eligible to be included under this license or as needed; any specific file must clearly be labeled if they fall under different licensing restrictions.

Permissions Conditions Limitations
:green_circle: Commercial Use :large_blue_circle: License & copyright notice :red_circle: Liability
:green_circle: Distribution :large_blue_circle: State changes :red_circle: Trademark use
:green_circle: Modification :memo: :red_circle: Warranty
:green_circle: Patent use :scroll:
:green_circle: Private use :mute:

See the LICENSE.md file for full license.

Credits & Sponsors

Contributors