Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/morgankryze/raspberrypi-setup-wizard
All-in-one script to setup a Raspberry Pi as a server/homelab.
https://github.com/morgankryze/raspberrypi-setup-wizard
docker homelab portainer rpi server setup shell ufw
Last synced: 1 day ago
JSON representation
All-in-one script to setup a Raspberry Pi as a server/homelab.
- Host: GitHub
- URL: https://github.com/morgankryze/raspberrypi-setup-wizard
- Owner: MorganKryze
- License: mit
- Created: 2024-08-15T16:11:20.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-09-27T19:33:31.000Z (4 months ago)
- Last Synced: 2024-11-16T01:37:40.677Z (2 months ago)
- Topics: docker, homelab, portainer, rpi, server, setup, shell, ufw
- Language: Shell
- Homepage:
- Size: 458 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT
- Security: .github/SECURITY
Awesome Lists containing this project
README
# Raspberry Pi Setup Wizard
> All-in-one script to setup a Raspberry Pi as a server/homelab.
## Getting Started
### Introduction
Raspberry Pi Setup Wizard is an all-in-one script to setup a Raspberry Pi as a server/homelab. It is designed to be run on a fresh install of Raspberry Pi OS Lite/Desktop. Pay attention to the prerequisites and the install section before running the script.
### Prerequisites
- Hardware:
- Raspberry Pi 3/4/Zero
- MicroSD card (8GB or more)
- Power supply
- Ethernet cable or Wi-Fi connectivity
- Software:
- Raspberry Pi OS Lite/Desktop flashed from [Raspberry Pi Imager](https://www.raspberrypi.org/software/) (username & hostname has to be defined)
- SSH enabled
- Internet connection
- Host machine:
- macOS (ideal) with [Homebrew](https://brew.sh/) and [Git](https://git-scm.com/) installed
- Linux (not tested, **may** require changes)
- Windows (not tested, **will** require changes)
### Install
> [!NOTE]
> The installation process is intended for macOS users. Linux and Windows users are welcome to contribute to the project by providing the necessary changes.
First we need to install the required dependency:
```bash
brew install jq
```
Then, we will clone the project to a local permanent directory:
```bash
cd ~ # Optional
```
```bash
git clone https://github.com/MorganKryze/RaspberryPi-Setup-Wizard.git
cd RaspberryPi-Setup-Wizard
```
> [!CAUTION]
> The location should be permanent as the script will be run from this directory. Its value will be stored in the ~/.zshrc file (you may change it to ~/.bashrc if you are using bash).
Finally, we will run the script and follow the instructions:
```bash
source src/rpi-wizard.sh ; rpi init
```
Once finished, restart your terminal and run the following command to confirm the installation:
```bash
rpi
```
If it displays the welcome message, the installation was successful.
### Usage
#### Format
The commands are decomposed as:
```bash
rpi
```
#### Help
The help command will display the available commands and their usage:
```bash
rpi help
```
Or
```bash
rpi help
```
#### Commands
- `help`: Display the help message.
- `init`: Initialize the script.
- `update`: Update the script.
- `link`: Store the Raspberry Pi username and hostname.
- `unlink`: Remove the stored Raspberry Pi username and hostname.
- `connect`: Connect to the Raspberry Pi.
- `ssh`: Add the SSH key to the Raspberry Pi.
- `env`: Set up the Raspberry Pi environment.
- `docker`: Install Docker on the Raspberry Pi.
- `git`: Set up Git on the Raspberry Pi to push/pull repositories.
- `firewall`: Set up the firewall on the Raspberry Pi.
- `usb`: Set up the USB drive on the Raspberry Pi to automatically mount it at boot.
### Project structure
```plaintext
RaspberryPi-Setup-Wizard
├── .github
├── src
│ └── rpi-wizard.sh
├── conf
│ ├── 20auto-upgrades
│ └── 50unattended-upgrades
├── assets
│ └── img
│ └── screenshot.jpg
├── .gitignore
├── LICENCE
└── README.md
```
#### Small descriptive
##### `src/`
This directory contains the executable script of the project.
##### `config/`
This directory contains the configuration files for the unattended-upgrades config.
## Supported platforms
- macOS (ideal)
- Linux (not tested, **may** require changes)
- Windows (not tested, **will** require changes)
## Future improvements
- Linux & Windows compatibility.
- More customization options & features (*feel free to suggest some*).
## Contributing
If you want to contribute to the project, you can follow the steps described in the [CONTRIBUTING](CONTRIBUTING) file.
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE) file for details.