Browse Source

Add Makefile and README

Filippo Valsorda 6 years ago
parent
commit
c59b5d9d13
2 changed files with 75 additions and 0 deletions
  1. 17 0
      Makefile
  2. 58 0
      README.md

+ 17 - 0
Makefile

@@ -0,0 +1,17 @@
+IMPORT_PATH := github.com/FiloSottile/mkcert
+
+.PHONY: mkcert
+covfefe: .GOPATH/.ok
+	GOPATH="$(PWD)/.GOPATH" go install -v $(IMPORT_PATH)
+
+.PHONY: clean
+clean:
+	rm -rf bin .GOPATH
+
+.GOPATH/.ok:
+	mkdir -p ".GOPATH/src/$(IMPORT_PATH)"
+	rmdir ".GOPATH/src/$(IMPORT_PATH)"
+	ln -s ../../../.. ".GOPATH/src/$(IMPORT_PATH)"
+	mkdir -p bin
+	ln -s ../bin .GOPATH/bin
+	touch $@

+ 58 - 0
README.md

@@ -0,0 +1,58 @@
+# mkcert
+
+mkcert is a simple tool for making locally-trusted development certificates. There is no configuration.
+
+```
+$ mkcert -install
+Created a new local CA at "/Users/filippo/Library/Application Support/mkcert" 💥
+The local CA is now installed in the system trust store! ⚡️
+
+$ mkcert example.com myapp.dev localhost 127.0.0.1 ::1
+Using the local CA at "/Users/filippo/Library/Application Support/mkcert" ✨
+
+Created a new certificate valid for the following names 📜
+ - "example.com"
+ - "myapp.dev"
+ - "localhost"
+ - "127.0.0.1"
+ - "::1"
+
+The certificate is at "./example.com+4.pem" and the key at "./example.com+4-key.pem" ✅
+```
+
+![Chrome screenshot](https://user-images.githubusercontent.com/1225294/41887838-7acd55ca-78d0-11e8-8a81-139a54faaf87.png)
+
+Obtaining certificates from real CAs for development can be dangerous or impossible (for hosts like `localhost` or `127.0.0.1`), but self-signed certificates cause trust errors. Managing your own CA is the best solution, but usually involves arcane commands, specialized knowledge and manual steps.
+
+mkcert automatically creates and installs a local CA in the system root store, and generates locally-trusted certificates for any hosts.
+
+## Installation
+
+On macOS, use Homebrew.
+
+```
+TODO
+```
+
+On Linux, use [the pre-built binaries](https://github.com/FiloSottile/mkcert/releases), or build from source.
+
+```
+$ git clone https://github.com/FiloSottile/mkcert
+$ cd mkcert && make
+```
+
+Windows will be supported soon.
+
+## Changing the location of the CA files
+
+TODO
+
+## Installing the CA on other computers
+
+TODO
+
+Remember that mkcert is meant for development purposes, not production, so it should not be used on users' machines.
+
+---
+
+This is not an official Google project, just some code that happens to be owned by Google.