From 205915d42fd309d3baf34d3faf04253699e0d981 Mon Sep 17 00:00:00 2001 From: Joachim Nilsson Date: Sat, 30 Dec 2017 21:58:26 +0100 Subject: [PATCH] Document new `rescue` (recovery) mode Signed-off-by: Joachim Nilsson --- README.md | 1 + doc/build.md | 18 ++++++++++++++++++ 2 files changed, 19 insertions(+) diff --git a/README.md b/README.md index a7f1eaff..8b426da7 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,7 @@ * [Commands & Status](#commands--status) * [Building](doc/build.md#building) * [Running](doc/build.md#running) + * [Recovery](doc/build.md#recovery) * [Debugging](doc/build.md#debugging) * [Requirements](#requirements) * [Origin & References](#origin--references) diff --git a/doc/build.md b/doc/build.md index 85863943..dd193635 100644 --- a/doc/build.md +++ b/doc/build.md @@ -124,6 +124,24 @@ append="init=/sbin/finit" Remember to also set up an initial `/etc/finit.conf` before rebooting! +Recovery +-------- + +To rescue a system with Finit, append the following to the kernel +command line: + +```shell +append="init=/sbin/finit rescue" +``` + +This tells Finit to start in a very limited recovery mode, no services +are loaded, no filesystems are mounted or checked, and no networking is +enabled. The default Finit rescue mode configuration is installed into +`/lib/finit/rescue.conf`, which can be safely removed or changed. + +By default the a root shell, without login, is started. + + Debugging ---------