Skip to content

Commit 34c713c

Browse files
committed
docs: add installation instructions for homebrew and troubleshooting guide to readme
1 parent 2c57d1a commit 34c713c

File tree

2 files changed

+38
-9
lines changed

2 files changed

+38
-9
lines changed

README.md

Lines changed: 37 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,33 @@ The app may be compatible with older versions of macOS, but it is not tested.
3232

3333
## Setup
3434

35+
### 1. Install via Homebrew
36+
37+
```bash
38+
brew tap mashb1t/susops-mac
39+
brew install --cask susops
40+
```
41+
42+
For updating, simply run these commands:
43+
44+
```bash
45+
brew update
46+
brew upgrade --cask susops
47+
```
48+
49+
### OR Install manually
50+
3551
1. Download the SusOps.zip file from the [latest release](https://github.com/mashb1t/susops-mac/releases)
3652
2. Unzip the file
3753
3. (Optional) Move the SusOps app to your Applications folder
38-
4. Launch the application
39-
> [!NOTE]
40-
> The app is not signed, you may need to allow its startup in **System Settings** > **Privacy & Security**. If this does not
41-
5. Set up your SSH host and ports in the **Preferences** menu
42-
6. Start the proxy (menu bar icon should turn green)
43-
7. Add domains (requires browser restart) or port-forwards (requires proxy restart)
54+
55+
### 2. Configure
56+
57+
1. Launch the application
58+
2. Set up your SSH host and ports in the **Preferences** menu
59+
3. Start the proxy (menu bar icon should turn green)
60+
4. Add domains (requires browser [proxy settings reload](chrome://net-internals/#proxy)) or port-forwards (requires proxy restart)
61+
4462

4563
## Build from source (development)
4664

@@ -74,6 +92,17 @@ The build embeds **`susops.sh`** and all logo assets under `Contents/Resources/`
7492
|--------------|---------------------------------|
7593
| `~/.susops/` | Same config files the CLI uses. |
7694

95+
## Troubleshooting
96+
97+
| Problem | Solution |
98+
|----------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
99+
| **SusOps won't start** | You may need to allow its startup in **System Settings** > **Privacy & Security** |
100+
| **SUsOps starts, but doesn't show up in menu bar** | MacOS only displays so many menu bar apps. Ensure you don't have too many other items open. |
101+
| **Proxy doesn't start** | Check the **Preferences** menu for correct SSH host and port settings. Ensure you can reach the host directly using `ssh <host>`. |
102+
| **Chrome doesn't pick up my added domains** | Make sure you completely close Chrome and open it again using the **Launch Browser** menu item. Then, open the Chrome Proxy settings and click **Re-apply settings**. |
103+
| **Firefox doesn't pick up my added domains** | Make sure you completely close Firefox and open it again using the **Launch Browser** menu item. |
104+
| everything else | see [Troubleshooting Guide SusOps CLI](https://github.com/mashb1t/SusOps-CLI?tab=readme-ov-file#troubleshooting) or [create an issue](https://github.com/mashb1t/SusOps-Mac/issues/new). |
105+
77106
## Contributing
78107

79108
1. Set up the project as described above in "Build from source (development)".
@@ -84,5 +113,5 @@ The build embeds **`susops.sh`** and all logo assets under `Contents/Resources/`
84113

85114
## License
86115

87-
MIT © 2025 Manuel Schmid — see `LICENSE`.
88-
[**SusOps CLI**](https://github.com/mashb1t/susops-cli) (submodule) retains its own license.
116+
MIT © 2025 Manuel Schmid — see [LICENSE](https://github.com/mashb1t/SusOps-Mac/blob/main/LICENSE.txt).
117+
[**SusOps CLI**](https://github.com/mashb1t/susops-cli) (submodule) retains its own [license](https://github.com/mashb1t/SusOps-CLI/blob/main/LICENSE.txt).

susops-cli

Submodule susops-cli updated 1 file

0 commit comments

Comments
 (0)