@boxes-dev/dvb-runtime 1.0.1098 → 1.0.1100
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/agent-init-guides/git-ssh.md +2 -2
- package/dist/bin/dvb.mjs +121 -72
- package/dist/bin/dvbd.mjs +6 -6
- package/dist/postgres-tools/SHA256SUMS +32 -8
- package/dist/postgres-tools/linux-arm64-el8/bin/pg_dump +0 -0
- package/dist/postgres-tools/linux-arm64-el8/bin/pg_restore +0 -0
- package/dist/postgres-tools/linux-arm64-el8/lib/libpq.so.5 +0 -0
- package/dist/postgres-tools/linux-arm64-el8/notices/PostgreSQL-COPYRIGHT.txt +23 -0
- package/dist/postgres-tools/linux-arm64-el9/bin/pg_dump +0 -0
- package/dist/postgres-tools/linux-arm64-el9/bin/pg_restore +0 -0
- package/dist/postgres-tools/linux-arm64-el9/lib/libpq.so.5 +0 -0
- package/dist/postgres-tools/linux-arm64-el9/notices/PostgreSQL-COPYRIGHT.txt +23 -0
- package/dist/postgres-tools/linux-arm64-ubuntu22.04/bin/pg_dump +0 -0
- package/dist/postgres-tools/linux-arm64-ubuntu22.04/bin/pg_restore +0 -0
- package/dist/postgres-tools/linux-arm64-ubuntu22.04/lib/libpq.so.5 +0 -0
- package/dist/postgres-tools/linux-x64-el8/bin/pg_dump +0 -0
- package/dist/postgres-tools/linux-x64-el8/bin/pg_restore +0 -0
- package/dist/postgres-tools/linux-x64-el8/lib/libpq.so.5 +0 -0
- package/dist/postgres-tools/linux-x64-el8/notices/PostgreSQL-COPYRIGHT.txt +23 -0
- package/dist/postgres-tools/linux-x64-el9/bin/pg_dump +0 -0
- package/dist/postgres-tools/linux-x64-el9/bin/pg_restore +0 -0
- package/dist/postgres-tools/linux-x64-el9/lib/libpq.so.5 +0 -0
- package/dist/postgres-tools/linux-x64-el9/notices/PostgreSQL-COPYRIGHT.txt +23 -0
- package/dist/postgres-tools/linux-x64-ubuntu22.04/bin/pg_dump +0 -0
- package/dist/postgres-tools/linux-x64-ubuntu22.04/bin/pg_restore +0 -0
- package/dist/postgres-tools/linux-x64-ubuntu22.04/lib/libpq.so.5 +0 -0
- package/dist/postgres-tools/linux-x64-ubuntu22.04/notices/PostgreSQL-and-Debian-copyright.txt +270 -0
- package/dist/postgres-tools/linux-x64-ubuntu24.04/notices/PostgreSQL-and-Debian-copyright.txt +270 -0
- package/dist/postgres-tools/release.json +306 -18
- package/dist/product-docs/references/agent-tools.md +6 -7
- package/dist/product-docs/references/automations.md +4 -4
- package/dist/product-docs/references/aws.md +17 -11
- package/dist/product-docs/references/billing-and-limits.md +26 -13
- package/dist/product-docs/references/cli.md +14 -15
- package/dist/product-docs/references/convex.md +92 -0
- package/dist/product-docs/references/core-concepts.md +35 -30
- package/dist/product-docs/references/desktop-workbench.md +62 -47
- package/dist/product-docs/references/files-git-and-review.md +14 -15
- package/dist/product-docs/references/fork-workflows.md +26 -25
- package/dist/product-docs/references/getting-started.md +11 -12
- package/dist/product-docs/references/glossary.md +46 -22
- package/dist/product-docs/references/google-cloud.md +13 -8
- package/dist/product-docs/references/index.md +20 -16
- package/dist/product-docs/references/linear.md +2 -2
- package/dist/product-docs/references/managed-environment-files.md +1 -1
- package/dist/product-docs/references/member-managed-files.md +4 -4
- package/dist/product-docs/references/mobile.md +18 -16
- package/dist/product-docs/references/onbox-agent-tools.md +63 -41
- package/dist/product-docs/references/ports-terminal-and-runtime.md +31 -28
- package/dist/product-docs/references/project-setup.md +15 -12
- package/dist/product-docs/references/security-and-data.md +23 -13
- package/dist/product-docs/references/slack.md +45 -7
- package/dist/product-docs/references/tailscale.md +2 -2
- package/dist/product-docs/references/team-template.md +26 -23
- package/dist/product-docs/references/template-box-environment.md +7 -3
- package/dist/product-docs/references/threads-and-agents.md +48 -24
- package/dist/product-docs/references/troubleshooting.md +24 -25
- package/package.json +2 -2
- /package/dist/postgres-tools/{linux-arm64 → linux-arm64-ubuntu22.04}/notices/PostgreSQL-and-Debian-copyright.txt +0 -0
- /package/dist/postgres-tools/{linux-arm64 → linux-arm64-ubuntu24.04}/bin/pg_dump +0 -0
- /package/dist/postgres-tools/{linux-arm64 → linux-arm64-ubuntu24.04}/bin/pg_restore +0 -0
- /package/dist/postgres-tools/{linux-arm64 → linux-arm64-ubuntu24.04}/lib/libpq.so.5 +0 -0
- /package/dist/postgres-tools/{linux-x64 → linux-arm64-ubuntu24.04}/notices/PostgreSQL-and-Debian-copyright.txt +0 -0
- /package/dist/postgres-tools/{linux-x64 → linux-x64-ubuntu24.04}/bin/pg_dump +0 -0
- /package/dist/postgres-tools/{linux-x64 → linux-x64-ubuntu24.04}/bin/pg_restore +0 -0
- /package/dist/postgres-tools/{linux-x64 → linux-x64-ubuntu24.04}/lib/libpq.so.5 +0 -0
|
@@ -6,10 +6,10 @@ why a setup step is waiting, how to resume setup, or how to add another project.
|
|
|
6
6
|
## What Setup Creates
|
|
7
7
|
|
|
8
8
|
The local-folder, agent-driven, and direct GitHub setup paths described here
|
|
9
|
-
create one
|
|
9
|
+
create one independent project with one Template box. The Template box is the
|
|
10
10
|
persistent base machine for that project. After setup, future devboxes start
|
|
11
11
|
from snapshots of this Template box. A Team Template can separately enable
|
|
12
|
-
**
|
|
12
|
+
**managed projects**, which have no personal Template box; see
|
|
13
13
|
`team-template.md` for that flow.
|
|
14
14
|
|
|
15
15
|
The desktop app's Project step recommends agent-driven setup first: the user's
|
|
@@ -169,7 +169,7 @@ If the desktop window reloads, the app rediscovers the matching local setup and
|
|
|
169
169
|
continues the secure bundle handoff. The setup progress banner also provides
|
|
170
170
|
**Resume setup** while the desktop still needs to finish the handoff, then
|
|
171
171
|
**Open setup thread** once the setup agent is running. Once bundle extraction
|
|
172
|
-
is complete,
|
|
172
|
+
is complete, independent project actions become available while the setup thread
|
|
173
173
|
continues.
|
|
174
174
|
|
|
175
175
|
## Agent-Driven Setup From The Terminal
|
|
@@ -543,8 +543,8 @@ Company AWS access is managed separately from project setup under
|
|
|
543
543
|
sign-in and chooses one assigned account and role for the project, or enters an
|
|
544
544
|
IAM user's access key. boxes.dev then applies the managed `boxes-dev` profile to
|
|
545
545
|
the Template box and devboxes without changing the repository or requiring a
|
|
546
|
-
new snapshot. Open
|
|
547
|
-
|
|
546
|
+
new snapshot. Open terminals pick up the change at their next prompt, and
|
|
547
|
+
agent sessions before their next turn. See `aws.md` for profile precedence, central refresh, removal, and
|
|
548
548
|
container limits.
|
|
549
549
|
|
|
550
550
|
Project setup Codex scans may use the user's local Codex sign-in on this
|
|
@@ -629,7 +629,7 @@ Canceling setup or deleting the boxes.dev project does not delete a repository
|
|
|
629
629
|
created on GitHub.
|
|
630
630
|
|
|
631
631
|
A project created through this direct GitHub path can contain up to 20 selected
|
|
632
|
-
repositories, but it still creates exactly one
|
|
632
|
+
repositories, but it still creates exactly one independent project and one
|
|
633
633
|
Template box. Setup starts in
|
|
634
634
|
single-repository mode; switching it to multiple repositories is an explicit
|
|
635
635
|
choice to combine several repositories into one project. With one repository,
|
|
@@ -832,9 +832,12 @@ to the recommended defaults.
|
|
|
832
832
|
Packaged desktop and CLI setup include `pg_dump` for approved Postgres database
|
|
833
833
|
copies. Setup continues to prefer a usable `pg_dump` already on `PATH`, then
|
|
834
834
|
uses the included client when the host command is missing or is older than the
|
|
835
|
-
source server.
|
|
836
|
-
|
|
837
|
-
|
|
835
|
+
source server. On Linux, the included client runs on Ubuntu 22.04 and newer,
|
|
836
|
+
Debian 12 and newer, Fedora, Arch, openSUSE Tumbleweed, and RHEL 8 and 9 and
|
|
837
|
+
their rebuilds such as Rocky Linux and AlmaLinux. On other distributions it may
|
|
838
|
+
not start, and setup then asks for `pg_dump` on `PATH`. If the included payload
|
|
839
|
+
is unavailable, or the Postgres server is newer than the included client, setup
|
|
840
|
+
explains how to update or reinstall boxes.dev or use a compatible host client. The user can also skip that database
|
|
838
841
|
if its local data is not essential. MySQL copies still require `mysqldump` on
|
|
839
842
|
`PATH`. If a MySQL dump fails, setup explains how to use a client from the same
|
|
840
843
|
MySQL or MariaDB family and major or LTS release as the local server. The user
|
|
@@ -1107,10 +1110,10 @@ To upload another local project, use **New project...** in the titlebar project
|
|
|
1107
1110
|
selector or **File > New Project...** in the desktop app. On the website,
|
|
1108
1111
|
**New project** offers the coding-agent prompt and **Create from GitHub**. For
|
|
1109
1112
|
a repository that is not on the user's computer, **Create from GitHub** clones
|
|
1110
|
-
another GitHub-backed
|
|
1111
|
-
environment setup afterwards. Each
|
|
1113
|
+
another GitHub-backed independent project instead, with the same manual
|
|
1114
|
+
environment setup afterwards. Each independent project made through
|
|
1112
1115
|
these paths gets its own setup flow and Template box. A Team Template's
|
|
1113
|
-
|
|
1116
|
+
managed-project path is the exception: it creates a managed project
|
|
1114
1117
|
without a personal Template box and uses the Team Template's current saved
|
|
1115
1118
|
version for future devboxes. Existing agent auth can be reused by local-folder
|
|
1116
1119
|
setup, but each local project still needs its own folder selection, scans,
|
|
@@ -127,9 +127,12 @@ Slack, Linear, and GitHub integrations are authorized through their own OAuth
|
|
|
127
127
|
flows. Their tokens are stored encrypted by boxes.dev and used to perform the
|
|
128
128
|
integration actions the user or team enabled.
|
|
129
129
|
|
|
130
|
-
Disconnecting Slack stops
|
|
131
|
-
|
|
132
|
-
|
|
130
|
+
Disconnecting Slack stops Slack triggers, automation posts, and agent access to
|
|
131
|
+
Slack for the team. Data stored for the Slack connection is deleted within
|
|
132
|
+
14 business days, as it is when the app is uninstalled from Slack. The team's
|
|
133
|
+
boxes.dev threads and saved automation settings remain. See the
|
|
134
|
+
[privacy policy](https://boxes.dev/privacy#slack-retention) for retention details and how
|
|
135
|
+
to request deletion.
|
|
133
136
|
|
|
134
137
|
Disconnecting Linear stops future Linear assignment triggers for the team.
|
|
135
138
|
Existing boxes.dev threads remain.
|
|
@@ -144,14 +147,14 @@ disconnecting the main GitHub connection.
|
|
|
144
147
|
|
|
145
148
|
When automatic Git access uses the GitHub App, the connected user's App
|
|
146
149
|
credential remains encrypted at rest in boxes.dev. When Git needs access, the
|
|
147
|
-
machine requests that credential through a local helper. For
|
|
150
|
+
machine requests that credential through a local helper. For independent projects,
|
|
148
151
|
boxes.dev first checks the machine's ownership and that the connected user can
|
|
149
152
|
read the requested repository. GitHub enforces write permissions when pushing.
|
|
150
153
|
The token can exist in the boxes.dev service, local
|
|
151
154
|
service, Git process, and snapshot process memory, but is not written to the
|
|
152
155
|
remote URL or a managed credential file.
|
|
153
156
|
|
|
154
|
-
|
|
157
|
+
Independent project checkout selection does not restrict Git access. Code running
|
|
155
158
|
on the box can request and inspect the App credential,
|
|
156
159
|
whose access is the intersection of the connected user's repositories and the
|
|
157
160
|
repositories and permissions granted to the boxes.dev GitHub App. Current App
|
|
@@ -166,7 +169,7 @@ removing App access stops future App helper issuance after its bounded cache
|
|
|
166
169
|
lease, but does not itself revoke an App token already returned to a process.
|
|
167
170
|
GitHub attributes the Git operation to the connected user.
|
|
168
171
|
|
|
169
|
-
|
|
172
|
+
Managed projects retain their separate release-bound repository
|
|
170
173
|
checks. Team Template editing uses repository-restricted App installation
|
|
171
174
|
credentials rather than an administrator's broad user credential.
|
|
172
175
|
|
|
@@ -265,7 +268,7 @@ Template boxes and devboxes are full cloud Linux development machines. Agents
|
|
|
265
268
|
and users can run commands, edit files, install dependencies, open ports, and
|
|
266
269
|
interact with local services inside either machine.
|
|
267
270
|
|
|
268
|
-
A
|
|
271
|
+
A managed project has no personal Template box. Team admins author
|
|
269
272
|
its shared saved files in separate Team Template editing machines, and members
|
|
270
273
|
cannot access those machines through their projects. Prepared devboxes belong
|
|
271
274
|
to one member and project. The team-authored startup script runs immediately
|
|
@@ -273,19 +276,19 @@ before the member's startup script, with the same prepared member credentials
|
|
|
273
276
|
and files available to both. Team admins are trusted authors of that code.
|
|
274
277
|
Once assigned to a draft, the devbox never returns to a prepared pool.
|
|
275
278
|
|
|
276
|
-
Anything available inside the selected
|
|
279
|
+
Anything available inside the selected box can usually be read or changed by
|
|
277
280
|
the agent running there. This includes checked-out code, local env files, local
|
|
278
281
|
databases, generated files, and credentials copied into the environment.
|
|
279
282
|
|
|
280
283
|
Devboxes are isolated from their source after they are created. A devbox has
|
|
281
284
|
its own filesystem, processes, ports, local database state, and agent threads.
|
|
282
|
-
Work done on a devbox does not automatically change an
|
|
285
|
+
Work done on a devbox does not automatically change an independent project's
|
|
283
286
|
Template box or a Team Template saved version. Move changes intentionally with
|
|
284
287
|
Git or another explicit workflow.
|
|
285
288
|
|
|
286
289
|
## Files, Transcripts, And Metadata
|
|
287
290
|
|
|
288
|
-
Most repository files and terminal/session history live on the selected
|
|
291
|
+
Most repository files and terminal/session history live on the selected box
|
|
289
292
|
filesystem. Product surfaces can stream or display those files and histories so
|
|
290
293
|
users can review work from desktop, mobile, web, or CLI.
|
|
291
294
|
|
|
@@ -295,9 +298,9 @@ status, detected ports, notification tokens, short session title summaries, and
|
|
|
295
298
|
limited snippets that support the UI.
|
|
296
299
|
|
|
297
300
|
boxes.dev stores thread transcript history so users can review conversation
|
|
298
|
-
history without waking the selected
|
|
301
|
+
history without waking the selected box.
|
|
299
302
|
|
|
300
|
-
Forwarded ports expose local development services from the selected
|
|
303
|
+
Forwarded ports expose local development services from the selected box.
|
|
301
304
|
Users should treat forwarded apps as development surfaces and avoid exposing
|
|
302
305
|
production-admin tools or sensitive local dashboards unless that is intentional.
|
|
303
306
|
|
|
@@ -348,7 +351,7 @@ the legal privacy policy at `https://boxes.dev/privacy`.
|
|
|
348
351
|
|
|
349
352
|
Deleting a project permanently deletes its personal Template box when it has
|
|
350
353
|
one, its devboxes, snapshots, threads, and attached project data. Deleting a
|
|
351
|
-
|
|
354
|
+
managed project does not delete the shared Team Template or affect
|
|
352
355
|
another member's project. The product asks the user to type the project name
|
|
353
356
|
before deletion. Treat project deletion as irreversible.
|
|
354
357
|
|
|
@@ -378,6 +381,13 @@ one member deletes their account.
|
|
|
378
381
|
|
|
379
382
|
Account deletion is permanent and cannot be undone.
|
|
380
383
|
|
|
384
|
+
Copies of data deleted from active systems may remain in routine backups held
|
|
385
|
+
by boxes.dev or its service providers until normal backup rotation removes
|
|
386
|
+
them, unless the law requires longer retention. Retained copies remain
|
|
387
|
+
protected and may be used only for recovery, security, or legal compliance.
|
|
388
|
+
See `https://boxes.dev/delete-account` and `https://boxes.dev/privacy` for the
|
|
389
|
+
deletion and retention policies.
|
|
390
|
+
|
|
381
391
|
If a user cannot access their account, they can email hi@boxes.dev from the
|
|
382
392
|
email address on the account with the subject "Delete my boxes.dev account."
|
|
383
393
|
|
|
@@ -31,6 +31,21 @@ the **Account** step of first-run desktop setup when their team has no Slack
|
|
|
31
31
|
workspace yet. Slack opens an authorization screen; choose the workspace and
|
|
32
32
|
allow the app.
|
|
33
33
|
|
|
34
|
+
An install can also start in Slack. **Add to Slack** on `boxes.dev/slack`
|
|
35
|
+
opens Slack's authorization screen without a boxes.dev sign-in. After the
|
|
36
|
+
workspace approves the app, a boxes.dev page asks the person to sign in or
|
|
37
|
+
create an account, and a team admin chooses **Connect** to attach the
|
|
38
|
+
workspace to their team. They need to finish in the same browser within an
|
|
39
|
+
hour of approving the app in Slack. The success page lists the next steps,
|
|
40
|
+
including getting the desktop app and setting up a project for someone new to
|
|
41
|
+
boxes.dev.
|
|
42
|
+
|
|
43
|
+
When a new connection finishes either way, the app DMs the Slack user who
|
|
44
|
+
approved it with getting-started steps and links to the Slack help article and
|
|
45
|
+
support. A reinstall while the workspace is still connected, for example to add
|
|
46
|
+
permissions, sends no DM; a reinstall after an uninstall, a disconnect, or a
|
|
47
|
+
connection that needed a reinstall does.
|
|
48
|
+
|
|
34
49
|
After Slack redirects back, the Slack integration home continues through the
|
|
35
50
|
remaining setup steps: link your identity, create your automation, and activate
|
|
36
51
|
it. Team admins can expand **Team connection** there to inspect
|
|
@@ -38,9 +53,14 @@ permissions, known users, known channels, administrative activity, and
|
|
|
38
53
|
technical details. The same team-level information remains available in Team
|
|
39
54
|
Settings.
|
|
40
55
|
|
|
41
|
-
Disconnecting Slack stops
|
|
42
|
-
Slack
|
|
43
|
-
|
|
56
|
+
Disconnecting Slack stops Slack triggers, automation posts, and agent access to
|
|
57
|
+
Slack for the team. Data stored for the Slack connection is deleted within
|
|
58
|
+
14 business days. Uninstalling the app from the Slack workspace, or revoking
|
|
59
|
+
its bot token, does the same.
|
|
60
|
+
|
|
61
|
+
The team's boxes.dev threads and saved automation settings remain. See the
|
|
62
|
+
[privacy policy](https://boxes.dev/privacy#slack-retention) for retention details and how
|
|
63
|
+
to request deletion.
|
|
44
64
|
|
|
45
65
|
## Link Your Slack Identity
|
|
46
66
|
|
|
@@ -59,6 +79,12 @@ You can link by:
|
|
|
59
79
|
- opening the boxes.dev app DM in Slack and sending `connect`;
|
|
60
80
|
- following a connect link sent by a team admin from Team settings.
|
|
61
81
|
|
|
82
|
+
Until your Slack identity is linked, the app answers any mention or app DM from
|
|
83
|
+
you, including `help`, with a DM containing a connect link, the next setup
|
|
84
|
+
steps, and links to the Slack help article and support. The connect link works
|
|
85
|
+
whatever email your Slack profile uses; **Find my Slack account** matches your
|
|
86
|
+
boxes.dev email.
|
|
87
|
+
|
|
62
88
|
If boxes.dev cannot match your Slack user, verify your boxes.dev email and try
|
|
63
89
|
again from Slack.
|
|
64
90
|
|
|
@@ -160,8 +186,8 @@ would trust with that access, including on named commands that allow
|
|
|
160
186
|
teammates.
|
|
161
187
|
|
|
162
188
|
boxes.dev starts each automation run on a fresh devbox from the latest
|
|
163
|
-
Template box snapshot for an
|
|
164
|
-
Template version for a
|
|
189
|
+
Template box snapshot for an independent project, or the current saved Team
|
|
190
|
+
Template version for a managed project. The agent sees the automation prompt
|
|
165
191
|
plus Slack context, including the triggering message and available Slack
|
|
166
192
|
thread messages. If Slack context is incomplete, boxes.dev can start with
|
|
167
193
|
partial context instead of waiting forever.
|
|
@@ -269,12 +295,21 @@ unqualified follow-ups in that Slack thread go to the newest run.
|
|
|
269
295
|
|
|
270
296
|
Use Slack controls in the linked thread:
|
|
271
297
|
|
|
272
|
-
- `@boxes.dev !help`
|
|
298
|
+
- `@boxes.dev help` or `@boxes.dev !help` explains how to follow up, stop, and
|
|
299
|
+
cancel in that thread. It does not reach the agent.
|
|
273
300
|
- `@boxes.dev !stop` requests that the active agent turn stop.
|
|
274
301
|
- `@boxes.dev !cancel` cancels queued Slack follow-ups when possible.
|
|
275
302
|
|
|
303
|
+
Outside a linked thread, `help` or `!help` (mentioned, or sent alone in an app
|
|
304
|
+
DM) lists what the sender can start there: whether a plain request reaches
|
|
305
|
+
their Default behavior, and the named commands they may run. A bare `help`
|
|
306
|
+
never starts an agent; `help me with this bug` is an ordinary request. `!stop`
|
|
307
|
+
and `!cancel` outside a linked thread reply that they work only in the thread
|
|
308
|
+
where an agent started. `connect` from a sender whose Slack account is already
|
|
309
|
+
linked replies with that and the same help.
|
|
310
|
+
|
|
276
311
|
If the linked devbox is sleeping, boxes.dev may queue the follow-up while the
|
|
277
|
-
|
|
312
|
+
box wakes. If capacity is full, Slack replies with guidance when follow-up
|
|
278
313
|
confirmations are enabled.
|
|
279
314
|
|
|
280
315
|
## Slack Files
|
|
@@ -394,6 +429,9 @@ the workspace.
|
|
|
394
429
|
|
|
395
430
|
## Troubleshooting
|
|
396
431
|
|
|
432
|
+
To see what you can start in a conversation, mention `@boxes.dev help` there or
|
|
433
|
+
send `help` in the app DM.
|
|
434
|
+
|
|
397
435
|
If **Connect Slack** is missing, ask a boxes.dev team admin to connect the
|
|
398
436
|
workspace.
|
|
399
437
|
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# Tailscale Integration
|
|
2
2
|
|
|
3
3
|
The Tailscale integration connects a project's machines to a team's tailnet as
|
|
4
|
-
tagged, ephemeral Tailscale devices. For an
|
|
5
|
-
Template box and devboxes. A
|
|
4
|
+
tagged, ephemeral Tailscale devices. For an independent project, that includes its
|
|
5
|
+
Template box and devboxes. A managed project has no personal
|
|
6
6
|
Template box, so only its assigned devboxes connect. A team admin connects the
|
|
7
7
|
tailnet once, and each project owner verifies their own access before enabling
|
|
8
8
|
the integration for that project. No one signs in to Tailscale separately on
|
|
@@ -7,11 +7,11 @@ Template.
|
|
|
7
7
|
## What The Team Template Is
|
|
8
8
|
|
|
9
9
|
A Team Template is one named, team-wide starting environment for new projects.
|
|
10
|
-
It is separate from each
|
|
10
|
+
It is separate from each independent project's Template box. A team can keep
|
|
11
11
|
several Team Templates for different project shapes—for example, a website
|
|
12
12
|
playground, a full-stack application, and backend services. Each Team Template
|
|
13
13
|
has one latest saved version. The ordinary creation path gives a new project
|
|
14
|
-
an independent Template box copied from that version. The optional **
|
|
14
|
+
an independent Template box copied from that version. The optional **managed
|
|
15
15
|
projects** mode instead gives the member no Template box and uses the Team
|
|
16
16
|
Template's current saved version for each future devbox.
|
|
17
17
|
|
|
@@ -24,8 +24,8 @@ environment.
|
|
|
24
24
|
Team Templates are available to every team without an enablement step.
|
|
25
25
|
|
|
26
26
|
Any current team member can inspect the team's available Team Templates. A
|
|
27
|
-
member can create an
|
|
28
|
-
version.
|
|
27
|
+
member can create an independent project from a template only when it has a saved
|
|
28
|
+
version. Managed-project creation also requires an admin to enable it on that
|
|
29
29
|
Team Template. Only team admins can create, rename, archive, or restore
|
|
30
30
|
templates; edit them; save new versions; use an older
|
|
31
31
|
version; or remove an older version.
|
|
@@ -37,7 +37,7 @@ assigned to its admin if the desktop app closes or the machine sleeps.
|
|
|
37
37
|
|
|
38
38
|
The saved environment is separate from every admin editing session. After a
|
|
39
39
|
successful save, boxes.dev keeps the cleaned environment asleep as the shared
|
|
40
|
-
source for later editing sessions and
|
|
40
|
+
source for later editing sessions and managed-project devboxes. It is not a
|
|
41
41
|
Template box that admins or members can open. Discarding an editing session
|
|
42
42
|
therefore removes only that unsaved session and never changes the shared saved
|
|
43
43
|
environment.
|
|
@@ -59,7 +59,7 @@ uses permanent project deletion and requires confirmation for each project.
|
|
|
59
59
|
Keep moves the project to the departing account's fresh personal team and
|
|
60
60
|
removes managed files, managed secrets, team access, and existing thread
|
|
61
61
|
sharing. Ordinary files and unmanaged environment-file content remain.
|
|
62
|
-
A kept
|
|
62
|
+
A kept managed project receives an independent Template box.
|
|
63
63
|
|
|
64
64
|
Sleeping boxes remain asleep during Transfer and Keep. Ownership and team
|
|
65
65
|
access change during removal; managed files and credentials are cleaned up on
|
|
@@ -89,7 +89,10 @@ compute; the former team's payment method and credits remain on that team.
|
|
|
89
89
|
## Finding And Managing Team Templates
|
|
90
90
|
|
|
91
91
|
Team admins can open **Team Templates** from the desktop project selector or
|
|
92
|
-
from **
|
|
92
|
+
from **Settings → Team and members → Manage Team Templates**. The global
|
|
93
|
+
settings pane's **Related settings → Team Template settings** link opens the
|
|
94
|
+
selected project's associated template, or the collection when there is no
|
|
95
|
+
source template. The project-selector submenu
|
|
93
96
|
links directly to each non-archived template and includes **New Team
|
|
94
97
|
Template...** and **View all Team Templates**. The collection shows each named
|
|
95
98
|
template separately, including its description, machine size, latest saved
|
|
@@ -158,7 +161,7 @@ settings in the order they are usually needed:
|
|
|
158
161
|
machine size, the editing status and **Take control** action, plus rows for
|
|
159
162
|
**Maintenance**, the **Cleanup before saving** script, and **Previous
|
|
160
163
|
versions**.
|
|
161
|
-
- **
|
|
164
|
+
- **Projects from this template**: whether this template creates independent or managed
|
|
162
165
|
projects, and the **Pause new projects** / **Resume new projects** control
|
|
163
166
|
for managed templates.
|
|
164
167
|
- **When a new devbox is created**: the startup and teardown sequence with the
|
|
@@ -180,7 +183,7 @@ settings**, save it, then restore the archived template.
|
|
|
180
183
|
An archived template's name and description remain editable. Restore it before
|
|
181
184
|
changing other settings or running maintenance.
|
|
182
185
|
|
|
183
|
-
The **
|
|
186
|
+
The **Projects from this template** card explains which kind of project the template
|
|
184
187
|
creates. A template creates independent projects until an admin chooses **Set
|
|
185
188
|
up managed projects…**; the confirmation states that members will get no
|
|
186
189
|
Template box of their own, that new devboxes will start from the latest saved
|
|
@@ -319,20 +322,20 @@ permissions.
|
|
|
319
322
|
|
|
320
323
|
For managed projects, the admin chooses one of two modes:
|
|
321
324
|
|
|
322
|
-
- **Editable defaults:** each
|
|
325
|
+
- **Editable defaults:** each managed project follows the template's values
|
|
323
326
|
until the member changes a permission in Project settings. A permission the
|
|
324
327
|
member changed stays as they set it when the template changes. **Use Team
|
|
325
328
|
Template permissions** in Project settings returns every permission to the
|
|
326
329
|
template's values.
|
|
327
|
-
- **Locked:** every
|
|
330
|
+
- **Locked:** every managed project uses the template's values, and members
|
|
328
331
|
can't change them in Project settings. Locking replaces any permissions
|
|
329
332
|
members chose themselves. Unlocking keeps everyone on the template's values
|
|
330
333
|
until a member changes one.
|
|
331
334
|
|
|
332
335
|
The first time an admin saves editable defaults for a template that already
|
|
333
|
-
has
|
|
336
|
+
has managed projects, boxes.dev asks whether those projects should move to the
|
|
334
337
|
template's values or keep their current permissions as the members' own
|
|
335
|
-
choices. Either way, new
|
|
338
|
+
choices. Either way, new managed projects will follow the template.
|
|
336
339
|
|
|
337
340
|
In both modes, members can still change permissions on an individual box from
|
|
338
341
|
its thread header, and agents can still request permission for their own box.
|
|
@@ -386,7 +389,7 @@ no provider credentials, identities, automation settings, or machine state.
|
|
|
386
389
|
|
|
387
390
|
Box size is fixed for the Team Template lineage and is not a Project
|
|
388
391
|
default. Project creation offers no per-default overrides; members can change
|
|
389
|
-
the resulting
|
|
392
|
+
the resulting independent project afterward.
|
|
390
393
|
|
|
391
394
|
## Team Template Maintenance
|
|
392
395
|
|
|
@@ -408,7 +411,7 @@ to establish its shared saved environment. A failure preserves the prior saved
|
|
|
408
411
|
version, discards any machine that may have been partly changed, and never
|
|
409
412
|
modifies an admin's editing session.
|
|
410
413
|
|
|
411
|
-
boxes.dev prepares a few devboxes for each
|
|
414
|
+
boxes.dev prepares a few devboxes for each managed project ahead of time. For a
|
|
412
415
|
minute or two after a maintenance run makes a new saved version current, while
|
|
413
416
|
those are replaced, a new devbox can start from one prepared from the previous
|
|
414
417
|
saved version if the startup and teardown scripts and the box size have not
|
|
@@ -425,11 +428,11 @@ repositories, then choose **Refresh repository access** on the
|
|
|
425
428
|
maintenance failure before running it again. Repair refreshes only repositories
|
|
426
429
|
the Team Template already tracks; it does not add or replace a repository.
|
|
427
430
|
|
|
428
|
-
|
|
431
|
+
Independent projects created with a personal Template box receive an independent
|
|
429
432
|
maintenance policy and watches containing only the saved behavior. Their
|
|
430
433
|
schedules start at the next future occurrence, and enabled watches establish a
|
|
431
434
|
fresh repository baseline without an initial run. Authorization, repository
|
|
432
|
-
baselines, run history, errors, and other live state are never copied.
|
|
435
|
+
baselines, run history, errors, and other live state are never copied. Managed
|
|
433
436
|
projects do not copy or run Team Template maintenance; their future devboxes
|
|
434
437
|
use the Team Template's current saved files instead.
|
|
435
438
|
|
|
@@ -489,7 +492,7 @@ environment in the background and keeps the current version active until the
|
|
|
489
492
|
older one is ready; the page shows preparation progress or a retryable failure.
|
|
490
493
|
The next save still receives the next version number. Removing an inactive
|
|
491
494
|
version requires a reason, prevents new work from starting from it, and cancels
|
|
492
|
-
project creation still in progress from it.
|
|
495
|
+
project creation still in progress from it. Independent projects that already
|
|
493
496
|
received their independent Template box continue to work. Saving, changing the
|
|
494
497
|
current version, removal, and cleanup on one Team Template do not change
|
|
495
498
|
another.
|
|
@@ -546,7 +549,7 @@ permanently. A later provider disconnection may show the ordinary integration
|
|
|
546
549
|
warning, but it does not reopen setup or block project use. Later Team Template
|
|
547
550
|
requirement changes apply only to new projects.
|
|
548
551
|
|
|
549
|
-
In a
|
|
552
|
+
In a managed project, an untouched new-devbox draft uses the ordinary composer
|
|
550
553
|
and notes that sending creates a devbox from the team's Template. A new thread
|
|
551
554
|
on an existing devbox shows neither that note nor new-devbox blockers. For a
|
|
552
555
|
new-devbox draft, a missing agent connection, missing GitHub repository access,
|
|
@@ -572,7 +575,7 @@ The new project is independent of later Team Template versions and save cleanup.
|
|
|
572
575
|
When removing a member, an admin chooses whether to transfer, delete, or let
|
|
573
576
|
that member keep each project under the removal rules above.
|
|
574
577
|
Creating it uses a normal project slot and its
|
|
575
|
-
|
|
578
|
+
box uses the member's normal billing entitlement.
|
|
576
579
|
|
|
577
580
|
Setup instructions are current Project defaults, not part of the filesystem
|
|
578
581
|
save cadence. If instructions are present and the selected agent is authenticated,
|
|
@@ -629,11 +632,11 @@ a GitHub connection unless another configured feature requires it.
|
|
|
629
632
|
## Files And Credentials Included In A Saved Version
|
|
630
633
|
|
|
631
634
|
Team admins are trusted authors of the shared environment. Saving removes
|
|
632
|
-
boxes.dev-managed
|
|
635
|
+
boxes.dev-managed box identity and session state before capture, but it
|
|
633
636
|
does not guess which team-authored files are secrets. Files deliberately left
|
|
634
637
|
in the environment—including `.env` files, databases, shell history, or
|
|
635
|
-
custom SSH and cloud credentials—are copied into
|
|
636
|
-
|
|
638
|
+
custom SSH and cloud credentials—are copied into independent projects and into
|
|
639
|
+
managed-project devboxes that use the saved version.
|
|
637
640
|
|
|
638
641
|
The short-lived GitHub App token used during setup is removed after cloning.
|
|
639
642
|
The separate short-lived token used during editing is removed on pause and
|
|
@@ -128,7 +128,11 @@ in managed environment files, not in the script. The runner starts from a
|
|
|
128
128
|
login shell, then runs the script with noninteractive bash and
|
|
129
129
|
`set -e -o pipefail`, with `HOME=/home/boxes` and `/opt/devbox-tools/bin` first
|
|
130
130
|
on PATH. Interactive `~/.bashrc` setup, such as nvm's shell hook, does not
|
|
131
|
-
load.
|
|
131
|
+
load. When the project is connected to AWS or Google Cloud, the script
|
|
132
|
+
receives the same defaults as a new terminal, so `aws` and `gcloud` act as the
|
|
133
|
+
project owner. A tool that writes an access token to a file during
|
|
134
|
+
maintenance, such as a package registry login, leaves it in the snapshot that
|
|
135
|
+
new devboxes copy, so the script should delete that file before it exits. Agent setup tests a proposed script twice in this environment before
|
|
132
136
|
saving it.
|
|
133
137
|
Automatic scheduling is optional; the supported cadences are every 6 hours,
|
|
134
138
|
every 12 hours, nightly, and weekly.
|
|
@@ -183,7 +187,7 @@ indicator. Provider-side detection failures stay visible on the affected watch
|
|
|
183
187
|
without raising that red indicator; retry them and contact support if they
|
|
184
188
|
persist.
|
|
185
189
|
|
|
186
|
-
The desktop workbench also shows the owner of an
|
|
190
|
+
The desktop workbench also shows the owner of an independent project a maintenance
|
|
187
191
|
attention banner. **Maintenance settings** opens the relevant card. A failed
|
|
188
192
|
or timed-out script offers **Ask an agent to fix it**, which creates a fresh,
|
|
189
193
|
unsent Template box draft with the full saved script, the failed run's script
|
|
@@ -199,7 +203,7 @@ inaccessible repositories and other branches, and names the most-behind
|
|
|
199
203
|
repository when there are several. Any saved policy suppresses this reminder.
|
|
200
204
|
After dismissal it returns only after seven days and at least 100 additional
|
|
201
205
|
missing commits. Both dismissals are per viewer, Template and device. These
|
|
202
|
-
banners apply to
|
|
206
|
+
banners apply to independent projects; Team Template administration has its own
|
|
203
207
|
maintenance workflow.
|
|
204
208
|
|
|
205
209
|
Maintenance and snapshot creation never overlap, but maintenance may interrupt
|