integrated the forum plugin
This commit is contained in:
parent
4a0214f020
commit
46cd28ba54
5 changed files with 122 additions and 4 deletions
24
README.md
24
README.md
|
|
@ -11,6 +11,7 @@ A personal, decentralized search engine built on the [Reticulum](https://reticul
|
|||
- **Custom templates** — Full HTML/CSS/JS template editor to personalize your instance
|
||||
- **Import/export** — JSON-based backup and restore
|
||||
- **Mesh-native** — Works over Reticulum without the internet; encrypted and decentralized by default
|
||||
- **Forum plugin** — Optional link-sharing discussion board over the mesh (see Forum section below)
|
||||
|
||||
## Performance & Scale
|
||||
|
||||
|
|
@ -107,6 +108,7 @@ Your data is stored in `~/.tinyweb/`:
|
|||
|------|-------------|
|
||||
| `index.db` | SQLite database with your indexed pages |
|
||||
| `tinyweb_identity` | Your Reticulum identity (keep safe!) |
|
||||
| `forum.db` | Forum plugin database (only if forum is enabled) |
|
||||
| `models/` | Downloaded AI models for semantic search |
|
||||
| `index.hnsw` | Semantic search index |
|
||||
|
||||
|
|
@ -118,6 +120,7 @@ Back up the whole `~/.tinyweb/` directory periodically. The two files that matte
|
|||
|
||||
- **`tinyweb_identity`** is your permanent mesh identity. If you lose it, your destination hash changes and every subscriber has to re-subscribe to the new one. Keep it somewhere you trust; the file is `0600` by default.
|
||||
- **`index.db`** is your full reading history — every page, note, tag, and synced remote page. Losing it loses everything you've curated.
|
||||
- **`forum.db`** (if the forum plugin is enabled) — all threads, posts, upvotes, and moderation settings. Losing it loses your forum data.
|
||||
|
||||
`models/` and `index.hnsw` are re-derivable (the model will re-download, and the HNSW index rebuilds from the database on next startup with semantic search enabled) so they don't need to be backed up.
|
||||
|
||||
|
|
@ -176,6 +179,27 @@ This connects over Reticulum and serves the remote instance at `http://localhost
|
|||
3. **Subscribe** — Add a friend's destination hash on `/subscriptions` to sync their shared index
|
||||
4. **Customize** — Edit your site name, HTML template, and sharing settings on `/style`
|
||||
|
||||
## Forum plugin
|
||||
|
||||
TinyWeb ships with an optional [tinyweb-forum](https://git.derickphan.com/lichenblankie/tinyweb-forum) plugin — a decentralized link-sharing discussion board that runs in-process alongside TinyWeb.
|
||||
|
||||
### Install
|
||||
|
||||
```bash
|
||||
pip install tinyweb-forum
|
||||
```
|
||||
|
||||
Enable it on the `/style` page under "Forum". A "Forum" link will appear in the navigation bar.
|
||||
|
||||
### How it works
|
||||
|
||||
- Threads and posts are stored in `~/.tinyweb/forum.db` (separate from your search index)
|
||||
- Instances sync forum content over Reticulum every 5 minutes
|
||||
- Authors are identified by a short pseudonymous identity hash (no accounts, no sign-up)
|
||||
- Moderation is local: block authors, mute threads, keyword filters, and gossip block lists with peers
|
||||
|
||||
For full feature docs, see the [tinyweb-forum README](https://git.derickphan.com/lichenblankie/tinyweb-forum).
|
||||
|
||||
## Project structure
|
||||
|
||||
```
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue