lichenblankie/tinyweb
2
0
Fork 0
Code Issues Pull requests Projects 1 Releases Packages Wiki Activity Actions

rewrite README — descriptive tone, remove releases/philosophy sections

Browse source
This commit is contained in:
blankie 2026-06-09 01:07:09 +00:00
parent 86dbb6ac28
commit fa1f6ccc9e
1 changed files with 3 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -1,6 +1,6 @@
# TinyWeb # TinyWeb
A personal, decentralized search engine built on the [Reticulum](https://reticulum.network/) mesh network. Curate your own index of web pages, search it locally, and share collections with friends over an encrypted mesh. No algorithms, no ads, no tracking. A personal, decentralized search engine built on the [Reticulum](https://reticulum.network/) mesh network. You save pages you find. They are stored locally and shared over a mesh network so other people can find them too.
## Features ## Features
@ -37,18 +37,6 @@ A personal, decentralized search engine built on the [Reticulum](https://reticul
- Paginated at 10,000 pages per request - Paginated at 10,000 pages per request
- Use `?batch=N` to export in chunks: `/export?batch=0`, `/export?batch=1`, etc. - Use `?batch=N` to export in chunks: `/export?batch=0`, `/export?batch=1`, etc.
## Download (pre-built binaries)
Download the latest release for your platform from the [Releases](https://git.derickphan.com/blankie/tinyweb/releases) page:
| Platform | File |
|----------|------|
| Windows | `TinyWeb-windows-x64.exe` |
| macOS | `TinyWeb-macos-arm64` |
| Linux | `TinyWeb-linux-x64` |
Run the downloaded file — no installation required.
## Docker ## Docker
TinyWeb is distributed as source. Clone the repo, then build and run with Docker Compose: TinyWeb is distributed as source. Clone the repo, then build and run with Docker Compose:
@ -144,9 +132,8 @@ docker compose down -v
### Command line options ### Command line options
```bash ```bash
./TinyWeb --version # Show version python app.py -p 9000 # Use port 9000 instead of default 8080
./TinyWeb -p 9000 # Use port 9000 instead of default 8080 python app.py --bind 0.0.0.0 # Expose the web UI to your LAN (see warning below)
./TinyWeb --bind 0.0.0.0 # Expose the web UI to your LAN (see warning below)
``` ```
By default, the web UI binds to `127.0.0.1` and is only reachable from the machine running TinyWeb. **The UI has no authentication** — anyone who can reach the port can read, add, and delete entries, and change settings. Only pass `--bind 0.0.0.0` if you fully trust your network, or put TinyWeb behind an authenticating reverse proxy. By default, the web UI binds to `127.0.0.1` and is only reachable from the machine running TinyWeb. **The UI has no authentication** — anyone who can reach the port can read, add, and delete entries, and change settings. Only pass `--bind 0.0.0.0` if you fully trust your network, or put TinyWeb behind an authenticating reverse proxy.
@ -254,6 +241,4 @@ To reduce storage for semantic search embeddings (~50% savings):
- [beautifulsoup4](https://www.crummy.com/software/BeautifulSoup/) — HTML parsing and link extraction - [beautifulsoup4](https://www.crummy.com/software/BeautifulSoup/) — HTML parsing and link extraction
- [rns](https://reticulum.network/) — Reticulum mesh networking - [rns](https://reticulum.network/) — Reticulum mesh networking
## Philosophy
TinyWeb is built for the slow web — intentionality over speed, human curation over algorithmic feeds, privacy over surveillance, and community over corporations. Every page in your index was saved because you found it valuable, not because an algorithm told you to click.