From mboxrd@z Thu Jan 1 00:00:00 1970 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on atuin.qyliss.net X-Spam-Level: X-Spam-Status: No, score=-1.8 required=5.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,MAILING_LIST_MULTI,RCVD_IN_DNSWL_LOW,RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL,SPF_HELO_PASS autolearn=unavailable autolearn_force=no version=3.4.6 Received: from atuin.qyliss.net (localhost [IPv6:::1]) by atuin.qyliss.net (Postfix) with ESMTP id A748381E2; Sat, 11 Feb 2023 14:58:47 +0000 (UTC) Received: by atuin.qyliss.net (Postfix, from userid 496) id DB2DF813C; Sat, 11 Feb 2023 14:58:45 +0000 (UTC) Received: from out2-smtp.messagingengine.com (out2-smtp.messagingengine.com [66.111.4.26]) by atuin.qyliss.net (Postfix) with ESMTPS id D6A9F81C5 for ; Sat, 11 Feb 2023 14:58:43 +0000 (UTC) Received: from compute5.internal (compute5.nyi.internal [10.202.2.45]) by mailout.nyi.internal (Postfix) with ESMTP id 395F85C00F0; Sat, 11 Feb 2023 09:58:43 -0500 (EST) Received: from mailfrontend1 ([10.202.2.162]) by compute5.internal (MEProxy); Sat, 11 Feb 2023 09:58:43 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=alyssa.is; h=cc :cc:content-transfer-encoding:content-type:date:date:from:from :in-reply-to:message-id:mime-version:reply-to:sender:subject :subject:to:to; s=fm3; t=1676127523; x=1676213923; bh=d9iv3aKIAQ Q5pgPUzVo7/K7cD7EM0lmCG+ds1U2tNZE=; b=gVF0kkFoWGgBZz2lz0M5cZkfbB WOX3xebNOB35mZ6BnU/1M7p5jiWC1ZlWYvfGgkVp4kuVsnqX3sNE0yB4tNJxNDab PU5C/mV3y0woZwpJZSamk48nHM1Jta4GwAcMHRWvv9u4WcKPLfku/EiXIRTfIrfG ENk+ru15E9sVRgLwnYF3iIyc/WY5auCh/JSeFl5Phi9AVvKyche1t0sta/4hqQ9d c2hWrARPifBc9h87eR7f3RqJA+ttMr2k7qSqLIwnPaDT1xrBpCjdnENigw7PzFGQ WruInRDtx6SCWT0M/A5kDxLHXTrc6Aa1Ey/4H11RWiQE7enYiQudWklUcxEw== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:cc:content-transfer-encoding :content-type:date:date:feedback-id:feedback-id:from:from :in-reply-to:message-id:mime-version:reply-to:sender:subject :subject:to:to:x-me-proxy:x-me-proxy:x-me-sender:x-me-sender :x-sasl-enc; s=fm1; t=1676127523; x=1676213923; bh=d9iv3aKIAQQ5p gPUzVo7/K7cD7EM0lmCG+ds1U2tNZE=; b=IpjZB8hceKMa5g8kNtIPK8r5YAy9M q/yS7xLDndvy/QsPtdogPEJmi8eDKIQRrWbKE4U0Qkpk5CRwP4KmYZpi8hxzLjns T5gVzgxcomSQrcdjv5NJjSFE+z+vipuFeNXJCsDDrmXDry7KawRZ2H1CezTlWKAy tC/cTFJ+yGy7hVFUIMYtRFNRQKVH2Hq5T+5YlSqQRMW2rXARnL0reaRbmGN2tweu 5dc7KcCtw3h/3CaZGXLjYlJATnjh9dlsMSaxZZHahB8P3OXbhA55yYMhEOu89F+l EVHNxVZqlc5n52KHM8NvWU8lWkO1VvTQdYtVq+EtYNbZXO/JmZxHKHVfQ== X-ME-Sender: X-ME-Received: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedvhedrudehjedgjedtucetufdoteggodetrfdotf fvucfrrhhofhhilhgvmecuhfgrshhtofgrihhlpdfqfgfvpdfurfetoffkrfgpnffqhgen uceurghilhhouhhtmecufedttdenucesvcftvggtihhpihgvnhhtshculddquddttddmne cujfgurhephffvvefufffkofggtgfgsehtkeertdertdejnecuhfhrohhmpeetlhihshhs rgcutfhoshhsuceohhhisegrlhihshhsrgdrihhsqeenucggtffrrghtthgvrhhnpedthe evheduudefffffhfeiueelgfefhffhtdfggeejfeetudduieejueeghfejueenucffohhm rghinhepghhithhlrggsrdgtohhmnecuvehluhhsthgvrhfuihiivgeptdenucfrrghrrg hmpehmrghilhhfrhhomhephhhisegrlhihshhsrgdrihhs X-ME-Proxy: Feedback-ID: i12284293:Fastmail Received: by mail.messagingengine.com (Postfix) with ESMTPA; Sat, 11 Feb 2023 09:58:42 -0500 (EST) Received: by x220.qyliss.net (Postfix, from userid 1000) id 30A782F47C; Sat, 11 Feb 2023 14:58:41 +0000 (UTC) From: Alyssa Ross To: devel@spectrum-os.org Subject: [PATCH] Documentation: add more info about the installer Date: Sat, 11 Feb 2023 14:58:25 +0000 Message-Id: <20230211145825.740965-1-hi@alyssa.is> X-Mailer: git-send-email 2.37.1 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Message-ID-Hash: QLKMGW4IFKSDUE3ZGZT7NKUAPKTF3N76 X-Message-ID-Hash: QLKMGW4IFKSDUE3ZGZT7NKUAPKTF3N76 X-MailFrom: hi@alyssa.is X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; header-match-config-1; header-match-devel.spectrum-os.org-0; header-match-devel.spectrum-os.org-1; header-match-devel.spectrum-os.org-2; header-match-devel.spectrum-os.org-3; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header CC: Jenni Nikolaenko X-Mailman-Version: 3.3.5 Precedence: list List-Id: Patches and low-level development discussion Archived-At: List-Archive: List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: Some shortcomings in this section were reported to me privately: • It wasn't clear what the image being built was for. Was it a live image, or an installer image? (It's both.) • It wasn't clear what to do with the built image, so I've explained that it should be put on a USB drive and booted from. I've also made it clear that there's not much point going through the extra step to actually install Spectrum yet, at least until we have some sort of exposed persistent storage. Signed-off-by: Alyssa Ross --- .../installation/getting-spectrum.adoc | 28 +++++++++++++++++-- 1 file changed, 25 insertions(+), 3 deletions(-) diff --git a/Documentation/installation/getting-spectrum.adoc b/Documentation/installation/getting-spectrum.adoc index 6aec34f..8ee31b7 100644 --- a/Documentation/installation/getting-spectrum.adoc +++ b/Documentation/installation/getting-spectrum.adoc @@ -2,7 +2,7 @@ :page-parent: Build and Run :page-nav_order: 2 -// SPDX-FileCopyrightText: 2022 Alyssa Ross +// SPDX-FileCopyrightText: 2022-2023 Alyssa Ross // SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0 To get Spectrum, you need to build it from source. As long as you're @@ -35,7 +35,15 @@ nix-shell -I nixpkgs=../../../nixpkgs-spectrum --run 'make run' This builds just enough of Spectrum to try it out in a VM, but it will still take a very long time. -== Building Installer +== Installing Spectrum + +To install Spectrum on a computer, you can use a USB drive as a +bootable Spectrum installer device. When booting a system from the +installer device, you will be able to choose whether to try out +Spectrum without installing it on your system (as a live image), or to +install it to your computer's internal storage. + +First, you need to build the Spectrum image: [source,shell] ---- @@ -46,7 +54,21 @@ nix-build spectrum/release/combined \ If you haven't set up the xref:binary-cache.adoc[binary cache], this will take a very long time. When it's done, a symbolic link named -"result" will appear, pointing to a Spectrum USB installer image. +"result" will appear in the current directory, pointing to the +installer image. Write that image to a USB drive, for example using +`dd` (command line) or +https://gitlab.com/bztsrc/usbimager[`usbimager`] (graphical, available +in Nixpkgs). Boot your system from the USB drive, and you should see +a menu allowing you to choose between "Try Spectrum" and "Install +Spectrum". + +NOTE: While it's possible to install Spectrum to your internal +storage, at this point in Spectrum's development there is not much +reason to, as OS updates are not yet implemented, and persistent +storage is not yet exposed to VMs. Using the "Try Spectrum" option to +boot Spectrum will let you try out everything in Spectrum, without +having to go through the additional step of reinstalling Spectrum +every time you want to use a newer version. CAUTION: Do not use Spectrum for anything important or sensitive as it is not yet suitable for real-world use. Many important security properties are -- 2.37.1