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

You can install certship directly from PyPI:

pip install certship

Or use poetry for development:

poetry install

Usage

You can run the tool via poetry:

poetry run certship --help

Or directly after pip install:

certship --help

Or with Python module:

python3 -m certship.cli --help

Example

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.11.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.11-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: certship-0.0.11.tar.gz
  • Upload date:
  • Size: 4.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for certship-0.0.11.tar.gz
Algorithm Hash digest
SHA256 9987b6eb6c2a6da9ab5a0608061d0c90fa3df7c677aaf7c7773f09bc59b0c792
MD5 011b8046164e954b55548482d3c8d685
BLAKE2b-256 fbb67a0d75f48756c1283d81d4000f40eb2089e18d5176fb50cc5968873d48a7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: certship-0.0.11-py3-none-any.whl
  • Upload date:
  • Size: 7.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for certship-0.0.11-py3-none-any.whl
Algorithm Hash digest
SHA256 15e944e141a301ba92166c32966f8a41afde58898264dee9aa65c0f075218eb1
MD5 18148f9b645863ef48e05da3668f7cbb
BLAKE2b-256 76d7bc8fa1852336f5a67e9d4b1c3b97744abef0eb7fac204bea70b7f53ac7a4

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