Skip to content

Commit a92466f

Browse files
committed
Updates to intro for mac
Signed-off-by: Alex Ellis (OpenFaaS Ltd) <alexellis2@gmail.com>
1 parent 6d68778 commit a92466f

1 file changed

Lines changed: 33 additions & 15 deletions

File tree

docs/mac/installation.md

Lines changed: 33 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,7 @@ Then use the CLI to install the Mac-specific binaries:
2424
slicer install slicer-mac ~/slicer-mac
2525
```
2626

27-
During preview, Slicer for Mac does not come with a background service/definition (known as a plist on macOS). So you need to launch it as and when you want it. Either directly in a terminal, or in a `tmux` window.
28-
29-
`tmux` is available via `brew install tmux`, and you can get [brew here](https://brew.sh).
30-
31-
The `slicer` command acts as an API client to Slicer for Mac.
32-
33-
By default, `slicer` auto-discovers the local mac socket at `~/slicer-mac/slicer.sock`, so you usually don't need any socket flags or environment variables for local use.
27+
The `slicer` command acts as an API client to Slicer for Mac. It'll automatically discover the socket at `~/slicer-mac/slicer.sock`, so you won't need to set `--url` or `SLICER_URL`.
3428

3529
## Initial configuration.
3630

@@ -40,12 +34,6 @@ First of all, get used to it, leave it in the path we recommend (`~/slicer-mac`)
4034

4135
The `slicer-mac` OCI bundle includes a default `slicer-mac.yaml` in the folder after install, so you can use that file directly.
4236

43-
Only run this if you want to recreate the file because you edited or edited it.
44-
45-
```bash
46-
cd ~/slicer-mac
47-
./slicer-mac new > slicer-mac.yaml
48-
```
4937

5038
The generated `slicer-mac.yaml` has two host groups:
5139

@@ -88,6 +76,13 @@ Need Rosetta for x86_64 binaries? Follow [Enable Rosetta](/mac/rosetta).
8876

8977
Run the daemon. The first run pulls and prepares the VM image automatically.
9078

79+
If you ever need to regenerate the `slicer-mac.yaml` file, you can do so with the command below:
80+
81+
```bash
82+
cd ~/slicer-mac
83+
./slicer-mac new > slicer-mac.yaml
84+
```
85+
9186
## Start the daemon
9287

9388
Start `slicer-mac`:
@@ -160,7 +155,9 @@ slicer vm exec sbox-1 -- stat ~/file.txt
160155
slicer vm delete sbox-1
161156
```
162157

163-
## Run slicer-mac as a background service
158+
## Start Slicer for Mac with your system
159+
160+
If you'd like to enable Slicer for Mac as a start-up service, you can run the following:
164161

165162
```bash
166163
cd ~/slicer-mac
@@ -172,7 +169,28 @@ cd ~/slicer-mac
172169
./slicer-mac install
173170
```
174171

175-
To uninstall:
172+
Once running in the backgroud, you can use the `slicer-tray service` commands to manage it.
173+
174+
The `daemon` service is `slicer-mac` itself, and the `tray` service is the `slicer-tray` menu bar helper.
175+
176+
```bash
177+
cd ~/slicer-mac
178+
179+
# Check the status of either service:
180+
./slicer-mac service status daemon
181+
./slicer-mac service status tray
182+
183+
# View the logs from the process - if you see an error or want to know
184+
# what's happening
185+
./slicer-mac service logs daemon
186+
./slicer-mac service logs tray
187+
188+
# Stop or Start a service for a period of time:
189+
./slicer-mac service stop daemon
190+
./slicer-mac service start daemon
191+
```
192+
193+
You can turn off the start-up service with:
176194

177195
```bash
178196
cd ~/slicer-mac

0 commit comments

Comments
 (0)