Skip to main content

A tool for auto deploy cert to cloud storage service provider.

Project description

certship

Author blog: https://laofahai.cool

中文版说明 (Chinese README)

A Python tool that uses acme.sh to automatically apply for certificates and deploy them to cloud platforms (such as Alibaba Cloud AliOSS).

Install dependencies

poetry install

Usage

You can run the tool via poetry:

poetry run certship --help

Or directly:

python3 -m src.cli --help

Example

poetry run certship \
  --domain <your domain> \
  --dns-provider <dns provider, default ali> \
  --platform alioss \
  --oss-bucket <OSS bucket name> \
  --oss-endpoint <OSS endpoint> \
  --ali-key <Aliyun AccessKeyId> \
  --ali-secret <Aliyun AccessKeySecret> \
  [--ecc] [--run] [--force] [--debug]

Arguments

  • --domain: The domain to apply for the certificate (required)
  • --dns-provider: DNS provider, default is ali (optional, any DNS plugin supported by acme.sh)
  • --platform: Target platform, currently only supports alioss or tencentcos (required)
  • --oss-bucket: Aliyun OSS bucket name (required for alioss)
  • --oss-endpoint: OSS endpoint (required for alioss)
  • --ali-key: Aliyun AccessKeyId (required for alioss)
  • --ali-secret: Aliyun AccessKeySecret (required for alioss)
  • --ecc: Use ECC certificate (optional)
  • --run: Issue and deploy certificate (optional, if not set, only deploys existing certificate)
  • --force: Force certificate renewal (optional)
  • --debug: acme.sh debug mode (optional)

Requirements

  • Python 3.8+
  • poetry
  • acme.sh (must be installed and configured, defaults to Let's Encrypt)
  • ossutil64 (must be installed and configured for AliOSS)

Typical workflow

  1. Install dependencies: poetry install
  2. Install acme.sh and configure DNS API
  3. Install and configure ossutil64 (requires yundun-cert:CreateSSLCertificate permission)
  4. Run the above command to automatically issue and bind the certificate

Supported platforms

  • Alibaba Cloud AliOSS
  • Tencent Cloud COS
  • Local Nginx
  • Qiniu Cloud

PRs are welcome!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

certship-0.0.1.tar.gz (4.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

certship-0.0.1-py3-none-any.whl (7.0 kB view details)

Uploaded Python 3

File details

Details for the file certship-0.0.1.tar.gz.

File metadata

  • Download URL: certship-0.0.1.tar.gz
  • Upload date:
  • Size: 4.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.12.3 Linux/6.11.0-26-generic

File hashes

Hashes for certship-0.0.1.tar.gz
Algorithm Hash digest
SHA256 01d7806956c70700b9869063573de9fb72e0649fc24c57999156b4a16ee11752
MD5 21f9292db295c03c57283b13f69b089f
BLAKE2b-256 14e2d759c4d301a3433fe0530a4e8648d42b1ee15e9bbc7619a3d2642e0c207e

See more details on using hashes here.

File details

Details for the file certship-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: certship-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 7.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.12.3 Linux/6.11.0-26-generic

File hashes

Hashes for certship-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7ff1cf1c1e3312ac0ac9a2a02c113618c21038f57a498ce49e6df5c0235436b0
MD5 3e3e053920cf60bc1f9c8f49c613c662
BLAKE2b-256 bc7ee4e4bade2305d445903ca6a9a12b6afa49d1dc07f4f63d1da81b38b21a02

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page