Skip to content

Commit 3fbb96d

Browse files
docs: Add lite package page (#905)
1 parent 9d77220 commit 3fbb96d

2 files changed

Lines changed: 51 additions & 1 deletion

File tree

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
sidebar_position: 11
3+
---
4+
5+
# Lite Package
6+
7+
Alongside the regular Santa deployment package, we also make available a "lite"
8+
package, which is named `santa-lite-YYYY.X.pkg`. This package has Workshop-only
9+
components removed.
10+
11+
## Why does the Lite package exist?
12+
13+
Santa includes an optional network extension for adding telemetry of network
14+
events. While this extension can only be activated by Workshop customers, its
15+
mere presence on disk concerns some users, despite being inert without being
16+
connected to Workshop.
17+
18+
## What's the downside of the Lite package?
19+
20+
The Lite package is built from the same artifacts as the full package, then
21+
re-signed and re-notarized after removing components. It receives less testing -
22+
we run upgrade testing for each release but do not include the Lite variant, as
23+
it would significantly expand our test matrix.
24+
25+
Should you ever want to activate the removed features, you'll need to do a
26+
migration from Lite to full package.
27+
28+
## Should I use the Lite package?
29+
30+
If you're a Workshop customer: no, this will prevent certain features from
31+
working.
32+
33+
If you're not a Workshop customer: we recommend the full package. The Lite
34+
package only saves a few megabytes, and the removed components are inert without
35+
Workshop.
36+
37+
## Can I upgrade from Lite to full package?
38+
39+
_Yes_, but the Santa system extension will not be replaced unless the version
40+
number is higher. In practice the code for the running extension should be
41+
identical, but this scenario is not one we test. You may also find systems
42+
reporting that they're running the Lite version after being replaced with the
43+
full version until the machines reboot.
44+
45+
## Can I downgrade from the full package to Lite?
46+
47+
_Yes_ with the same caveat as above and another exception: if Santa is connected
48+
to Workshop it will block a downgrade to the Lite package to avoid breaking
49+
functionality.
50+

docs/docs/deployment/troubleshooting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 11
2+
sidebar_position: 12
33
---
44

55
# Troubleshooting

0 commit comments

Comments
 (0)