From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on atuin.qyliss.net X-Spam-Level: X-Spam-Status: No, score=-4.6 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,RCVD_IN_DNSWL_LOW,RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL,SPF_HELO_PASS,T_SCC_BODY_TEXT_LINE 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 CC70915357; Wed, 20 Apr 2022 16:42:08 +0000 (UTC) Received: by atuin.qyliss.net (Postfix, from userid 496) id 65C3F153DC; Wed, 20 Apr 2022 16:42:06 +0000 (UTC) Received: from out1-smtp.messagingengine.com (out1-smtp.messagingengine.com [66.111.4.25]) by atuin.qyliss.net (Postfix) with ESMTPS id 7A732153DB for ; Wed, 20 Apr 2022 16:42:02 +0000 (UTC) Received: from compute4.internal (compute4.nyi.internal [10.202.2.44]) by mailout.nyi.internal (Postfix) with ESMTP id A4C405C010D; Wed, 20 Apr 2022 12:42:01 -0400 (EDT) Received: from mailfrontend2 ([10.202.2.163]) by compute4.internal (MEProxy); Wed, 20 Apr 2022 12:42:01 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=alyssa.is; h=cc :cc:content-transfer-encoding:date:date:from:from:in-reply-to :message-id:mime-version:reply-to:sender:subject:subject:to:to; s=fm3; t=1650472921; x=1650559321; bh=8TzcJuXBgFD/ESKYePyMEWdSv BbhjYuxyRcgGY+tUgk=; b=hM+KjLp8nrsgjqHj4fHuzt992kTshAkD9QbgFV69C nd7K2QaDH1NjAbm4ufBebzMc1WL7agxekdmZXu0XPXxqg981uIOXNm4aiwwqvrDI W4OM61kfw1QXG7WfWCS0EePfXCM6ShV5ZjiM0xwuyAJk9HkXCKvf39t4Nsx1hXjb 6QolNjI/LFbM4WW+AXjVIkiEGm/rQrHP4tIxu9qPFX/ZuYe9+4CJI7VAaL0cL/Qu V2/3z8gtqwE4ZeBrTr03z+FSpkdKpCnRVEaoF3t/NG/RnZKEwRXQYc8lXGPVV8Dw hXNcitYItm+F1F75/Wx+hJkaG5N9l2pumIG7Ipq24b6Nw== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:cc:content-transfer-encoding:date:date :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=1650472921; x=1650559321; bh=8 TzcJuXBgFD/ESKYePyMEWdSvBbhjYuxyRcgGY+tUgk=; b=bn743MFcixrw612Zc K3ulfDGhPFruumd6v/BgzJqv0Sk6aZIiF6tyo6kZvr/pomQCRJeKxL3xb4gYJKDr M/QOxsR+npRPMVrYPr/JgdqrnIFk6lofYwVMDAPYXPrALWYgr/fWg97EH3z4ecqk zvZLa9nblUFacVZLV4wLgXSHFR+zc+1X3QEfAcgdmuDS+fnk9j99SHTZ360Yc2+Y RKwQSa48EaEKZZtnnR0Ti7F2J/IaiV9eD8KYmwtKrAZB0Rz5rbok1czLOjpV3y6u p4EYhToVayiqeWUFMSboVorF65XV4vB7rfxppvcYxDsdQddNorLbNk9UHyxdLoHi Mznww== X-ME-Sender: X-ME-Received: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedvfedrtddtgdejlecutefuodetggdotefrodftvf curfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfghnecu uegrihhlohhuthemuceftddtnecusecvtfgvtghiphhivghnthhsucdlqddutddtmdenuc fjughrpefhvfevufffkffoggfgsedtkeertdertddtnecuhfhrohhmpeetlhihshhsrgcu tfhoshhsuceohhhisegrlhihshhsrgdrihhsqeenucggtffrrghtthgvrhhnpefhgefhtd efgfduvdeghfetiefgffdthfetjeegtdejtedvfeejgfejvedvkeevteenucffohhmrghi nhepvhhulhhtrhdrtghomhdpshhpvggtthhruhhmqdhoshdrohhrghdpghhithhhuhgsrd gtohhmpdgurghtrggrthhurhhsvghrvhhitggvrdhsvgdpnhhigihoshdrohhrghdpghhi thdqshgtmhdrtghomhenucevlhhushhtvghrufhiiigvpedtnecurfgrrhgrmhepmhgrih hlfhhrohhmpehqhihlihhsshesvghvvgdrqhihlhhishhsrdhnvght X-ME-Proxy: Received: by mail.messagingengine.com (Postfix) with ESMTPA; Wed, 20 Apr 2022 12:42:01 -0400 (EDT) Received: by eve.qyliss.net (Postfix, from userid 1000) id ED851C3C; Wed, 20 Apr 2022 16:41:58 +0000 (UTC) From: Alyssa Ross To: devel@spectrum-os.org Subject: [PATCH] Documentation: document the binary cache Date: Wed, 20 Apr 2022 16:41:50 +0000 Message-Id: <20220420164150.3110649-1-hi@alyssa.is> X-Mailer: git-send-email 2.35.1 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Message-ID-Hash: KOM4FS7OMIC7SW5QCMRVONRSMWJLI6C2 X-Message-ID-Hash: KOM4FS7OMIC7SW5QCMRVONRSMWJLI6C2 X-MailFrom: qyliss@eve.qyliss.net 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; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header CC: Puck Meerburg , Daniel Kuehn 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: --- Documentation/Makefile | 1 + Documentation/binary-cache.adoc | 53 +++++++++++++++++++++++++++++ Documentation/getting-spectrum.adoc | 4 +++ 3 files changed, 58 insertions(+) create mode 100644 Documentation/binary-cache.adoc diff --git a/Documentation/Makefile b/Documentation/Makefile index 59bc3ae..e9d5886 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -8,6 +8,7 @@ datarootdir = $(prefix)/share docdir = $(datarootdir)/doc/spectrum SOURCES = \ + binary-cache.adoc \ creating-vms.adoc \ development.adoc \ getting-spectrum.adoc \ diff --git a/Documentation/binary-cache.adoc b/Documentation/binary-cache.adoc new file mode 100644 index 0000000..5ce6a4d --- /dev/null +++ b/Documentation/binary-cache.adoc @@ -0,0 +1,53 @@ +// SPDX-FileCopyrightText: 2022 Alyssa Ross +// SPDX-License-Identifier: GFDL-1.3-or-later OR CC-BY-SA-4.0 + += Binary cache + +Building Spectrum from source can take a very long time. To avoid +having to wait when building the system to try it out or test patches, +an x86_64 binary cache service is available. If configured to do so, +Nix will download build outputs from the cache, instead of building +them locally. + +Builds are run on the latest NixOS unstable on +https://www.vultr.com/[Vultr], and are signed to ensure authenticity. +The build infrastructure and signing key are accessible by Alyssa Ross +and Puck Meerburg. Storage is provided by Daniel Kuehn. Please +https://spectrum-os.org/participating.html[get in touch] if you +encounter any trouble with it. + +The binary cache is currently not able to provide logs, due to a +https://github.com/NixOS/nix/issues/6403[Nix bug]. + +== Setting up the binary cache + +=== NixOS + +The following configuration adds the Spectrum binary cache as a +substituter, and tells Nix to trust builds signed with its public key. + +[source,nix] +---- +{ ... }: + +{ + nix.settings.substituters = [ "https://cache.dataaturservice.se/spectrum/" ]; + nix.settings.trusted-public-keys = [ + "cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY=" + "spectrum-os.org-1:rnnSumz3+Dbs5uewPlwZSTP0k3g/5SRG4hD7Wbr9YuQ=" + ]; +} +---- + +=== Non-NixOS systems + +Add the following configuration to /etc/nix/nix.conf: + +---- +substituters = https://cache.dataaturservice.se/spectrum/ https://cache.nixos.org/ +trusted-public-keys = cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY= cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY= spectrum-os.org-1:rnnSumz3+Dbs5uewPlwZSTP0k3g/5SRG4hD7Wbr9YuQ= +---- + +If you have other binary caches configured besides cache.nixos.org, +make sure to add the Spectrum cache URL and public key to the existing +configuration lines in your nix.conf file. diff --git a/Documentation/getting-spectrum.adoc b/Documentation/getting-spectrum.adoc index 4ff6b05..fb69dce 100644 --- a/Documentation/getting-spectrum.adoc +++ b/Documentation/getting-spectrum.adoc @@ -10,6 +10,10 @@ from other operating systems, as long as they're not too invasive.] and have https://nixos.org/[Nix] and https://git-scm.com/[git] installed, it's very easy to do. +Before you start, consider setting up the +xref:binary-cache.adoc[Spectrum binary cache], which will save you a +lot of time waiting for builds. + == Trying Spectrum If you want to try Spectrum out to get a feel for it, without -- 2.35.1