# ⚡ Phoenix ⚡
Phoenix is a speedy lightweight web server with support for modules and extensions.
## 📦 Installation 📦
You can quickly and easily install from PyPi by running:
```bash
pip install phoenix-ws
```
This provides you with the Phoenix server and PPM package manager.
## 😀 How it works 😀
Phoenix quickly reads all of the files used by the server and caches them. This reduces the amount of disk read-write operations. It then delivers the files using gzip and zlib to reduce packet size.
Phoenix uses a very small amount of RAM, making it perfect for production environments.
## 🏁 Getting Started 🏁
You can quickly run Phoenix with:
```bash
phoenix run
```
## ⚙ Configuration ⚙
### Command Line Configuration
#### `run`
> `--host` `-h` - Allow the server to be publicly accessible from other devices.
>
> `--port <port>` `-p <port>` - Specify the port to run the server on.
#### `install <package>`
>
### Project File Configuration
Phoenix can be configured per-project with a `phoenix.config.json` file. Here are the options:
> `host` (`bool`, `false`) - Allow the server to be publicly accessible from other devices.
>
> `port` (`int`, `8080`) - Specify the port to run the server on.
>
> `zlib` (`bool`, `true`) - Use zlib compression.
>
> `gzip` (`bool`, `true`) - Use gzip compression.
>
> `verbose` (`bool`, `false`) - Print extra debug messages to the console.
>
> `indexDirectories` (`bool`, `false`) - Display the directory's contents if no file is specified.
>
> `indexPhoenix` (`bool`, `false`) - Index the `/phoenix/` directory.
>
> `encoding` (`str`, `utf-8`) - Set the text encoding.
>
> `nocompress` (`list`, `[]`) - Disable compression on specific files. Each item of the list is the resource's URL.
>
> `minify` (`bool`, `true`) - Make HTML, CSS, and JS files smaller.
>
> `proxy` (`dict`, `{}`) - Reverse-proxy websites.
>
> `fixProxy` (`bool`, `true`) - Replace all instances of the proxied URL with the requested URL.
>
> `thisURL` (`str`) - A nice name for the website hosted by the server. Used for `fixProxy`.
Raw data
{
"_id": null,
"home_page": "https://codeberg.org/novaandromeda/phoenix",
"name": "phoenix-ws",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "Phoenix,Website,Web,Webserver,Server,Package Manager,HTML,CSS,JavaScript,JS,Fast",
"author": "Nova",
"author_email": "froggo8311@proton.me",
"download_url": "https://files.pythonhosted.org/packages/6a/a8/149a471c41f937c16bd293fb10415ebc724c44baf2f311532d94f957dcb7/phoenix-ws-2.0.7.tar.gz",
"platform": null,
"description": "# \u26a1 Phoenix \u26a1\nPhoenix is a speedy lightweight web server with support for modules and extensions.\n\n## \ud83d\udce6 Installation \ud83d\udce6\nYou can quickly and easily install from PyPi by running:\n```bash\npip install phoenix-ws\n```\n\nThis provides you with the Phoenix server and PPM package manager.\n\n## \ud83d\ude00 How it works \ud83d\ude00\nPhoenix quickly reads all of the files used by the server and caches them. This reduces the amount of disk read-write operations. It then delivers the files using gzip and zlib to reduce packet size.\n\nPhoenix uses a very small amount of RAM, making it perfect for production environments.\n\n## \ud83c\udfc1 Getting Started \ud83c\udfc1\nYou can quickly run Phoenix with:\n```bash\nphoenix run\n```\n\n## \u2699 Configuration \u2699\n### Command Line Configuration\n#### `run`\n> `--host` `-h` - Allow the server to be publicly accessible from other devices.\n>\n> `--port <port>` `-p <port>` - Specify the port to run the server on.\n\n#### `install <package>`\n> \n\n### Project File Configuration\nPhoenix can be configured per-project with a `phoenix.config.json` file. Here are the options:\n\n> `host` (`bool`, `false`) - Allow the server to be publicly accessible from other devices.\n> \n> `port` (`int`, `8080`) - Specify the port to run the server on.\n>\n> `zlib` (`bool`, `true`) - Use zlib compression.\n>\n> `gzip` (`bool`, `true`) - Use gzip compression.\n>\n> `verbose` (`bool`, `false`) - Print extra debug messages to the console.\n>\n> `indexDirectories` (`bool`, `false`) - Display the directory's contents if no file is specified.\n>\n> `indexPhoenix` (`bool`, `false`) - Index the `/phoenix/` directory.\n>\n> `encoding` (`str`, `utf-8`) - Set the text encoding.\n>\n> `nocompress` (`list`, `[]`) - Disable compression on specific files. Each item of the list is the resource's URL.\n>\n> `minify` (`bool`, `true`) - Make HTML, CSS, and JS files smaller.\n>\n> `proxy` (`dict`, `{}`) - Reverse-proxy websites.\n>\n> `fixProxy` (`bool`, `true`) - Replace all instances of the proxied URL with the requested URL.\n>\n> `thisURL` (`str`) - A nice name for the website hosted by the server. Used for `fixProxy`.\n",
"bugtrack_url": null,
"license": "UNLICENSE",
"summary": "Speedy alternative web server",
"version": "2.0.7",
"project_urls": {
"Homepage": "https://codeberg.org/novaandromeda/phoenix"
},
"split_keywords": [
"phoenix",
"website",
"web",
"webserver",
"server",
"package manager",
"html",
"css",
"javascript",
"js",
"fast"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b5d713e6c8f04fe47b83efe3f6cc19999c498f23fb773ce21627a13e2a70c56b",
"md5": "0f91eda15c6feb1fef7bcbb0c702cee8",
"sha256": "d29dfef48b188d4a117bfab8a15130cee6150c6cd3756b467f83c6456129a42e"
},
"downloads": -1,
"filename": "phoenix_ws-2.0.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0f91eda15c6feb1fef7bcbb0c702cee8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 21395,
"upload_time": "2024-02-15T16:26:34",
"upload_time_iso_8601": "2024-02-15T16:26:34.061557Z",
"url": "https://files.pythonhosted.org/packages/b5/d7/13e6c8f04fe47b83efe3f6cc19999c498f23fb773ce21627a13e2a70c56b/phoenix_ws-2.0.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6aa8149a471c41f937c16bd293fb10415ebc724c44baf2f311532d94f957dcb7",
"md5": "9c2e0aee1ea7eee43e9bd9d3e5e57c10",
"sha256": "8e9d57a72753661f3b7d225fc2e9fb7640aceb83d79fd6c9cc4ecda756eafc98"
},
"downloads": -1,
"filename": "phoenix-ws-2.0.7.tar.gz",
"has_sig": false,
"md5_digest": "9c2e0aee1ea7eee43e9bd9d3e5e57c10",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 21357,
"upload_time": "2024-02-15T16:26:35",
"upload_time_iso_8601": "2024-02-15T16:26:35.530308Z",
"url": "https://files.pythonhosted.org/packages/6a/a8/149a471c41f937c16bd293fb10415ebc724c44baf2f311532d94f957dcb7/phoenix-ws-2.0.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-15 16:26:35",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": true,
"codeberg_user": "novaandromeda",
"codeberg_project": "phoenix",
"lcname": "phoenix-ws"
}
JSON