chore: better readme

This commit is contained in:
Pierre Zemb 2017-11-14 00:25:19 +01:00
parent 18d9882f90
commit b5f531be5d
No known key found for this signature in database
GPG key ID: E48ABD1BBB7FEC23

View file

@ -1,7 +1,7 @@
# goStatic # goStatic [![GoDoc](https://godoc.org/github.com/PierreZ/goStatic?status.svg)](https://godoc.org/github.com/PierreZ/goStatic) [![Build Status](https://travis-ci.org/PierreZ/goStatic.svg?branch=master)](https://travis-ci.org/PierreZ/goStatic)
A really small static web server for Docker A really small static web server for Docker
[![GoDoc](https://godoc.org/github.com/PierreZ/goStatic?status.svg)](https://godoc.org/github.com/PierreZ/goStatic)
### The goal ### The goal
My goal is to create to smallest docker container for my web static files. The advantage of Go is that you can generate a fully static binary, so that you don't need anything else. My goal is to create to smallest docker container for my web static files. The advantage of Go is that you can generate a fully static binary, so that you don't need anything else.
@ -58,8 +58,6 @@ Usage of ./goStatic:
Define the basic auth. Form must be user:password Define the basic auth. Form must be user:password
``` ```
### Wow, such container! What are you using? ### Wow, such container! What are you using?
I'm using the centurylink/ca-certs image instead of the scratch image to avoid this error: I'm using the centurylink/ca-certs image instead of the scratch image to avoid this error:
@ -69,10 +67,3 @@ x509: failed to load system roots and no roots provided
``` ```
The centurylink/ca-certs image is simply the scratch image with the most common root CA certificates pre-installed. The resulting image is only 258 kB which is still a good starting point for creating your own minimal images. The centurylink/ca-certs image is simply the scratch image with the most common root CA certificates pre-installed. The resulting image is only 258 kB which is still a good starting point for creating your own minimal images.
### How to build
```bash
GOARCH=amd64 GOOS=linux go build -ldflags "-linkmode external -extldflags -static -w"
```