# python3-cyberfusion-security-txt-policy-server
security-txt-policy-server serves `.well-known/security.txt` files.
# Install
## PyPI
Run the following command to install the package from PyPI:
```
pip3 install python3-cyberfusion-security-txt-policy-server
```
## Debian
Run the following commands to build a Debian package:
mk-build-deps -i -t 'apt -o Debug::pkgProblemResolver=yes --no-install-recommends -y'
dpkg-buildpackage -us -uc
# Configure
## App
The following environment variables may be specified:
```
; The app name is used in several places for this app to identify itself (string)
; Default: security-txt-policy-server
APP_NAME=
; The server will bind to this host (string)
; Default: ::1
LISTEN_HOST=
; The server will listen to this port (integer)
; Default: 8080
LISTEN_PORT=
; IP addresses of proxies that are trusted with proxy headers (comma separated list of strings)
; Default: ::1
TRUSTED_PROXY_ADDRESSES=
; The path to your JSON database (string)
; Default: none
DATABASE_PATH=
```
Only `DATABASE_PATH` is required to be set. We recommend setting it to `/var/lib/security-txt-policy-server.json`.
## JSON Database
Find an example JSON database in `security-txt-policy-server.json`.
Properties:
* `domains`. List of domains that this security.txt policy is served for.
* `expires_timestamp`. UNIX timestamp of security.txt 'Expires' field.
* `email_contacts`. (Do not add prefix `mailto:` which is required by security.txt - the server does this.)
* `url_contacts`
* `encryption_key_urls`
* `acknowledgment_urls`
* `preferred_languages`
* `policy_urls`
* `opening_urls`
Find information about these properties on https://securitytxt.org/.
# Usage
## Manually
bin/security-txt-policy-server
### systemd
systemctl start security-txt-policy-server.service
## SSL
Use a proxy that terminates SSL. E.g. [HAProxy](http://www.haproxy.org/).
Raw data
{
"_id": null,
"home_page": null,
"name": "python3-cyberfusion-security-txt-policy-server",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Cyberfusion <support@cyberfusion.io>",
"download_url": "https://files.pythonhosted.org/packages/f7/1a/2dcba9cb8e125370449af55e5a1053c9cefcf8de2baa9ce934ff66e4efa0/python3_cyberfusion_security_txt_policy_server-1.0.5.1.2.tar.gz",
"platform": null,
"description": "# python3-cyberfusion-security-txt-policy-server\n\nsecurity-txt-policy-server serves `.well-known/security.txt` files.\n\n# Install\n\n## PyPI\n\nRun the following command to install the package from PyPI:\n\n```\npip3 install python3-cyberfusion-security-txt-policy-server\n```\n\n## Debian\n\nRun the following commands to build a Debian package:\n\n mk-build-deps -i -t 'apt -o Debug::pkgProblemResolver=yes --no-install-recommends -y'\n dpkg-buildpackage -us -uc\n\n# Configure\n\n## App\n\nThe following environment variables may be specified:\n\n```\n; The app name is used in several places for this app to identify itself (string)\n; Default: security-txt-policy-server\nAPP_NAME=\n\n; The server will bind to this host (string)\n; Default: ::1\nLISTEN_HOST=\n\n; The server will listen to this port (integer)\n; Default: 8080\nLISTEN_PORT=\n\n; IP addresses of proxies that are trusted with proxy headers (comma separated list of strings)\n; Default: ::1\nTRUSTED_PROXY_ADDRESSES=\n\n; The path to your JSON database (string)\n; Default: none\nDATABASE_PATH=\n```\n\nOnly `DATABASE_PATH` is required to be set. We recommend setting it to `/var/lib/security-txt-policy-server.json`.\n\n## JSON Database\n\nFind an example JSON database in `security-txt-policy-server.json`.\n\nProperties:\n\n* `domains`. List of domains that this security.txt policy is served for.\n* `expires_timestamp`. UNIX timestamp of security.txt 'Expires' field.\n* `email_contacts`. (Do not add prefix `mailto:` which is required by security.txt - the server does this.)\n* `url_contacts`\n* `encryption_key_urls`\n* `acknowledgment_urls`\n* `preferred_languages`\n* `policy_urls`\n* `opening_urls`\n\nFind information about these properties on https://securitytxt.org/.\n\n# Usage\n\n## Manually\n\n bin/security-txt-policy-server\n\n### systemd\n\n systemctl start security-txt-policy-server.service\n\n## SSL\n\nUse a proxy that terminates SSL. E.g. [HAProxy](http://www.haproxy.org/).\n",
"bugtrack_url": null,
"license": null,
"summary": "security-txt-policy-server serves `.well-known/security.txt` files.",
"version": "1.0.5.1.2",
"project_urls": {
"Source": "https://github.com/CyberfusionIO/python3-cyberfusion-security-txt-policy-server"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e7ee32b19c8846748f1c77fb9693367dc6de2d1952acd17a3451e2e32259eff9",
"md5": "62efdb1633b679b5ac48d20beb6aa3f5",
"sha256": "5ed960f1c4254c58651cad3b4460c6dca73a9b247773b2d78d679b4665a842a6"
},
"downloads": -1,
"filename": "python3_cyberfusion_security_txt_policy_server-1.0.5.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "62efdb1633b679b5ac48d20beb6aa3f5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 9726,
"upload_time": "2024-08-27T20:15:09",
"upload_time_iso_8601": "2024-08-27T20:15:09.518885Z",
"url": "https://files.pythonhosted.org/packages/e7/ee/32b19c8846748f1c77fb9693367dc6de2d1952acd17a3451e2e32259eff9/python3_cyberfusion_security_txt_policy_server-1.0.5.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f71a2dcba9cb8e125370449af55e5a1053c9cefcf8de2baa9ce934ff66e4efa0",
"md5": "d45c718acd5fac91a52b6b748d136e11",
"sha256": "551364f49a42427b49293741ab533b4d65c9b16ba34b3ccb1859af97a0da1713"
},
"downloads": -1,
"filename": "python3_cyberfusion_security_txt_policy_server-1.0.5.1.2.tar.gz",
"has_sig": false,
"md5_digest": "d45c718acd5fac91a52b6b748d136e11",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7154,
"upload_time": "2024-08-27T20:15:11",
"upload_time_iso_8601": "2024-08-27T20:15:11.584493Z",
"url": "https://files.pythonhosted.org/packages/f7/1a/2dcba9cb8e125370449af55e5a1053c9cefcf8de2baa9ce934ff66e4efa0/python3_cyberfusion_security_txt_policy_server-1.0.5.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-27 20:15:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "CyberfusionIO",
"github_project": "python3-cyberfusion-security-txt-policy-server",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "python3-cyberfusion-security-txt-policy-server"
}
JSON
