[](https://github.com/OBoladeras/updog2/blob/master/LICENSE)
<p>
<img src="https://raw.githubusercontent.com/OBoladeras/updog2/main/updog2/static/images/updog.png" width=85px alt="updog"/>
</p>
Updog is a replacement for Python's `SimpleHTTPServer`.
It allows uploading and downloading via HTTP/S,
can set ad hoc SSL certificates and use HTTP basic auth.
The last version allows to generate a QR code to share the link
and also allows to display just image files in a more friendly way.
<p align="center">
<img src="https://raw.githubusercontent.com/OBoladeras/updog2/main/updog2/static/images/example.png" alt="Updog screenshot"/>
</p>
<p align="center">
<img src="https://raw.githubusercontent.com/OBoladeras/updog2/main/updog2/static/images/example2.png" alt="Updog screenshot 2"/>
</p>
## Installation
Install using pip:
`pip3 install updog2`
## Usage
`updog [-d DIRECTORY] [-p PORT] [-qr] [-q] [-i] [--password PASSWORD] [--ssl] [--version] [DIRECTORY]`
| Argument | Description |
|-------------------------------------|--------------------------------------------------|
| -d DIRECTORY, --directory DIRECTORY | Root directory [Default=.] |
| -p PORT, --port PORT | Port to serve [Default=9090] |
| -qr, --qr | Show QR code to access the page |
| -q, --quiet | Do not display the QR code in the webpage |
| -i, --images | Show the images in the directory |
| --password PASSWORD | Use a password to access the page. (No username) |
| --ssl | Enable transport encryption via SSL |
| --version | Show version |
| -h, --help | Show help |
## Examples
**Serve from your current directory:**
`updog2`
**Serve from another directory:**
`updog2 -d /another/directory`
**Serve from port 1234:**
`updog2 -p 1234`
**Password protect the page:**
`updog2 --password examplePassword123!`
*Please note*: updog uses HTTP basic authentication.
To login, you should leave the username blank and just
enter the password in the password field.
**Use an SSL connection:**
`updog2 --ssl`
**Show a QR code to access the page:**
`updog2 -qr`
**Show the images in the directory:**
`updog2 -i`
**More examples:**
`updog2 /tmp/mydog -iqp 1234 --password examplePassword123! --ssl -qr`
## Notes
This project is a fork of [updog](https://github.com/sc0tfree/updog) by [sc0tfree](https://github.com/sc0tfree).
The original project is no longer maintained, so I decided to fork it and keep it up to date.
The principal changes I made can be found in the [CHANGELOG](CHANGELOG.md).
Raw data
{
"_id": null,
"home_page": "https://github.com/OBoladeras/updog2",
"name": "updog2",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "HTTP server SimpleHTTPServer directory",
"author": "OBoladeras",
"author_email": "oriolboladeras@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/19/1b/9ccce623f460f3aab164df6d99823f3f216582f008afdbacdf9166b0de27/updog2-2.2.0.tar.gz",
"platform": null,
"description": "\n\n[](https://github.com/OBoladeras/updog2/blob/master/LICENSE)\n\n<p>\n <img src=\"https://raw.githubusercontent.com/OBoladeras/updog2/main/updog2/static/images/updog.png\" width=85px alt=\"updog\"/>\n</p>\n\nUpdog is a replacement for Python's `SimpleHTTPServer`. \nIt allows uploading and downloading via HTTP/S, \ncan set ad hoc SSL certificates and use HTTP basic auth. \nThe last version allows to generate a QR code to share the link \nand also allows to display just image files in a more friendly way.\n\n<p align=\"center\">\n <img src=\"https://raw.githubusercontent.com/OBoladeras/updog2/main/updog2/static/images/example.png\" alt=\"Updog screenshot\"/>\n</p>\n<p align=\"center\">\n <img src=\"https://raw.githubusercontent.com/OBoladeras/updog2/main/updog2/static/images/example2.png\" alt=\"Updog screenshot 2\"/>\n</p>\n\n\n\n## Installation\n\nInstall using pip:\n\n`pip3 install updog2`\n\n## Usage\n\n`updog [-d DIRECTORY] [-p PORT] [-qr] [-q] [-i] [--password PASSWORD] [--ssl] [--version] [DIRECTORY]`\n\n| Argument | Description |\n|-------------------------------------|--------------------------------------------------| \n| -d DIRECTORY, --directory DIRECTORY | Root directory [Default=.] | \n| -p PORT, --port PORT | Port to serve [Default=9090] |\n| -qr, --qr | Show QR code to access the page |\n| -q, --quiet | Do not display the QR code in the webpage |\n| -i, --images | Show the images in the directory |\n| --password PASSWORD | Use a password to access the page. (No username) |\n| --ssl | Enable transport encryption via SSL |\n| --version | Show version |\n| -h, --help | Show help |\n\n## Examples\n\n**Serve from your current directory:**\n\n`updog2`\n\n**Serve from another directory:**\n\n`updog2 -d /another/directory`\n\n**Serve from port 1234:**\n\n`updog2 -p 1234`\n\n**Password protect the page:**\n\n`updog2 --password examplePassword123!`\n\n*Please note*: updog uses HTTP basic authentication.\nTo login, you should leave the username blank and just\nenter the password in the password field.\n\n**Use an SSL connection:**\n\n`updog2 --ssl`\n\n**Show a QR code to access the page:**\n\n`updog2 -qr`\n\n**Show the images in the directory:**\n\n`updog2 -i`\n\n**More examples:**\n\n`updog2 /tmp/mydog -iqp 1234 --password examplePassword123! --ssl -qr`\n\n\n## Notes\n\nThis project is a fork of [updog](https://github.com/sc0tfree/updog) by [sc0tfree](https://github.com/sc0tfree).\nThe original project is no longer maintained, so I decided to fork it and keep it up to date. \nThe principal changes I made can be found in the [CHANGELOG](CHANGELOG.md).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Updog is a replacement for Python's SimpleHTTPServer. It allows uploading and downloading via HTTP/S, can set ad hoc SSL certificates and use http basic auth. The last version allows to generate a QR code to share the link and also allows to display just image files in a more friendly way.",
"version": "2.2.0",
"project_urls": {
"Download": "https://github.com/OBoladeras/updog2/archive/updog-2.2.0.tar.gz",
"Homepage": "https://github.com/OBoladeras/updog2"
},
"split_keywords": [
"http",
"server",
"simplehttpserver",
"directory"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dd2753dcf0915588e0a449e4b743d7a6faad315d3df4a30a9c32ca3cbae72c6c",
"md5": "90056666681e04c171d697dcfd41f9fe",
"sha256": "3c73e6bb8339a71abac2f5e5c19ea543428be933961ea7d088ee801749066b85"
},
"downloads": -1,
"filename": "updog2-2.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "90056666681e04c171d697dcfd41f9fe",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4677003,
"upload_time": "2024-09-10T11:46:47",
"upload_time_iso_8601": "2024-09-10T11:46:47.796778Z",
"url": "https://files.pythonhosted.org/packages/dd/27/53dcf0915588e0a449e4b743d7a6faad315d3df4a30a9c32ca3cbae72c6c/updog2-2.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "191b9ccce623f460f3aab164df6d99823f3f216582f008afdbacdf9166b0de27",
"md5": "ee7b520a9b02386aa6bb60fcda12f65e",
"sha256": "5b19a2a98f7b71225c50dfef2f45073aa1497138f57273b25a74f6454c1511fa"
},
"downloads": -1,
"filename": "updog2-2.2.0.tar.gz",
"has_sig": false,
"md5_digest": "ee7b520a9b02386aa6bb60fcda12f65e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4675811,
"upload_time": "2024-09-10T11:46:49",
"upload_time_iso_8601": "2024-09-10T11:46:49.539689Z",
"url": "https://files.pythonhosted.org/packages/19/1b/9ccce623f460f3aab164df6d99823f3f216582f008afdbacdf9166b0de27/updog2-2.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-10 11:46:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OBoladeras",
"github_project": "updog2",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "colorama",
"specs": []
},
{
"name": "flask",
"specs": []
},
{
"name": "flask_httpauth",
"specs": []
},
{
"name": "werkzeug",
"specs": []
},
{
"name": "pyopenssl",
"specs": []
},
{
"name": "qrcode",
"specs": []
},
{
"name": "pillow",
"specs": []
}
],
"lcname": "updog2"
}
JSON
