Skip to content

Commit 5f1da41

Browse files
committed
Reference build instructions in webext instructions
1 parent 2a14756 commit 5f1da41

File tree

1 file changed

+12
-17
lines changed

1 file changed

+12
-17
lines changed

webext/README.md

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
This is a web extension that allows browsers to connect to the D-Bus service
22
provided by this project. It can be used for testing.
33

4-
Currently, this is written only for Firefox; there will be some slight API tweaks required to make this work in Chrome.
4+
Currently, this is written only for Firefox; there will be some slight API
5+
tweaks required to make this work in Chrome.
56

67
This requires some setup to make it work:
78

@@ -41,16 +42,7 @@ couple of options:
4142

4243
## For Testing
4344

44-
1. Run the install script for the repository:
45-
```shell
46-
meson setup -Dprofile=default -Dprefix=/usr/local build-release
47-
cd build-release
48-
meson install
49-
mkdir -p ~/.mozilla/native-messaging-hosts/
50-
ln -s /usr/local/lib64/mozilla/native-messaging-hosts/xyz.iinuwa.credentialsd_helper.json ~/.mozilla/native-messaging-hosts/
51-
```
52-
Note that since it is installing to `/usr/local`, Meson will ask you to use `sudo` to elevate privileges to install.
53-
2. Log out and log back in again to restart the D-Bus session bus.
45+
1. Follow the instructions in the ["For Installing/Testing" section of `BUILDING.md`](/BUILDING.md#for-installing-testing).
5446
2. Open Firefox and go to `about:debugging`.
5547
3. Click "This Firefox" > Load Temporary Extension. Select `/usr/local/share/credentialsd/credentialsd-firefox-helper.xpi`.
5648
4. Navigate to [https://webauthn.io]().
@@ -61,11 +53,14 @@ couple of options:
6153
(Note: Paths are relative to root of this repository)
6254

6355
1. Copy `webext/app/credential_manager_shim.json` to `~/.mozilla/native-messaging-hosts/credential_manager_shim.json`.
64-
2. In the copied file, replace the `path` key with the absolute path to `webext/app/credential_manager_shim.py`
65-
3. Open Firefox and go to `about:debugging`
66-
4. Click "This Firefox" > Load Temporary Extension. Select `webext/add-on/manifest.json`
67-
5. Build with `ninja -C ./build` and run the following binaries binary to start the D-Bus services.
56+
2. In `webext/app/credential_manager_shim.py`, point the `DBUS_DOC_FILE`
57+
variable to the absolute path to
58+
`contrib/xyz.iinuwa.credentialsd.Credentials.xml`.
59+
3. In the copied file, replace the `path` key with the absolute path to `webext/app/credential_manager_shim.py`
60+
4. Open Firefox and go to `about:debugging`
61+
5. Click "This Firefox" > Load Temporary Extension. Select `webext/add-on/manifest.json`
62+
6. Build with `ninja -C ./build` and run the following binaries binary to start the D-Bus services.
6863
- `GSCHEMA_SCHEMA_DIR=build/credentialsd-ui/data ./build/credentialsd-ui/target/debug/credentialsd-ui`
6964
- `./build/credentialsd/target/debug/credentialsd`
70-
6. Navigate to [https://webauthn.io]().
71-
7. Run through the registration and creation process.
65+
7. Navigate to [https://webauthn.io]().
66+
8. Run through the registration and creation process.

0 commit comments

Comments
 (0)