Code Monkey home page Code Monkey logo

bridge's Introduction

Bridge

License: MIT

An application for interacting with Azimuth.

Usage

The latest version of Bridge is accessible online at bridge.urbit.org. No setup needed.

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

Requirements

Python 3.7.2

Instructions

Download

  1. Download a release
  2. Unzip it (bridge-$version.zip)
  3. Open up your command line interface (Terminal on MacOS, Command Prompt on Windows)
  4. cd into the bridge-$version directory

Verify checksums

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

  • On MacOS: shasum -a 256 -c checksums.txt .
  • On Linux: sha256sum -c checksums.txt .
  • On Windows: Go into the build directory and verify files individually with CertUtil -hashFile [file_name] SHA256

Run Bridge

  1. cd into the bridge-$version directory
  2. Run python3 -m http.server 5000 --bind 127.0.0.1
  3. Navigate to http://127.0.0.1:5000 using a web browser to access Bridge (we recommend using Firefox or Chrome)

Ledger support

If you plan to authenticate with a Ledger, Bridge must be serving over HTTPS on localhost. This requires self-signed certificates. To do this:

  1. Install mkcert
  2. Install a local certificate authority via mkcert -install
  3. 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
  4. Run python bridge-https.py
  5. Navigate to https://localhost:4443 in a web browser to access Bridge

Bridge without internet access

A 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.

Development

See development.md.

Configurable Roller Endpoint

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

For example:

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

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

  • VITE_ROLLER_HOST - host
  • VITE_ROLLER_PORT - port
  • VITE_ROLLER_TRANSPORT_TYPE - transport type (e.g., http or https)

bridge's People

Contributors

fang- avatar shrugs avatar tomholford avatar liam-fitzgerald avatar c-johnson avatar willbach avatar jtobin avatar pkova avatar yosoyubik avatar vvisigoth avatar jamesacklin avatar arthyn avatar g-a-v-i-n avatar jyng avatar iamwillkim avatar patosullivan avatar brendanhay avatar alexmatz avatar flowerornament avatar jkmallard avatar matildepark avatar adam-fallon avatar mwvd avatar nathanlever avatar tylershuster avatar zalberico avatar eriknewton avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.