Skip to content

docs: surface 5chan browser daemon #72

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tomcasaburi wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: surface 5chan browser daemon #72

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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

Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -108,10 +119,11 @@ The output will include lines like:

```
pkc rpc: listening on ws://localhost:9138/<auth-key> (secret auth key for remote connections)
WebUI (5chan - Imageboard-style UI): http://<your-ip>:9138/<auth-key>/5chan (secret auth key for remote connections)
WebUI (seedit - Similar to old reddit UI): http://<your-ip>:9138/<auth-key>/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

Expand Down