diff options
Diffstat (limited to 'tools/nixery/docs')
| -rw-r--r-- | tools/nixery/docs/default.nix | 18 | ||||
| -rw-r--r-- | tools/nixery/docs/src/nixery.md | 6 | ||||
| -rw-r--r-- | tools/nixery/docs/src/run-your-own.md | 17 |
3 files changed, 15 insertions, 26 deletions
diff --git a/tools/nixery/docs/default.nix b/tools/nixery/docs/default.nix index d27cbe5b3e9e..876a34dcf152 100644 --- a/tools/nixery/docs/default.nix +++ b/tools/nixery/docs/default.nix @@ -1,16 +1,5 @@ -# Copyright 2019 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. +# Copyright 2022 The TVL Contributors +# SPDX-License-Identifier: Apache-2.0 # Builds the documentation page using the Rust project's 'mdBook' # tool. @@ -27,7 +16,8 @@ let rev = "9f0baf5e270128d9101ba4446cf6844889e399a2"; sha256 = "1pf9i90gn98vz67h296w5lnwhssk62dc6pij983dff42dbci7lhj"; }; -in runCommand "nixery-book" { } '' +in +runCommand "nixery-book" { } '' mkdir -p $out cp -r ${./.}/* . chmod -R a+w src diff --git a/tools/nixery/docs/src/nixery.md b/tools/nixery/docs/src/nixery.md index 7b78ddf5aaf8..d9ba179010f6 100644 --- a/tools/nixery/docs/src/nixery.md +++ b/tools/nixery/docs/src/nixery.md @@ -68,10 +68,6 @@ production project we recommend setting up a private instance. The public Nixery at `nixery.dev` is run on a best-effort basis and we make no guarantees about availability. -### Is this an official Google project? - -**No.** Nixery is not officially supported by Google. - ### Who made this? Nixery was written by [tazjin][], but many people have contributed to Nix over @@ -81,4 +77,4 @@ time, maybe you could become one of them? [Nix]: https://nixos.org/nix [layering strategy]: https://storage.googleapis.com/nixdoc/nixery-layers.html [layers]: https://grahamc.com/blog/nix-and-layered-docker-images -[tazjin]: https://github.com/tazjin +[tazjin]: https://tazj.in diff --git a/tools/nixery/docs/src/run-your-own.md b/tools/nixery/docs/src/run-your-own.md index cf4dc2ce6166..7ed8bdd0bc0a 100644 --- a/tools/nixery/docs/src/run-your-own.md +++ b/tools/nixery/docs/src/run-your-own.md @@ -65,13 +65,17 @@ use it with your own packages. There are three options available: ### 2.1. With a container image -The easiest way to run Nixery is to build a container image. -This section assumes that the container runtime used is Docker, -please modify instructions accordingly if -you are using something else. +The easiest way to run Nixery is to build a container image. This +section assumes that the container runtime used is Docker, please +modify instructions accordingly if you are using something else. -With a working Nix installation, building Nixery is done by invoking `nix-build --A nixery-image` from a checkout of the [Nixery repository][repo]. +With a working Nix installation, you can clone and build the Nixery +image like this: + +``` +git clone https://code.tvl.fyi/depot.git:/tools/nixery.git +nix-build -A nixery-image +``` This will create a `result`-symlink which points to a tarball containing the image. In Docker, this tarball can be loaded by using `docker load -i result`. @@ -184,7 +188,6 @@ If the directory doesn't exist, Nixery will run fine but serve 404. [nixery#4]: https://github.com/tazjin/nixery/issues/4 [Nix]: https://nixos.org/nix [gcs]: https://cloud.google.com/storage/ -[repo]: https://github.com/tazjin/nixery [signed-urls]: under-the-hood.html#5-image-layers-are-requested [ADC]: https://cloud.google.com/docs/authentication/production#finding_credentials_automatically [nixinstall]: https://nixos.org/manual/nix/stable/installation/installing-binary.html |