paritytech / paritytech/host-rust-core

truapi-host: document and optionally streamline custom bridge configuration

Open
#520 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Swift
Stars
10
Forks
3
Avg merge
1d 10h
Merged PRs (30d)
148

Description

Part of #517.

Context

The one-line 127.0.0.1:9955/bootstrap.js tag is a good default for a single host. A second host necessarily uses another URL, so product tooling must inject or select the matching bridge endpoint.

Required behavior

  • Documentation limits the "no environment variables" claim to the default single-host setup.
  • Multi-host examples show separate sessions, host ports, app ports, product identities, and matching bridge tags.
  • Changing --port clearly tells the developer that the product tag must use the same port.

Optional follow-up

  • Define and export non-secret child-process configuration such as the bridge URL and product identity from truapi-host dev.
  • Let Vite, Next.js, or similar tooling consume those values, so the CLI becomes the configuration source.
  • Treat variable names and compatibility guarantees as a separate public API decision.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the truapi-host documentation and the existing 127.0.0.1:9955/bootstrap.js example, then inspect the truapi-host dev entry point and its --port guidance. Update the docs to cover the single-host limitation, complete multi-host values, and matching ports; treat child-process configuration and public variable names as a separate optional decision.

Written by the indexing model from the issue text.

Assessment

Tech stack
next.js, vite
Domain
cli, developer-experience, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
70/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.