From e5f23f41cc07c6f21d2db8a2ce3765aa38138667 Mon Sep 17 00:00:00 2001 From: Tim Mullin Date: Thu, 1 Feb 2024 00:25:52 +0000 Subject: [PATCH] Document possible statuses in /var/cpanel/elevate Case RE-55: Fixes #330 --- docs-website-src/content/_index.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs-website-src/content/_index.md b/docs-website-src/content/_index.md index b124be4d..11cd9aaf 100644 --- a/docs-website-src/content/_index.md +++ b/docs-website-src/content/_index.md @@ -257,6 +257,21 @@ You can check the current status of the elevation process by running: /scripts/elevate-cpanel --status ``` +### Where are the current stage and status stored? + +They are stored in the JSON file `/var/cpanel/elevate` as values for the +`stage_number` and `status` keys. + +During execution `stage_number` will be set to `1` through `5`. Upon +completion the `stage_number` will be set to `6`. + +The possible values for `status` are: + +* `running` +* `paused` +* `success` +* `failed` + ### How to check elevate log? The main log from the `/scripts/elevate-cpanel` can be read by running: