Skip to main content

Simple Python HTTP File Server

Project description

Pypi version example Licence Python versions

pywebfs

Simple Python HTTP(S) File Server

Install

$ pip install pywebfs

Quick start

  • start http server sharing current directory listening on 0.0.0.0 port 8080
$ pywebfs
  • Browse/Download/Search files using browser http://<yourserver>:8080 image

  • search text in files (grep) image

features

  • Serve static files
  • Download folder as zip file
  • Filter files
  • Search files recursively multiple word any order (disable feature with --nosearch)
  • Search text in files recursively
  • Basic Auth support (single user)
  • HTTPS support
  • HTTPS self-signed certificate generator
  • Display owner/group/permissions (POSIX) (disable feature with --noperm)
  • Can be started as a daemon (POSIX)

Customize server

$ pywebfs --dir /mydir --title "my fileserver" --listen 0.0.0.0 --port 8080
$ pywebfs -d /mydir -t "my fileserver" -l 0.0.0.0 -p 8080

Basic auth user/password

$ pywebfs --dir /mydir --user myuser [--password mypass]
$ pywebfs -d /mydir -u myuser [-P mypass]

Generated password is given if no --pasword option

HTTPS server

  • Generate auto-signed certificate and start https server
$ pywebfs --dir /mydir --gencert
$ pywebfs -d /mydir --g
  • Start https server using existing certificate
$ pywebfs --dir /mydir --cert /pathto/host.cert --key /pathto/host.key
$ pywebfs -d /mydir -c /pathto/host.cert -k /pathto/host.key

Launch server as a daemon (Linux)

$ pywebfs start
$ pywebfs status
$ pywebfs stop
  • log of server are stored in ~/.pywebfs/pwfs_<listen>:<port>.log

Disclaimer

As built on python http.server, read in the python3 documentation:

Warning http.server is not recommended for production. It only implements basic security checks.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pywebfs-1.0.1.tar.gz (21.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pywebfs-1.0.1-py3-none-any.whl (18.6 kB view details)

Uploaded Python 3

File details

Details for the file pywebfs-1.0.1.tar.gz.

File metadata

  • Download URL: pywebfs-1.0.1.tar.gz
  • Upload date:
  • Size: 21.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.9.21

File hashes

Hashes for pywebfs-1.0.1.tar.gz
Algorithm Hash digest
SHA256 a3f89ea2ac9637981f00252db79d3b94868c7f997be36a665cbab6587ddf47a6
MD5 279c9b8987ec32cc72c2bf9dc7f53354
BLAKE2b-256 98a44ec744f502e48c0358e31c1edc1724d3844237b1e1a20c65e8158204a15a

See more details on using hashes here.

File details

Details for the file pywebfs-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: pywebfs-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 18.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.9.21

File hashes

Hashes for pywebfs-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 88f67d148d448593a274d510d284856d6ed983bd617241cd029a4315473d1f2e
MD5 20c440f49f9f53b858a549703818f9d9
BLAKE2b-256 0ce4a486ac61793b2dfea2e6ae1b64eb3ad57acd274aa5836bd4576b9588b9e6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page