ac10907913
People occasionally ask what the current nixpkgs commit is on nixery.dev (see e.g. https://github.com/tazjin/nixery/issues/153). With this change, the commit is displayed on nixery.dev if Nixery is built for the TVL deployment. Change-Id: I795220214db5a367a126c9b4bd03754e9f144940 Reviewed-on: https://cl.tvl.fyi/c/depot/+/5881 Reviewed-by: sterni <sternenseemann@systemli.org> Tested-by: BuildkiteCI Autosubmit: tazjin <tazjin@tvl.su>
72 lines
2.6 KiB
Markdown
72 lines
2.6 KiB
Markdown
|
|
|
|
------------
|
|
|
|
Welcome to this instance of [Nixery][]. It provides ad-hoc container images that
|
|
contain packages from the [Nix][] package manager. Images with arbitrary
|
|
packages can be requested via the image name.
|
|
|
|
Nix not only provides the packages to include in the images, but also builds the
|
|
images themselves by using a special [layering strategy][] that optimises for
|
|
cache efficiency.
|
|
|
|
For general information on why using Nix makes sense for container images, check
|
|
out [this blog post][layers].
|
|
|
|
## Demo
|
|
|
|
<script src="https://asciinema.org/a/262583.js" id="asciicast-262583" async data-autoplay="true" data-loop="true"></script>
|
|
|
|
## Quick start
|
|
|
|
Simply pull an image from this registry, separating each package you want
|
|
included by a slash:
|
|
|
|
docker pull nixery.dev/shell/git/htop
|
|
|
|
This gives you an image with `git`, `htop` and an interactively configured
|
|
shell. You could run it like this:
|
|
|
|
docker run -ti nixery.dev/shell/git/htop bash
|
|
|
|
Each path segment corresponds either to a key in the Nix package set, or a
|
|
meta-package that automatically expands to several other packages.
|
|
|
|
Meta-packages **must** be the first path component if they are used. Currently
|
|
there are only two meta-packages:
|
|
- `shell`, which provides a `bash`-shell with interactive configuration and
|
|
standard tools like `coreutils`.
|
|
- `arm64`, which provides ARM64 binaries.
|
|
|
|
**Tip:** When pulling from a private Nixery instance, replace `nixery.dev` in
|
|
the above examples with your registry address.
|
|
|
|
## FAQ
|
|
|
|
If you have a question that is not answered here, feel free to file an issue on
|
|
Github so that we can get it included in this section. The volume of questions
|
|
is quite low, thus by definition your question is already frequently asked.
|
|
|
|
### Where is the source code for this?
|
|
|
|
Over [on Github][Nixery]. It is licensed under the Apache 2.0 license. Consult
|
|
the documentation entries in the sidebar for information on how to set up your
|
|
own instance of Nixery.
|
|
|
|
### Should I depend on `nixery.dev` in production?
|
|
|
|
While we appreciate the enthusiasm, if you would like to use Nixery in your
|
|
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.
|
|
|
|
### Who made this?
|
|
|
|
Nixery was written by [tazjin][], but many people have contributed to Nix over
|
|
time, maybe you could become one of them?
|
|
|
|
[Nixery]: https://github.com/tazjin/nixery
|
|
[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://tazj.in
|