| Name | python3-cyberfusion-fast-redirect JSON |
| Version |
1.0.7
JSON |
| download |
| home_page | None |
| Summary | fast-redirect redirects domains. |
| upload_time | 2024-08-29 08:25:33 |
| 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.
|
# python3-cyberfusion-fast-redirect
fast-redirect redirects domains.
# Install
## PyPI
Run the following command to install the package from PyPI:
pip3 install python3-cyberfusion-fast-redirect
## 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
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
## Manually
bin/fast-redirect
### systemd
systemctl start 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": "python3-cyberfusion-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/46/cc/18d12eb130668d6e19c3cebc66e1b4c0ed721d8476ceb0218c89073bb14c/python3_cyberfusion_fast_redirect-1.0.7.tar.gz",
"platform": null,
"description": "# python3-cyberfusion-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 python3-cyberfusion-fast-redirect\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\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## Manually\n\n bin/fast-redirect\n\n### systemd\n\n systemctl start 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.7",
"project_urls": {
"Source": "https://github.com/CyberfusionIO/python3-cyberfusion-fast-redirect"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e95e1debc839b36af7a8bc13a1223f8ac9adebea0e9261cda340140ea3885cc0",
"md5": "ff804e125abfa88c9dd6f749c8d00f2b",
"sha256": "6934e0aa9f7c06150eb92ad893506de5f487156b7af680c26ec8c67e37235b3b"
},
"downloads": -1,
"filename": "python3_cyberfusion_fast_redirect-1.0.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ff804e125abfa88c9dd6f749c8d00f2b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 9825,
"upload_time": "2024-08-29T08:25:32",
"upload_time_iso_8601": "2024-08-29T08:25:32.387454Z",
"url": "https://files.pythonhosted.org/packages/e9/5e/1debc839b36af7a8bc13a1223f8ac9adebea0e9261cda340140ea3885cc0/python3_cyberfusion_fast_redirect-1.0.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "46cc18d12eb130668d6e19c3cebc66e1b4c0ed721d8476ceb0218c89073bb14c",
"md5": "e5de271ba717ead39be152ac90877966",
"sha256": "5c6171fb11b49c3df43dd6260a376b0f2955fcc96248e8bb49cb6b3977e93128"
},
"downloads": -1,
"filename": "python3_cyberfusion_fast_redirect-1.0.7.tar.gz",
"has_sig": false,
"md5_digest": "e5de271ba717ead39be152ac90877966",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7682,
"upload_time": "2024-08-29T08:25:33",
"upload_time_iso_8601": "2024-08-29T08:25:33.769865Z",
"url": "https://files.pythonhosted.org/packages/46/cc/18d12eb130668d6e19c3cebc66e1b4c0ed721d8476ceb0218c89073bb14c/python3_cyberfusion_fast_redirect-1.0.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-29 08:25:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "CyberfusionIO",
"github_project": "python3-cyberfusion-fast-redirect",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "python3-cyberfusion-fast-redirect"
}
