NexVeridian/docker-nixpkgs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

README: improve the doc a bit

Browse source
This commit is contained in:
zimbatm 2019-02-15 11:11:26 +01:00
parent 16e635f8e1
commit 3501875f69
No known key found for this signature in database
GPG key ID: 71BAF6D40C1D63D7
1 changed files with 23 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

31
README.md
View file

@ -13,9 +13,9 @@ Always keep your docker images fresh!
Nix has a number of advantages over Dockerfile when producing docker images: Nix has a number of advantages over Dockerfile when producing docker images:
* builds are actually reproducible * builds are more likely to be repeatable and binary reproducible
* Nix will only rebuild the minimum set of changes * Nix will only rebuild the minimum set of changes with no manual intervention
* Nix can produce automatic optimised layers for you * Nix produces optimised layers with no manual intervention
* nixpkgs provides automatic security updates * nixpkgs provides automatic security updates
## Example usage ## Example usage
@ -25,12 +25,15 @@ image to image.
``` ```
# run the curl image which has curl as an entry-point # run the curl image which has curl as an entry-point
$ docker run -ti --rm nixpkgs/curl http://ifconfig.co $ docker run -ti --rm nixpkgs/curl curl http://ifconfig.co
180.52.248.114 180.52.248.114
``` ```
## List of images ## List of images
Here is the current list of images that are provided. Missing one?
[Submit a request](https://github.com/nix-community/docker-nixpkgs/issues/new)
| Image | Description | | Image | Description |
| --- | --- | | --- | --- |
| bash | CLI only | | bash | CLI only |
@ -44,10 +47,22 @@ $ docker run -ti --rm nixpkgs/curl http://ifconfig.co
## Channels ## Channels
| Name | Description | Each image is built with the following nixpkgs channels and map to the
| --- | --- | following image tag.
| nixos-unstable | the :latest version |
| nixos-18.09 | automatic security updates | The version of the packages included in each image depends on what version the
nixpkgs channel describes.
| Channel | Image Tag | Description |
| --- | --- | --- |
| nixos-unstable | latest | latest and greated, major versions might change |
| nixos-18.09 | nixos-18.09 | only minor versions that include security updates |
## Related projects
The [docker-library](https://github.com/docker-library/official-images#readme)
is an image set maintained by the Docker Inc. team and contain
officially-supported images.
## License ## License