An open API service indexing awesome lists of open source software.

https://github.com/garrying/html.local

Raspi portal for HTML in the Park
https://github.com/garrying/html.local

html raspberry-pi

Last synced: about 1 month ago
JSON representation

Raspi portal for HTML in the Park

Awesome Lists containing this project

README

          

# html.local

Turn your Raspberry Pi into a captive portal that serves a custom webpage to anyone who connects to its Wi-Fi network.

This is a forked version of [Splines/raspi-captive-portal](https://github.com/Splines/raspi-captive-portal)

## Installation

> [!IMPORTANT]
> Connect to your Raspberry Pi via Ethernet (not Wi-Fi) before running the setup.

```bash
git clone https://github.com/garrying/html.local.git
cd html.local
sudo python setup.py
```

## How It Works

1. Your Pi creates a Wi-Fi network called `❇️ HTML in the Park`
2. When users connect, they're automatically redirected to the webpage
3. The webpage is served from `html.local` (or any HTTP URL they visit)

> [!NOTE]
> This creates a local network without internet access. Users may need to select "Use without internet" when connecting.

## Customization

- **Wi-Fi settings:** Edit files in the `access-point/` folder
- **Webpage:** Customize files in the `server/` folder
- **Apply changes:** Run `sudo python setup.py` again

## Default Settings

- Pi IP address: `192.168.4.1`
- WiFi name: `❇️ HTML in the Park`
- Webpage URL: `html.local`

## Troubleshooting

**Can't see the Wi-Fi network?**
```bash
sudo systemctl restart hostapd
```

**Webpage not loading?**
```bash
sudo systemctl restart access-point-server
```

**Still having issues?**
```bash
sudo reboot
```

## Requirements

- Raspberry Pi 4
- Raspberry Pi OS (Bullseye or Bookworm)

## License

The code is available under the [GPL-3.0 license](LICENSE).