Skip to content

Commit 86a0ce8

Browse files
sprytnykfmoessbauer
authored andcommitted
docs: update README with Brave Browser installation steps
[Felix: fold in README fixup changes] Signed-off-by: Vladyslav Krylasov <vladyslav.krylasov@gmail.com> Signed-off-by: Felix Moessbauer <felix.moessbauer@siemens.com>
1 parent 77499c1 commit 86a0ce8

File tree

1 file changed

+52
-14
lines changed

1 file changed

+52
-14
lines changed

README.md

Lines changed: 52 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -24,24 +24,62 @@ The extension requires [PyGObject](https://pygobject.gnome.org/) and [pydbus](ht
2424
- On Arch Linux: `sudo pacman -S python-gobject python-pydbus`
2525
- If you are using a Python version manager such as `asdf` you must install the Python packages manually: `pip install PyGObject pydbus`
2626

27-
### Firefox: Signed Version from Github Releases
27+
### Firefox: Signed Version from GitHub Releases
2828

29-
You can get a signed version of the browser extension from our Github releases.
30-
As this only covers the browser part, the host tooling still needs to be installed manually:
29+
You can download a **signed version** of the browser extension directly from our [GitHub Releases](https://github.com/siemens/linux-entra-sso/releases).
3130

32-
1. clone this repository
33-
2. run `make local-install-firefox`
34-
3. Get the `linux_entra_sso-<version>.xpi` file from the [project's releases page](https://github.com/siemens/linux-entra-sso/releases)
35-
4. Enable "Access your data for `https://login.microsoftonline.com`" under the extension's permissions
31+
> This package includes only the **browser extension**. The **host tooling** must still be installed manually.
3632
37-
### Chrome: Signed Version from Chrome Web Store
33+
#### Installation Steps
3834

39-
You can get a signed version of the browser extension from the Chrome Web Store.
40-
As this only covers the browser part, the host tooling still needs to be installed manually:
35+
1. Clone this repository:
4136

42-
1. clone this repository
43-
2. run `make local-install-chrome`
44-
3. Install the [linux-entra-sso](https://chrome.google.com/webstore/detail/jlnfnnolkbjieggibinobhkjdfbpcohn) Chrome extension from the Chrome Web Store
37+
```bash
38+
$ git clone https://github.com/siemens/linux-entra-sso.git
39+
$ cd linux-entra-sso
40+
```
41+
42+
2. Run the local install command:
43+
44+
```bash
45+
$ make local-install-firefox
46+
```
47+
48+
3. Download the extension file:
49+
50+
Get the `linux_entra_sso-<version>.xpi` file from the [project's releases page](https://github.com/siemens/linux-entra-sso/releases).
51+
52+
4. Enable required permissions:
53+
54+
After installing the extension, enable the following permission:
55+
56+
Access your data for `https://login.microsoftonline.com`
57+
58+
### Chrome & Brave: Signed Extension from Chrome Web Store
59+
60+
You can install the signed browser extension from the [Chrome Web Store](https://chrome.google.com/webstore/detail/jlnfnnolkbjieggibinobhkjdfbpcohn), which works for both **Google Chrome** and **Brave Browser**.
61+
62+
> **Note:** This only installs the browser extension. You still need to install the host integration manually.
63+
64+
#### Installation Steps:
65+
66+
1. Clone this repository:
67+
68+
```bash
69+
$ git@github.com:siemens/linux-entra-sso.git
70+
$ cd linux-entra-sso
71+
```
72+
73+
2. Run the local install command:
74+
75+
```bash
76+
$ make local-install-chrome # command for Chrome Browser
77+
$ make local-install-brave # command for Brave Browser
78+
```
79+
80+
3. Install the extension file:
81+
82+
- [linux-entra-sso](https://chromewebstore.google.com/detail/linux-entra-sso/jlnfnnolkbjieggibinobhkjdfbpcohn)
4583

4684
### Development Version and Other Browsers
4785

@@ -52,7 +90,7 @@ since version 48.
5290
To build the extension and install the host parts, perform the following steps:
5391

5492
1. clone this repository
55-
2. run `make local-install-<firefox|chrome>` to install the native messaging app in the user's `.mozilla` (or Chrome) folder
93+
2. run `make local-install-<firefox|chrome|brave>` to install the native messaging app in the user's `.mozilla` (or Chrome) folder
5694
3. run `make` to build the extension (For Firefox, `build/<platform>/linux-entra-sso-*.xpi` is generated)
5795
4. Firefox only: Permit unsigned extensions in Firefox by setting `xpinstall.signatures.required` to `false`
5896
4. Chrome only: In extension menu, enable `Developer mode`.

0 commit comments

Comments
 (0)