| Name | fast-redirect JSON |
| Version |
1.0.6.1
JSON |
| download |
| home_page | None |
| Summary | fast-redirect redirects domains. |
| upload_time | 2024-08-26 14:43:40 |
| 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.
|
# fast-redirect
fast-redirect redirects domains.
# Install
## PyPI
Run the following command to install the package from PyPI:
pip3 install fast-redirect
# Configure
## App
Find an example config in `.env.example`.
Add settings to the `.env` file. This file is relative to your working directory.
Only `DATABASE_PATH` is required to be set. We recommend setting it to `/var/lib/fast-redirect.json`.
These settings can be overridden by specifying them as environment variables.
## JSON Database
Find an example JSON database in `fast-redirect.json`.
Properties:
* `destination_url`. URL to redirect to. This must be a URL (i.e. `www.domlimev.nl` is invalid).
* `status_code`. Allowed values: `301`, `302`, `303`, `307`, `308`.
* `keep_query_parameters`. Whether query parameters are kept. If this is false, query parameters are discarded from the `destination_url`. For example, if this is false, `https://domlimev.nl/page?k=v` is redirected to `https://example.com`.
* `keep_path`. Whether the path is kept. If this is false, the path is discarded from the `destination_url`. For example, if this is false, `https://domlimev.nl/this/is/a/path` is redirected to `https://example.com`.
# Usage
## Start
Start fast-redirect manually with:
bin/fast-redirect
Find the systemd configuration in `fast-redirect.service`.
## SSL
Use a proxy that terminates SSL. E.g. [HAProxy](http://www.haproxy.org/).
The domain or IP address that the proxy uses for health checks should not be configured as a redirect.
Raw data
{
"_id": null,
"home_page": null,
"name": "fast-redirect",
"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/72/6b/74de7aefbd852394d11a8b6e1c89cf8fa957cc86612008599c006f43e4b3/fast_redirect-1.0.6.1.tar.gz",
"platform": null,
"description": "# fast-redirect\n\nfast-redirect redirects domains.\n\n# Install\n\n## PyPI\n\nRun the following command to install the package from PyPI:\n\n pip3 install fast-redirect\n\n# Configure\n\n## App\n\nFind an example config in `.env.example`.\n\nAdd settings to the `.env` file. This file is relative to your working directory.\n\nOnly `DATABASE_PATH` is required to be set. We recommend setting it to `/var/lib/fast-redirect.json`.\n\nThese settings can be overridden by specifying them as environment variables.\n\n## JSON Database\n\nFind an example JSON database in `fast-redirect.json`.\n\nProperties:\n\n* `destination_url`. URL to redirect to. This must be a URL (i.e. `www.domlimev.nl` is invalid).\n* `status_code`. Allowed values: `301`, `302`, `303`, `307`, `308`.\n* `keep_query_parameters`. Whether query parameters are kept. If this is false, query parameters are discarded from the `destination_url`. For example, if this is false, `https://domlimev.nl/page?k=v` is redirected to `https://example.com`.\n* `keep_path`. Whether the path is kept. If this is false, the path is discarded from the `destination_url`. For example, if this is false, `https://domlimev.nl/this/is/a/path` is redirected to `https://example.com`.\n\n# Usage\n\n## Start\n\nStart fast-redirect manually with:\n\n bin/fast-redirect\n\nFind the systemd configuration in `fast-redirect.service`.\n\n## SSL\n\nUse a proxy that terminates SSL. E.g. [HAProxy](http://www.haproxy.org/).\n\nThe domain or IP address that the proxy uses for health checks should not be configured as a redirect.\n",
"bugtrack_url": null,
"license": null,
"summary": "fast-redirect redirects domains.",
"version": "1.0.6.1",
"project_urls": {
"Source": "https://github.com/CyberfusionIO/fast-redirect"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "edd9db1ab7ffbba945aa277b788b3004e541d82483e1e4e0914caa28bac10723",
"md5": "c787de631d9e21bcb762fbf0747dc6c4",
"sha256": "cab48d332fae7ec7e0832b4ea20c0a8fb0efee42424cb04640b8faac32d57bbf"
},
"downloads": -1,
"filename": "fast_redirect-1.0.6.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c787de631d9e21bcb762fbf0747dc6c4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 9546,
"upload_time": "2024-08-26T14:43:39",
"upload_time_iso_8601": "2024-08-26T14:43:39.649379Z",
"url": "https://files.pythonhosted.org/packages/ed/d9/db1ab7ffbba945aa277b788b3004e541d82483e1e4e0914caa28bac10723/fast_redirect-1.0.6.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "726b74de7aefbd852394d11a8b6e1c89cf8fa957cc86612008599c006f43e4b3",
"md5": "1904b260fc6fec88df8cb7ef542360f1",
"sha256": "528358fbf5bf157e3e37ffba86b306df38a81b9298e0310c6338ca9181d697ae"
},
"downloads": -1,
"filename": "fast_redirect-1.0.6.1.tar.gz",
"has_sig": false,
"md5_digest": "1904b260fc6fec88df8cb7ef542360f1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7395,
"upload_time": "2024-08-26T14:43:40",
"upload_time_iso_8601": "2024-08-26T14:43:40.527931Z",
"url": "https://files.pythonhosted.org/packages/72/6b/74de7aefbd852394d11a8b6e1c89cf8fa957cc86612008599c006f43e4b3/fast_redirect-1.0.6.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-26 14:43:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "CyberfusionIO",
"github_project": "fast-redirect",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "fast-redirect"
}
