Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
49 changes: 49 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,55 @@ podman run -p 8000:8000 \

Please refer to the official Podman docs for [mounting external volumes](https://docs.podman.io/en/latest/markdown/podman-run.1.html#mounting-external-volumes) and [user namespace mode](https://https://docs.podman.io/en/latest/markdown/podman-run.1.html#userns-mode) for more information.

## Switching databases at runtime

The **DB** menu in the sidebar lets you switch the active database without restarting the server. Three modes are supported:

- **File-based** — open a database file on the local filesystem
- **In-memory** — temporary database; all data is lost on restart
- **Remote (SSH)** — mount a database from a remote machine over SSH

### Remote (SSH) mode

SSH mode uses `sshfs` to mount the remote directory on the machine running Ladybug Explorer and opens the database from the mount point directly. Changes are written through to the remote machine in real time.

**Requirements on the machine running Ladybug Explorer:**

*Linux*

| Dependency | Required when | How to install |
|---|---|---|
| `sshfs` | Always for SSH mode | `sudo apt install sshfs` or `sudo dnf install fuse-sshfs` |
| `/dev/fuse` | Always for SSH mode | Kernel FUSE module — present by default on most distributions |
| `sshpass` | Password auth only | `sudo apt install sshpass` or `sudo dnf install sshpass` |

*macOS*

macOS does not include FUSE support by default. Install [macFUSE](https://osxfuse.github.io/) first, then allow its kernel extension in **System Settings → Privacy & Security** (a reboot may be required). On Apple Silicon, disabling SIP may additionally be needed — see the [macFUSE FAQ](https://github.com/osxfuse/osxfuse/wiki/FAQ).

```bash
brew install --cask macfuse
brew install gromgit/fuse/sshfs-mac # sshfs
brew install hudochenkov/sshpass/sshpass # only needed for password auth
```

Private key authentication does not require `sshpass` on any platform.

**Requirements on the remote machine:**

Only an SSH daemon (`sshd`) is needed. No additional software is required.

**When running via Docker**, grant the container access to FUSE:

```bash
docker run -p 8000:8000 \
--cap-add SYS_ADMIN \
--device /dev/fuse \
--rm lbugdb/explorer:latest
```

`sshfs` and (if using password auth) `sshpass` must also be present inside the container image.

## Documentation

For more information regarding launching and using Ladybug Explorer, please refer to the [documentation](https://docs.ladybugdb.com/visualization/lbug-explorer/).
Expand Down
29 changes: 26 additions & 3 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading