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.0.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.0-py3-none-any.whl (18.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pywebfs-1.0.0.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.0.tar.gz
Algorithm Hash digest
SHA256 f635df2e8c99e4c643283357e37684445466717dbbeaef183fd09a46cf9e52be
MD5 22b223ebdcb15a3348afdee4c95af1ab
BLAKE2b-256 0dceb79cbfa3600a2c6856cbe36637b197b8156f74a9258b73135b81b0c10c29

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pywebfs-1.0.0-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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 122ba66f19b639cd8e3f37d8924644152ce8a58b8fb8730c2545e7309a2a4efd
MD5 12336ce78732ff8639baf4932888ffc1
BLAKE2b-256 3a942ebc828cf2cdf0fc1e887d11bc919da0337b9976aa403f64681d1dadd709

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