From 28c762e13109dffec19d3bc387b5e318ca6a2d22 Mon Sep 17 00:00:00 2001 From: Tommaso Casaburi Date: Sun, 7 Jun 2026 22:08:20 +0700 Subject: [PATCH] docs(readme): document local browser daemon --- README.md | 11 +++++++++++ public/llms-full.txt | 11 +++++++++++ 2 files changed, 22 insertions(+) diff --git a/README.md b/README.md index 0235d4a5..4ca03f3c 100644 --- a/README.md +++ b/README.md @@ -47,6 +47,17 @@ Directory voting pages are planned for each slot on 5chan. These pages will list - **Desktop version** (full P2P bitsocial node, seeds automatically): Available for Mac/Windows/Linux, [download from the release page](https://github.com/bitsocialnet/5chan/releases/latest) - **Mobile version**: Available for Android, [download from the release page](https://github.com/bitsocialnet/5chan/releases/latest) +## Run 5chan in Your Browser With a Local Node + +If you want the full P2P node but prefer opening 5chan in your normal browser instead of using the desktop app, use [bitsocial-cli](https://github.com/bitsocialnet/bitsocial-cli). It runs the Bitsocial/IPFS node and serves the bundled 5chan Web UI locally, so you do not need to run this repository separately. + +```sh-session +npm install -g @bitsocial/bitsocial-cli +bitsocial daemon +``` + +When the daemon starts, it prints a `WebUI (5chan - Imageboard-style UI)` URL. Open that URL in your browser to use 5chan through your local node. See the [bitsocial-cli daemon docs](https://github.com/bitsocialnet/bitsocial-cli#running-daemon) for details. + ## Creating a Board In the bitsocial protocol, a 5chan board is called a _community_. To deliver the expected 5chan imageboard UX, a board should run on a bitsocial node together with [5chan Board Manager](https://github.com/bitsocialnet/5chan-board-manager). The board manager applies imageboard-style lifecycle rules that bitsocial communities do not enforce by themselves: thread limits, bump limits, archived-thread retention, and purging of author-deleted content. diff --git a/public/llms-full.txt b/public/llms-full.txt index c3b3b472..419e541a 100644 --- a/public/llms-full.txt +++ b/public/llms-full.txt @@ -78,6 +78,17 @@ Directory voting pages are planned for each slot on 5chan. These pages will list - **Desktop version** (full P2P bitsocial node, seeds automatically): Available for Mac/Windows/Linux, [download from the release page](https://github.com/bitsocialnet/5chan/releases/latest) - **Mobile version**: Available for Android, [download from the release page](https://github.com/bitsocialnet/5chan/releases/latest) +## Run 5chan in Your Browser With a Local Node + +If you want the full P2P node but prefer opening 5chan in your normal browser instead of using the desktop app, use [bitsocial-cli](https://github.com/bitsocialnet/bitsocial-cli). It runs the Bitsocial/IPFS node and serves the bundled 5chan Web UI locally, so you do not need to run this repository separately. + +```sh-session +npm install -g @bitsocial/bitsocial-cli +bitsocial daemon +``` + +When the daemon starts, it prints a `WebUI (5chan - Imageboard-style UI)` URL. Open that URL in your browser to use 5chan through your local node. See the [bitsocial-cli daemon docs](https://github.com/bitsocialnet/bitsocial-cli#running-daemon) for details. + ## Creating a Board In the bitsocial protocol, a 5chan board is called a _community_. To deliver the expected 5chan imageboard UX, a board should run on a bitsocial node together with [5chan Board Manager](https://github.com/bitsocialnet/5chan-board-manager). The board manager applies imageboard-style lifecycle rules that bitsocial communities do not enforce by themselves: thread limits, bump limits, archived-thread retention, and purging of author-deleted content.