55 lines
2.0 KiB
Markdown
55 lines
2.0 KiB
Markdown
# acme
|
|
|
|
|
|
|
|
|
|
`kelunik/acme-client` is a standalone ACME client written in PHP.
|
|
It's an alternative for the [official client](https://github.com/letsencrypt/letsencrypt) which is written in python.
|
|
|
|
> **Warning**: This software is under heavy development. Use at your own risk.
|
|
|
|
The client has been updated on Dec 9th in a non-backwards compatible manner. Please review the changes or use a new clone.
|
|
|
|
## Installation
|
|
|
|
```
|
|
git clone https://github.com/kelunik/acme-client
|
|
cd acme-client
|
|
composer install
|
|
```
|
|
|
|
## Usage
|
|
|
|
> **Note**: This client stores all data in `./data`, be sure to backup this folder regularly.
|
|
> It contains your account keys, domain keys and certificates.
|
|
|
|
Before you can issue certificates, you have to register an account first and read and understand the terms of service of the ACME CA you're using.
|
|
For Let's Encrypt there's a [subscriber agreement](https://letsencrypt.org/repository/) you have to accept.
|
|
|
|
By using this client you agree to any agreement and any further updates by continued usage.
|
|
You're responsible to react to updates and stop the automation if you no longer agree with the terms of service.
|
|
|
|
```
|
|
sudo bin/acme setup \
|
|
--server acme-v01.api.letsencrypt.org/directory \
|
|
--email me@example.com
|
|
```
|
|
|
|
After a successful registration you're able to issue certificates.
|
|
This client assumes you have a HTTP server setup and running.
|
|
You must have a document root setup in order to use this client.
|
|
|
|
```
|
|
sudo bin/acme issue \
|
|
--domains example.com,www.example.com \
|
|
--path /var/www/example.com
|
|
```
|
|
|
|
For renewal, just run this command again. If you want to automate this task, use `bin/acme renew` as your daily cron command.
|
|
It will renew certificates automatically when they're no longer than 30 days valid.
|
|
|
|
To revoke a certificate, you need a valid account key currently, just like for issuance.
|
|
|
|
```
|
|
sudo bin/acme revoke --name example.com
|
|
``` |