Skip to content

Run Slicer from the default Linux directory #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
welteki wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Run Slicer from the default Linux directory #35

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 8 additions & 13 deletions docs/getting-started/daemon.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ You can run one or many Slicer daemons in this way, just make sure the host grou
Let's say you wanted to create a service for a hostgroup named "vm":

```bash
mkdir -p ~/vm/
cd ~/vm/
slicer new vm > ./slicer.yaml
mkdir -p ~/slicer
cd ~/slicer
slicer new vm --socket ./slicer.sock > ./slicer.yaml
```

To listen on a UNIX port instead, use `slicer new vm --api-auth=false --api-bind ./slicer.sock > ./slicer.yaml`.
To listen on TCP instead, use `slicer new vm --api-bind 127.0.0.1 --api-port 8080 > ./slicer.yaml`.

Install and start the service:

Expand Down Expand Up @@ -62,16 +62,11 @@ export USER=alex
echo "$USER ALL=(ALL) NOPASSWD: /usr/local/bin/slicer" | sudo tee /etc/sudoers.d/$USER-slicer
```

Assuming you went for the UNIX socket option, you could run i.e.
The CLI looks for an explicit `--url/--socket` flag or `SLICER_URL` environment variable
first. Without either, it tries `~/slicer/slicer.sock`, then falls back to
`http://127.0.0.1:8080`.

```bash
sudo slicer --url ~/vm/slicer.sock vm list
HOSTNAME IP RAM CPUS STATUS CREATED TAGS
-------- -- --- ---- ------ ------- -----
vm-1 192.168.137.2 4GiB 2 Running 2026-02-27 16:30:53
```

For the TCP option (with the default port of 8080), you'd run:
To list VMs run:

```bash
sudo slicer vm list
Expand Down
7 changes: 5 additions & 2 deletions docs/getting-started/walkthrough.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ Slicer is a long lived process that can be run in the foreground or as a daemon
Config files can be copy and pasted from the docs, or you can generate one from a template by running the below, where `vm` is the name of the hostgroup.

```bash
slicer new vm > vm-image.yaml
mkdir -p ~/slicer
cd ~/slicer
slicer new vm > slicer.yaml
```

The default configuration uses a Linux bridge for networking, a disk image for storage, and the Firecracker hypervisor.
Expand Down Expand Up @@ -53,7 +55,8 @@ The `storage: image` setting means a disk image will be cloned from the root fil
Now, open a new terminal window, or ideally launch `tmux` so you can leave the binary running in the background.

```bash
sudo slicer up ./vm-image.yaml
cd ~/slicer
sudo slicer up ./slicer.yaml
```

Having customised the `github_user` to your own username, your SSH keys will have been fetched from your profile, and preinstalled into the VM.
Expand Down