| Name | security-txt-policy-server JSON |
| Version |
1.0.4
JSON |
| download |
| home_page | None |
| Summary | security-txt-policy-server serves `.well-known/security.txt` files. |
| upload_time | 2024-08-26 14:38:43 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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 security-txt-policy-server
```
# 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
## Start
Start security-txt-policy-server manually with:
```
bin/security-txt-policy-server
```
Find the systemd configuration in `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": "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/f6/67/e80ecd902573181d0c8ee7331076f1c2c390e5ae77ae500ee70d7f9c2bd7/security_txt_policy_server-1.0.4.tar.gz",
"platform": null,
"description": "# 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 security-txt-policy-server\n```\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## Start\n\nStart security-txt-policy-server manually with:\n\n```\nbin/security-txt-policy-server\n```\n\nFind the systemd configuration in `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.4",
"project_urls": {
"Source": "https://github.com/CyberfusionIO/security-txt-policy-server"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "00ef6e29997d379192a45ab0120f6123138506a2b400a6326a23b6bda98cfeaf",
"md5": "145aaec48f9a413ad58c5245fb3b79b6",
"sha256": "0ccd2cba29b6772c613ab7ea07d85c3cf261c16ec48acec581ca0074b9660187"
},
"downloads": -1,
"filename": "security_txt_policy_server-1.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "145aaec48f9a413ad58c5245fb3b79b6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 9376,
"upload_time": "2024-08-26T14:38:42",
"upload_time_iso_8601": "2024-08-26T14:38:42.609169Z",
"url": "https://files.pythonhosted.org/packages/00/ef/6e29997d379192a45ab0120f6123138506a2b400a6326a23b6bda98cfeaf/security_txt_policy_server-1.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f667e80ecd902573181d0c8ee7331076f1c2c390e5ae77ae500ee70d7f9c2bd7",
"md5": "75dc026d7eb576fecf898e3b9f4142fb",
"sha256": "43b564bc0f7493451c022733e4512c72b53d6a625cdea13aab75e25cfe18f0b7"
},
"downloads": -1,
"filename": "security_txt_policy_server-1.0.4.tar.gz",
"has_sig": false,
"md5_digest": "75dc026d7eb576fecf898e3b9f4142fb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6863,
"upload_time": "2024-08-26T14:38:43",
"upload_time_iso_8601": "2024-08-26T14:38:43.959447Z",
"url": "https://files.pythonhosted.org/packages/f6/67/e80ecd902573181d0c8ee7331076f1c2c390e5ae77ae500ee70d7f9c2bd7/security_txt_policy_server-1.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-26 14:38:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "CyberfusionIO",
"github_project": "security-txt-policy-server",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "security-txt-policy-server"
}
