certbot(旧名：letsencrypt-auto)コマンドの使い方やオプション

[2016年12月13日版]

certbotコマンドは、Let's Encryptを利用して、サーバ証明書を取得する際に使うコマンドです。

ACMEエージェントと呼ばれるソフトウエアです。以前は、letsencrypt-autoと呼ばれていました。

対応OSがイマイチ少ないので、対応していないUnix系のOSの方は、dehydratedコマンドか、acme.shスクリプトをおすすめします。

こちらのほうがECDSA対応証明書が簡単に取れます。

インストール方法

配布はパッケージシステムか、Webからのダウンロード経由で行われています。以下のコマンドでインストールできます。

Cent OS7 / Read Hat Enterprise Linux 7

$ sudo yum install epel-release
$ sudo yum install certbot

Debian 8

$ sudo apt-get install python-certbot-apache -t jessie-backports

Ubuntu 16

$ sudo apt-get install python-letsencrypt-apache 

Gentoo

$ emerge -av app-crypt/certbot-apache

Arch Linux

$ sudo pacman -S certbot

Fedora 23+

$ sudo dnf install certbot

Free BSD

Portsの場合

# cd /usr/ports/security/py-certbot && make install clean

Packageの場合

# pkg install py27-certbot

Open BSD

Portsの場合

# cd /usr/ports/security/letsencrypt/client && make install clean

Packageの場合

# pkg_add letsencrypt

Mac OS

$ brew install certbot

Cent OS6 / Red Hat Enterprise Linux 6

$ sudo yum install epel-release

の後に、以下のその他Unix系と同じ操作をします。

その他Unix系(macOSなど)

# cd /usr/local
# mkdir certbot
# cd certbot
# curl -O https://dl.eff.org/certbot-auto
# chmod a+x certbot-auto
#  ./certbot-auto
Creating virtual environment...
Installing Python packages...
Installation succeeded.
Requesting root privileges to run certbot...

この場合、PATHに/usr/local/certbotを追加してください。

たとえば、sh/bash系のシェルスクリプトなら、

# vi ~/.profile

として、適当な位置に以下の１行を追加します。

PATH=${PATH}:/usr/local/certbot

ヘルプの見方

# certbot --help

ヘルプは--helpオプションをつけて実行すると表示されます。（英語です。）

コマンドの使い方

certbotコマンドは、サブコマンドと呼ばれるオプションで、詳細な動作を決定します。

すべてのサブコマンドで共通して使えるオプションと、サブコマンド特有のオプションがあります。

# certbot [サブコマンド] [-t] [オプション] [-d ドメイン名(FQDN)] [-d  ドメイン名(FQDN)] ...

すべてのサブコマンドに共通して、以下のオプションが利用できます。

サブコマンド

サブコマンドは、以下の７つがあります。それぞれ使用できるオプションが異なります。

サブコマンド：certonlyで利用できるオプション

サブコマンド：installで利用できるオプション

サブコマンド：revokeで利用できるオプション

サブコマンド：rollbackで利用できるオプション

サブコマンド：pluginsで利用できるオプション

実行例

# ./certbot -t plugins
* webroot
Description: Place files in webroot directory
Interfaces: IAuthenticator, IPlugin
Entry point: webroot = certbot.plugins.webroot:Authenticator

* standalone
Description: Automatically use a temporary webserver
Interfaces: IAuthenticator, IPlugin
Entry point: standalone = certbot.plugins.standalone:Authenticator

プラグインの指定

webrootプラグインで利用できるオプション

-w /var/www/example -d example.com -d www.example.com -w /var/www/thing -d thing.net -d m.thing.net

--webroot-map '{"example.com" : "/var/https/example.com/htdocs/","www.example.com" : "/var/https/www.example.com/htdocs/" }'

manualプラグインで利用できるオプション

standaloneプラグインで利用できるオプション