on master help sign in
Merge branch 'master' into mino-onboarding-invites
commitbfe64da1b3b857fad26f4f8908ae46e9ac0396c1 authorFang <git@fang.io> dateTue 23 Apr 2019, 22:30 (8 years ago) parent92feccf9e4c641
4 files changed+37−26
CHANGELOG+6−1 README.md+30−23 bridge-https.py−1 package.json+1−1
CHANGELOG+6−1
@@ -1,6 +1,11 @@
11
22# Changelog
33
4+- 1.3.1 (2019-04-23)
5+ This release fixes an issue with the script for serving Bridge over HTTPS.
6+
7+ * Stop `cd`ing into the new-removed `build` directory (#123)
8+
49- 1.3.0 (2019-04-18)
510 This release simplifies the flows surrounding networking keys and brings many other quality of life improvements.
611
@@ -40,4 +45,4 @@
4045
4146 * Add option for setting Trezor and Ledger custom derivation path
4247 (instead of defaulting to 0 index address)
43− * Fixes Trezor transaction signing bug
48+ * Fixes Trezor transaction signing bug
README.md+30−23
@@ -10,11 +10,33 @@ Python 3.7.2
1010
1111### Instructions
1212
13−1. To use Bridge, [download a release](https://github.com/urbit/bridge/releases) and unzip it (`bridge-$version.zip`).
14−2. Open up your command line interface (Terminal on MacOS, Command Prompt on Windows).
15−3. `cd` into the `bridge-$version` directory.
16−4. Run this command: `python3 -m http.server 5000 --bind 127.0.0.1`
17−5. You can then use Bridge by navigating to http://localhost:5000 using a web browser.
13+#### Install
14+
15+1. [Download a release](https://github.com/urbit/bridge/releases)
16+2. Unzip it (`bridge-$version.zip`)
17+3. Open up your command line interface (Terminal on MacOS, Command Prompt on Windows)
18+4. `cd` into the `bridge-$version` directory
19+
20+Follow the instructions below to run Bridge.
21+
22+#### Run Bridge
23+
24+If you plan to authenticate and sign transactions with a Master Ticket, BIP39 mnemonic, Ethereum private key, or keystore file:
25+
26+1. `cd` into the `bridge-$version` directory
27+2. Run `python3 -m http.server 5000 --bind 127.0.0.1`
28+3. Navigate to http://localhost:5000 using a web browser to access Bridge (we recommend using Firefox or Chrome)
29+
30+#### Run Bridge with Ledger support
31+
32+If you plan to authenticate and sign transactions with a [Ledger](https://www.ledger.com/), Bridge must be serving over HTTPS on localhost. This requires self-signed certificates. To do this:
33+
34+1. Install [mkcert](https://github.com/FiloSottile/mkcert)
35+2. If you're using Firefox, additionally install [nss](https://github.com/nss-dev/nss)
36+3. Install a local certificate authority via `mkcert -install`
37+4. 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
38+5. Run `python bridge-https.py`
39+6. Navigate to https://localhost:4443 in a web browser to access Bridge
1840
1941### Verify checksums
2042
@@ -24,7 +46,7 @@ To validate your downloaded file's integrity, compare the lines in checksum.txt
2446- On Linux: `sha256sum -c checksums.txt .`
2547- On Windows: Go into the `build` directory and verify files individually with `CertUtil -hashFile [file_name] SHA256`
2648
27−## Development Notes
49+## Development notes
2850
2951### Install / Build
3052
@@ -50,22 +72,7 @@ $ nvm use v11.0.0
5072
5173before running `npm run pilot`.
5274
53−### Ledger support
54−
55−To authenticate and sign transactions with a Ledger, Bridge must be serving
56−over HTTPS on localhost. This requires self-signed certificates. You can do
57−this via the following:
58−
59−* Install [mkcert](https://github.com/FiloSottile/mkcert)
60−* Install a local certificate authority via `mkcert -install`
61−* In your `bridge` directory, generate a certificate valid for localhost via
62− `mkcert localhost`. This will produce two files: `localhost.pem`, the local
63− certificate, and `localhost-key.pem`, its corresponding private key.
64−* Run `python bridge-https.py`
65−
66−Bridge will serve to localhost over HTTPS on port 4443
67−
68−### Useful Accounts
75+### Useful accounts
6976
7077The ecliptic owner is the only account that's able to create galaxies, so
7178it's a good place to get started. On the testnet, it's the address:
@@ -99,7 +106,7 @@ with 100 ETH:
99106To play around with any of these, authenticate using the same mnemonic, but
100107use a custom HD path of `m/44'/60'/0'/0/1`, `m/44'/60'/0'/0/2`, and so on.
101108
102−### Initial Development State
109+### Initial development state
103110
104111You can also tweak a couple of things to change your development state
105112somewhat (say, for example, you want to start on the points list screen, instead
bridge-https.py−1
@@ -4,5 +4,4 @@ import ssl
44
55httpd = BaseHTTPServer.HTTPServer(('localhost', 4443), SimpleHTTPServer.SimpleHTTPRequestHandler)
66httpd.socket = ssl.wrap_socket (httpd.socket, certfile='localhost.pem', keyfile='localhost-key.pem', server_side=True)
7−os.chdir('./build')
87httpd.serve_forever()
package.json+1−1
@@ -1,6 +1,6 @@
11{
22 "name": "bridge",
3− "version": "1.3.0",
3+ "version": "1.3.1",
44 "description": "An application for interacting with Azimuth",
55 "repository": {
66 "type": "git",