mkcert README

The project's README from github.com/FiloSottile/mkcert. As one markdown file: README.md.

mkcert

mkcert is a simple tool for making locally-trusted development certificates. It requires no configuration.

$ mkcert -install
Created a new local CA 💥
The local CA is now installed in the system trust store! ⚡️
The local CA is now installed in the Firefox trust store (requires browser restart)! 🦊

$ mkcert example.com "*.example.com" example.test localhost 127.0.0.1 ::1

Created a new certificate valid for the following names 📜
 - "example.com"
 - "*.example.com"
 - "example.test"
 - "localhost"
 - "127.0.0.1"
 - "::1"

The certificate is at "./example.com+5.pem" and the key at "./example.com+5-key.pem" ✅

Chrome and Firefox screenshot

Using certificates from real certificate authorities (CAs) for development can be dangerous or impossible (for hosts like example.test, 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. mkcert does not automatically configure servers to use the certificates, though, that's up to you.

Installation

Warning: the rootCA-key.pem file that mkcert automatically generates gives complete power to intercept secure requests from your machine. Do not share it.

macOS

On macOS, use Homebrew

brew install mkcert
brew install nss # if you use Firefox

or MacPorts.

sudo port selfupdate
sudo port install mkcert
sudo port install nss # if you use Firefox

Linux

On Linux, first install certutil.

sudo apt install libnss3-tools
    -or-
sudo yum install nss-tools
    -or-
sudo pacman -S nss
    -or-
sudo zypper install mozilla-nss-tools

Then you can install using Homebrew on Linux

brew install mkcert

or build from source (requires Go 1.13+)

git clone https://github.com/FiloSottile/mkcert && cd mkcert
go build -ldflags "-X main.Version=$(git describe --tags)"

or use the pre-built binaries.

curl -JLO "https://dl.filippo.io/mkcert/latest?for=linux/amd64"
chmod +x mkcert-v*-linux-amd64
sudo cp mkcert-v*-linux-amd64 /usr/local/bin/mkcert

For Arch Linux users, mkcert is available on the official Arch Linux repository.

sudo pacman -Syu mkcert

Windows

On Windows, use Chocolatey

choco install mkcert

or use Scoop

scoop bucket add extras
scoop install mkcert

or build from source (requires Go 1.10+), or use the pre-built binaries.

If you're running into permission problems try running mkcert as an Administrator.

Supported root stores

mkcert supports the following root stores:

To only install the local root CA into a subset of them, you can set the TRUST_STORES environment variable to a comma-separated list. Options are: "system", "java" and "nss" (includes Firefox).

Advanced topics

Advanced options

	-cert-file FILE, -key-file FILE, -p12-file FILE
	    Customize the output paths.

	-client
	    Generate a certificate for client authentication.

	-ecdsa
	    Generate a certificate with an ECDSA key.

	-pkcs12
	    Generate a ".p12" PKCS #12 file, also know as a ".pfx" file,
	    containing certificate and key for legacy applications.

	-csr CSR
	    Generate a certificate based on the supplied CSR. Conflicts with
	    all other flags and arguments except -install and -cert-file.

Note: You must place these options before the domain names list.

Example

mkcert -key-file key.pem -cert-file cert.pem example.com *.example.com

S/MIME

mkcert automatically generates an S/MIME certificate if one of the supplied names is an email address.

mkcert [email protected]

Mobile devices

For the certificates to be trusted on mobile devices, you will have to install the root CA. It's the rootCA.pem file in the folder printed by mkcert -CAROOT.

On iOS, you can either use AirDrop, email the CA to yourself, or serve it from an HTTP server. After opening it, you need to install the profile in Settings > Profile Downloaded and then enable full trust in it.

For Android, you will have to install the CA and then enable user roots in the development build of your app. See this StackOverflow answer.

Using the root with Node.js

Node does not use the system root store, so it won't accept mkcert certificates automatically. Instead, you will have to set the NODE_EXTRA_CA_CERTS environment variable.

export NODE_EXTRA_CA_CERTS="$(mkcert -CAROOT)/rootCA.pem"

Changing the location of the CA files

The CA certificate and its key are stored in an application data folder in the user home. You usually don't have to worry about it, as installation is automated, but the location is printed by mkcert -CAROOT.

If you want to manage separate CAs, you can use the environment variable $CAROOT to set the folder where mkcert will place and look for the local CA files.

Installing the CA on other systems

Installing in the trust store does not require the CA key, so you can export the CA certificate and use mkcert to install it in other machines.

Remember that mkcert is meant for development purposes, not production, so it should not be used on end users' machines, and that you should not export or share rootCA-key.pem.

mkcert (FiloSottile/mkcert)

Searching Database…

59.7K ·GitHub
Mkcert
Что это?mkcert — простой инструмент без настройки, который создаёт локально доверенные TLS-сертификаты для разработки, чтобы ваши локальные HTTPS-сайты не показывали предупреждения браузера.
Это консольная утилита или библиотека?Это самостоятельная консольная утилита, написанная на Go, которую вы запускаете из терминала для создания сертификатов и управления локальным центром сертификации.
Как установить и использовать?Установите через Homebrew/MacPorts на macOS, Chocolatey/Scoop или готовые бинарные файлы на Windows, либо через Homebrew, сборку из исходников или готовые бинарные файлы на Linux (в Arch есть официальный пакет в репозитории); затем выполните 'mkcert -install', чтобы настроить локальный центр сертификации (CA).
Нужно ли что-то установить заранее?В Linux заранее нужно установить certutil; для сборки из исходников требуется Go 1.10+ (Windows) или Go 1.13+ (Linux).
На что мне стоит обратить внимание?Сгенерированный файл rootCA-key.pem даёт полный доступ к перехвату защищённого трафика с вашего компьютера, поэтому его нельзя никому передавать; а в Windows при проблемах с правами может понадобиться запуск от имени администратора.
В каких браузерах и системах он доверяет сертификатам?mkcert работает с системными хранилищами macOS и Windows, несколькими механизмами доверия Linux (update-ca-trust, update-ca-certificates, trust), а также с Firefox, Chrome/Chromium и Java, если задана переменная JAVA_HOME.
Можно ли использовать это на продакшн-машинах?Нет — mkcert предназначен только для разработки, а не для продакшена, и его никогда не следует устанавливать на компьютеры конечных пользователей.
Можно ли добиться доверия и на телефоне?Да: для iOS можно передать файл rootCA.pem через AirDrop, почту или раздать его с сервера, затем установить профиль и полностью доверить ему в «Настройках». Для Android нужно установить CA и включить доверие к пользовательским корневым сертификатам (user roots) в отладочной сборке вашего приложения.
Работает ли mkcert с приложениями на Node.js?Не автоматически: Node игнорирует системное хранилище корневых сертификатов, поэтому нужно задать переменную окружения NODE_EXTRA_CA_CERTS, указывающую на корневой сертификат mkcert.
Можно ли использовать mkcert и для почтовых сертификатов?Да, mkcert автоматически создаёт сертификат S/MIME, если одно из указанных имён является адресом электронной почты.
Можно ли доверять моему локальному CA на другом компьютере?Да: для установки нужен только сертификат CA (без ключа), поэтому можно скопировать rootCA.pem на другой компьютер, указать $CAROOT на эту папку и выполнить там 'mkcert -install'.
What are similar projects?portless, HackBrowserData, hotel, brook, caddy, Xray-core, http-server, gopeed
Which topics is it in?localhost, self-hosted-ai, https, firefox, chrome, tls, ios, go, command-line-tool, android, security, cli
Creator
FiloSottile
Size
1.8 MB
Stars
59.7K
Updated
CommitApr 18Releasev1.4.4Apr 26
Age
8y
Commits · 90 Days