{ "info": { "author": "sommd", "author_email": "", "bugtrack_url": null, "classifiers": [], "description": "# GitLab Pages installer plugin for Certbot\n\n`certbot-gitlab` is an installer plugin for Certbot. It allows you to automate the installation of certificates issued to GitLab Pages domains.\n\nYou still need to use a separate authenticator plugin. Read [this](https://certbot.eff.org/docs/using.html#getting-certificates-and-choosing-plugins) for more information on how installer and authenticator plugins.\n\n## Installation\n\n```sh\nsudo pip install certbot-gitlab\n```\n\n## Usage\n\n### Obtain as access token\n\n[Create an access token](https://gitlab.com/profile/personal_access_tokens) on GitLab with the `api` scope.\n\n### Basic Example\n\n```sh\ncertbot --installer certbot-gitlab:gitlab\n```\n\nThis will run Certbot interactively and allow you to choose your specific authentication method.\n\nIt will also ask for your GitLab access token. This won't be saved, so automatic renewal (via `certbot renew`) won't work. See [Credentials File](#credentials-file) for how to automate renewal.\n\nIf you don't want automatic authentication, then add `--authenticator manual --preferred-challenges dns` to use manual DNS TXT record authentication.\n\n### Credentials File\n\n```sh\ncertbot --installer certbot-gitlab:gitlab --certbot-gitlab:gitlab-token '/path/to/gitlab/token/file'\n```\n\nThis will take the GitLab access token from `/path/to/gitlab/token/file`, which should contain just the access token, such as:\n\n```\nMY_GITLAB_TOKEN\n```\n\n**IMPORTANT**: Make sure this file is in a secure location (such as `/root/` or `/etc/letsencrypt/keys/` and that it can only be read by `root`.\n\n```sh\nchown root:root '/path/to/gitlab/token/file'\nchmod 600 '/path/to/gitlab/token/file'\n```\n\nThe path to this file will be saved for automatic renewal, so running `certbot renew` will automatically install the certificate to GitLab when renewed.\n\n### All Options\n\n```\n--certbot-gitlab:gitlab-server CERTBOT_GITLAB:GITLAB_SERVER\n GitLab server url (default: https://gitlab.com)\n\n--certbot-gitlab:gitlab-config CERTBOT_GITLAB:GITLAB_CONFIG\n python-gitlab configuration file (default: None)\n\n--certbot-gitlab:gitlab-token CERTBOT_GITLAB:GITLAB_TOKEN\n GitLab API token (default: None)\n\n--certbot-gitlab:gitlab-project CERTBOT_GITLAB:GITLAB_PROJECT\n Name of GitLab project (e.g. user/proj) (default: None)\n```\n\nRead [this](http://python-gitlab.readthedocs.io/en/stable/cli.html#configuration) for how to use `--certbot-gitlab:gitlab-config`.\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://gitlab.com/sommd/certbot-gitlab", "keywords": "", "license": "Apache Licence 2.0", "maintainer": "", "maintainer_email": "", "name": "certbot-gitlab", "package_url": "https://pypi.org/project/certbot-gitlab/", "platform": "", "project_url": "https://pypi.org/project/certbot-gitlab/", "project_urls": { "Homepage": "https://gitlab.com/sommd/certbot-gitlab" }, "release_url": "https://pypi.org/project/certbot-gitlab/0.1.0/", "requires_dist": [ "certbot", "zope.interface", "python-gitlab" ], "requires_python": "", "summary": "GitLab Pages plugin for Certbot", "version": "0.1.0" }, "last_serial": 3761085, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "ab9b053f5e6b9467d21ddd50f6c87c51", "sha256": "6d25b919ec64f6bdf21499a5148d1f3db338b8750f6c19d528864fd278a36a08" }, "downloads": -1, "filename": "certbot_gitlab-0.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "ab9b053f5e6b9467d21ddd50f6c87c51", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 4188, "upload_time": "2018-04-13T08:38:14", "url": "https://files.pythonhosted.org/packages/02/ef/3b2e5be61dc05cbd5e24c63905cac306ae612540d32e37d0eed136c808f5/certbot_gitlab-0.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "25ee6c27d91a06a6d008f9334fc96414", "sha256": "369ec13c69ee1e832506f575818f490446d53a7ddb5c2676c3d07b11c3b9ed88" }, "downloads": -1, "filename": "certbot-gitlab-0.1.0.tar.gz", "has_sig": false, "md5_digest": "25ee6c27d91a06a6d008f9334fc96414", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3519, "upload_time": "2018-04-13T08:38:16", "url": "https://files.pythonhosted.org/packages/8f/1d/e35e60f879f1fbca049f0f8790bd18d6dd5104cf8731d7d1cbf98d5dc2a8/certbot-gitlab-0.1.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "ab9b053f5e6b9467d21ddd50f6c87c51", "sha256": "6d25b919ec64f6bdf21499a5148d1f3db338b8750f6c19d528864fd278a36a08" }, "downloads": -1, "filename": "certbot_gitlab-0.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "ab9b053f5e6b9467d21ddd50f6c87c51", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 4188, "upload_time": "2018-04-13T08:38:14", "url": "https://files.pythonhosted.org/packages/02/ef/3b2e5be61dc05cbd5e24c63905cac306ae612540d32e37d0eed136c808f5/certbot_gitlab-0.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "25ee6c27d91a06a6d008f9334fc96414", "sha256": "369ec13c69ee1e832506f575818f490446d53a7ddb5c2676c3d07b11c3b9ed88" }, "downloads": -1, "filename": "certbot-gitlab-0.1.0.tar.gz", "has_sig": false, "md5_digest": "25ee6c27d91a06a6d008f9334fc96414", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3519, "upload_time": "2018-04-13T08:38:16", "url": "https://files.pythonhosted.org/packages/8f/1d/e35e60f879f1fbca049f0f8790bd18d6dd5104cf8731d7d1cbf98d5dc2a8/certbot-gitlab-0.1.0.tar.gz" } ] }