README.md · bridge · git.iko.soy

git.iko.soy/bridge

bridge/README.md

72 lines 2.7 kB history raw

1# Bridge

3[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)

5An application for interacting with Azimuth.

7## Usage

9**The latest version of Bridge is accessible online at [bridge.urbit.org](https://bridge.urbit.org). No setup needed.**

11If you would rather host Bridge on your own machine, read on.

13### Requirements

15Python 3.7.2

17### Instructions

19#### Download

211. [Download a release](https://github.com/urbit/bridge/releases/latest)

222. Unzip it (`bridge-$version.zip`)

233. Open up your command line interface (Terminal on MacOS, Command Prompt on Windows)

244. `cd` into the `bridge-$version` directory

26#### Verify checksums

28Optionally, to validate your downloaded file's integrity, compare the lines in checksum.txt to SHA-256 hashes of the `bridge-$version` directory's contents.

30- On MacOS: `shasum -a 256 -c checksums.txt .`

31- On Linux: `sha256sum -c checksums.txt .`

32- On Windows: Go into the `build` directory and verify files individually with `CertUtil -hashFile [file_name] SHA256`

34#### Run Bridge

361. `cd` into the `bridge-$version` directory

372. Run `python3 -m http.server 5000 --bind 127.0.0.1`

383. Navigate to http://127.0.0.1:5000 using a web browser to access Bridge (we recommend using Firefox or Chrome)

40#### Ledger support

42If you plan to authenticate with a [Ledger](https://www.ledger.com/), Bridge must be serving over HTTPS on localhost. This requires self-signed certificates. To do this:

441. Install [mkcert](https://github.com/FiloSottile/mkcert)

452. Install a local certificate authority via `mkcert -install`

463. From the `bridge-$version` directory, run `mkcert localhost` to generate a certificate valid for localhost. This will produce two files: `localhost.pem`, the local certificate, and `localhost-key.pem`, its corresponding private key

474. Run `python bridge-https.py`

485. Navigate to https://localhost:4443 in a web browser to access Bridge

50## Bridge without internet access

52A proper "offline mode" for the latest iteration of Bridge is still being worked on. In the mean time, if you need to use Bridge on an airgapped machine, use [Bridge v1.4.1](https://github.com/urbit/bridge/releases/tag/v1.4.1).

54## Development

56See [development.md](DEVELOPMENT.md).

59## Configurable Roller Endpoint

61By default, Bridge uses Tlon's L2 Roller, but can also be configured to use your own.

63For example:

65```sh

66VITE_ROLLER_HOST=my-personal-roller.net npm run pilot-mainnet

67```

69The following are configurable, and will otherwise fallback to the defaults in `constants`:

70- `VITE_ROLLER_HOST` - host

71- `VITE_ROLLER_PORT` - port

72- `VITE_ROLLER_TRANSPORT_TYPE` - transport type (e.g., `http` or `https`)