Skip to content
Merged
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
27 changes: 27 additions & 0 deletions docs/guides/compile-servers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,33 @@ need to reclaim memory before doing something else heavy.

[Reference →](/docs/reference/cli/config/compile-server/)

## Idle self-shutdown

A shared server that hasn't served a client for a while shuts
itself down, so servers left behind by closed worktrees, JVM
bumps, or upgraded bleep binaries don't pile up and hold memory
indefinitely. The default is one hour.

```bash
bleep config compile-server idle-timeout 120 # minutes
bleep config compile-server idle-timeout 0 # never self-shut-down
bleep config compile-server idle-timeout-clear # back to default 60
```

The clock measures **fully-idle** time only: it resets whenever a
client connects and stays reset for as long as any client is
connected. So a long compile, or an editor left open over lunch,
keeps the server alive — the timeout only fires once nothing has
been connected for the whole window. When it does fire, the server
releases its lock and removes its socket files, so the next `bleep`
command in that workspace just starts a fresh one.

This is different from the [idle read timeout](#idle-read-timeout)
below: that drops a single stuck *connection*; this retires the
whole *server* once it has been unused for long enough.

[Reference →](/docs/reference/cli/config/compile-server/)

## Memory

The compile server holds Zinc analysis, compiler state, and live
Expand Down
20 changes: 20 additions & 0 deletions docs/reference/cli/config/compile-server.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -88,3 +88,23 @@ bleep config compile-server read-timeout <minutes>

<p>remove read timeout setting (use default: 30 minutes)</p>

## `bleep config compile-server idle-timeout`

<p>set minutes the server stays alive with no connected client before shutting itself down, 0 to stay alive forever (default: 60)</p>

### Synopsis

```bash
bleep config compile-server idle-timeout <minutes>
```

### Arguments

| Argument | Type |
|----------|------|
| `minutes` | one |

## `bleep config compile-server idle-timeout-clear`

<p>remove idle timeout setting (use default: 60 minutes)</p>

6 changes: 3 additions & 3 deletions docs/reference/cli/remote-cache/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ title: bleep remote-cache

# `bleep remote-cache`

<p>push and pull compiled classes to/from a remote S3-compatible cache</p>
<p>push and pull compiled classes to/from a build cache (S3-compatible service or local directory)</p>

## Synopsis

Expand All @@ -18,6 +18,6 @@ bleep remote-cache <subcommand> [args] [flags]

## Subcommands

- [`bleep remote-cache pull`](./pull): pull cached compiled classes from remote cache
- [`bleep remote-cache push`](./push): push compiled classes to remote cache
- [`bleep remote-cache pull`](./pull): pull cached compiled classes from the cache
- [`bleep remote-cache push`](./push): push compiled classes to the cache

2 changes: 1 addition & 1 deletion docs/reference/cli/remote-cache/pull.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ title: bleep remote-cache pull

# `bleep remote-cache pull`

<p>pull cached compiled classes from remote cache</p>
<p>pull cached compiled classes from the cache</p>

## Synopsis

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cli/remote-cache/push.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ title: bleep remote-cache push

# `bleep remote-cache push`

<p>push compiled classes to remote cache</p>
<p>push compiled classes to the cache</p>

## Synopsis

Expand Down