From 1cba653a003215e5230f140b144964211ca0fd7c Mon Sep 17 00:00:00 2001 From: Tommaso Casaburi Date: Sun, 7 Jun 2026 22:15:19 +0700 Subject: [PATCH] docs(readme): surface 5chan browser daemon --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c2b3697..4b5dcd5 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,7 @@ - [What is Bitsocial?](#what-is-bitsocial) - [What is bitsocial-cli?](#what-is-bitsocial-cli) - [Install](#install) +- [Use 5chan in your normal browser](#use-5chan-in-your-normal-browser) - [Docker](#docker) - [Usage](#usage) - [Commands](#commands) @@ -28,7 +29,7 @@ Bitsocial is p2p and decentralized social media protocol built completely with I - Runs an IPFS and Bitsocial node - Command Line interface to manage Bitsocial communities - WebSocket RPC to access and control your communities and publications -- Includes Web UIs like Seedit where you can browse the network and manage your community +- Includes Web UIs like 5chan and Seedit where you can browse the network and manage your community ## Install @@ -66,6 +67,16 @@ npm run ci:download-web-uis After running the last command you should be able to run commands directly against `./bin/run`, for example `./bin/run daemon` +## Use 5chan in your normal browser + +`bitsocial-cli` includes the 5chan Web UI. If you want to run the full P2P Bitsocial/IPFS node but open 5chan in your normal browser, start the daemon: + +```sh-session +bitsocial daemon +``` + +The daemon prints a `WebUI (5chan - Imageboard-style UI)` URL. Open that URL in your browser to use 5chan through your local node. You do not need the separate 5chan desktop app or a local checkout of the 5chan repository. + ## Docker You can run bitsocial-cli as a Docker container. The container runs the daemon and exposes the RPC + web UI on port 9138, the Kubo IPFS API on port 50019, and the IPFS Gateway on port 6473. @@ -108,10 +119,11 @@ The output will include lines like: ``` pkc rpc: listening on ws://localhost:9138/ (secret auth key for remote connections) +WebUI (5chan - Imageboard-style UI): http://:9138//5chan (secret auth key for remote connections) WebUI (seedit - Similar to old reddit UI): http://:9138//seedit (secret auth key for remote connections) ``` -Open the WebUI URL in your browser to start using Bitsocial. +Open the 5chan or Seedit WebUI URL in your browser to start using Bitsocial. #### Viewing logs