Skip to content

Run Slicer from the default Linux directory - #35

Open
welteki wants to merge 1 commit into
slicervm:masterfrom
welteki:docs/linux-default-socket
Open

Run Slicer from the default Linux directory#35
welteki wants to merge 1 commit into
slicervm:masterfrom
welteki:docs/linux-default-socket

Conversation

@welteki

@welteki welteki commented Aug 10, 2026

Copy link
Copy Markdown
Contributor

Description

Updates the Linux walkthrough and daemon guide to run Slicer from ~/slicer.

The walkthrough retains the default loopback TCP endpoint, while the systemd daemon setup places its API socket at ~/slicer/slicer.sock. The daemon guide also documents the CLI endpoint discovery order and retains loopback TCP as an alternative.

Motivation and Context

The Slicer CLI now discovers ~/slicer/slicer.sock by default, including when invoked through sudo. Using ~/slicer as the standard working directory aligns the documentation with this behavior while preserving the walkthrough default of listening on loopback TCP.

  • I have raised an issue to propose this change (required)

How Has This Been Tested?

The updated commands were verified.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTION guide
  • I have signed-off my commits with git commit -s

@reviewfn

This comment has been minimized.

Use ~/slicer as the working directory for the initial Linux walkthrough
and systemd daemon setup. This places slicer.sock at
~/slicer/slicer.sock, where the CLI now discovers it automatically.

Signed-off-by: Han Verstraete (OpenFaaS Ltd) <han@openfaas.com>
@welteki
welteki force-pushed the docs/linux-default-socket branch from 3df0b4f to f565ed8 Compare August 10, 2026 17:07
@reviewfn

This comment has been minimized.

@reviewfn

reviewfn Bot commented Aug 10, 2026

Copy link
Copy Markdown

AI Pull Request Overview

Disclaimer: This review was generated by automated AI and may contain errors. Do not trust its outputs without human verification.

Summary

  • Updates the Linux walkthrough to create and run the default configuration from ~/slicer/slicer.yaml.
  • Updates the systemd daemon guide to use ~/slicer and a default UNIX socket at ./slicer.sock.
  • Adds CLI endpoint discovery order for explicit flags, SLICER_URL, default socket, and loopback TCP fallback.
  • Keeps the walkthrough on the documented loopback TCP API configuration.
  • No blocking correctness, rendering, or reproducibility findings were identified in the scoped documentation diff.

Approval rating (1-10)

8/10. The documentation change is coherent and reproducible; remaining risk is limited to whether the new CLI discovery behavior is already released.

Summary per file

Summary per file
File path Summary
docs/getting-started/daemon.md Switches daemon setup to ~/slicer and documents socket-first endpoint discovery.
docs/getting-started/walkthrough.md Creates and runs the walkthrough config from ~/slicer/slicer.yaml.

Overall Assessment

The scoped changes are focused and internally consistent. The walkthrough still presents the generated TCP configuration, while the daemon guide now makes the systemd setup align with the default Linux socket path and explains how the CLI selects an endpoint. The commands preserve enough working-directory context for readers to reproduce the flow.

Detailed Review

Detailed Review

Content review

No blocking findings.

  • The title and existing page structure still match the edited content: the walkthrough remains a first-run Linux VM flow, and the daemon page remains a systemd setup guide.
  • The daemon guide now distinguishes the default UNIX socket setup from the TCP alternative clearly enough for readers choosing between local CLI access and loopback TCP.
  • The cd ~/slicer additions in both pages reduce ambiguity around relative paths such as ./slicer.yaml and ./slicer.sock.
  • The endpoint discovery paragraph is concise and placed immediately before the sudo slicer vm list example, which gives readers the context needed to understand why no explicit --url is required.

AI agent details.

Agent processing time: 56.043s
Environment preparation time: 3.157s
Total time from webhook: 1m3.229s

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant