Skip to content

Commit e34a646

Browse files
authored
Merge pull request #361 from flox/djsauble/automated_env_upgrades
Automated environment upgrades
2 parents 2791198 + b738ea7 commit e34a646

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

docs/concepts/floxhub.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,40 @@ Packages that were added manually in a text editor or with
7373
* **Settings tab**: displays key information about your environment, like the
7474
owner and its name.
7575

76+
### Automated upgrades
77+
78+
--8<-- "paid-feature.md"
79+
80+
To avoid missing important updates to your packages, it's a best practice to regularly upgrade your environments.
81+
You can do this manually using the [`flox upgrade`][flox_upgrade] command or by clicking **Upgrade now** on the environment detail page in FloxHub.
82+
However, if you have an [Organization][organizations_concept], you can let FloxHub upgrade your environments automatically.
83+
84+
#### Configure environment upgrades
85+
86+
Automated upgrades are enabled by default for all environments in an organization.
87+
To change the default setting for an individual environment:
88+
89+
1. Sign in to [FloxHub][floxhub]
90+
2. Choose an environment in an organization for which you're a *writer* or *owner*
91+
3. Open that environment's detail page
92+
4. Go to **Settings** > **Automated Upgrades**
93+
5. Change the upgrade cadence to **Daily**
94+
95+
!!! note "If you want to turn off automated upgrades, choose **Never**."
96+
97+
#### Organization-wide upgrade policy
98+
99+
You may choose to opt-out of automated upgrades for new environments, or turn them off for all environments in an organization.
100+
To change your organization's upgrade policy:
101+
102+
1. Sign in to [FloxHub][floxhub]
103+
2. Go to the detail page for an organization for which you're an *owner*
104+
3. Go to **Settings** > **Automated Upgrades**
105+
4. Select **Enable for new environments** to automatically upgrade new environments every day.
106+
5. Select **Pause for all environments** to disable automated upgrades for all environments in this organization.
107+
108+
!!! warning "We do not recommend disabling automated upgrades for all environments, as this can lead to outdated dependencies and potential security vulnerabilities."
109+
76110
## Referring to FloxHub environments
77111

78112
When referring to FloxHub environments to perform remote operations in the CLI,
@@ -106,7 +140,9 @@ Run the [`flox auth logout`][flox_auth] command.
106140
[flox_edit]: ../man/flox-edit.md
107141
[flox_install]: ../man/flox-install.md
108142
[flox_uninstall]: ../man/flox-uninstall.md
143+
[flox_upgrade]: ../man/flox-upgrade.md
109144
[generation_concept]: ../concepts/generations.md
110145
[manifest_concept]: ../concepts/environments.md#manifesttoml
111146
[environments_concept]: ../concepts/environments.md
112147
[organizations_concept]: ../concepts/organizations.md
148+
[floxhub]: https://hub.flox.dev

0 commit comments

Comments
 (0)