Skip to main content

A beautiful, feature-rich local file server

Project description

๐Ÿ Pineapplee

A clean, fast, local file server โ€” right in your browser.

PyPI version Python Downloads License: MIT

PyPI ยท GitHub ยท Report a Bug


Pineapplee turns any folder on your machine into a shareable web interface โ€” browse, upload, download, and manage files from any device on your network, or share publicly with a single flag.


โœจ Features

๐Ÿ“ Browse & Navigate Clean file listing with sortable columns, pagination, breadcrumb trail, and folder navigation
โฌ†๏ธ Upload Drag-and-drop files or entire folders โ€” with real-time progress
โฌ‡๏ธ Download Single files or bulk ZIP archives with smart compression
๐Ÿ‘๏ธ Preview Images, video, audio, PDFs, and text files โ€” all in-browser
โœ๏ธ Rename & Delete Manage files without leaving the browser
๐Ÿ“Š Folder Sizes Async background calculation โ€” listing loads instantly
๐ŸŒ Public Share One flag to expose your server publicly via Cloudflare Tunnel โ€” no account needed
๐Ÿ”’ Safe by default Path traversal protection, symlink validation, upload size limits

๐Ÿš€ Installation

Recommended (using pipx)

pipx installs Python CLI tools in isolated environments โ€” no conflicts, no permission errors. This is the best way to install on macOS, Linux, and Windows.

# Install pipx if you don't have it
# macOS / Linux (Homebrew)
brew install pipx

# Windows (scoop)
scoop install pipx

# Or with pip (any OS)
pip install pipx
pipx ensurepath

Then install Pineapplee:

pipx install pineapplee

Update to the latest version:

pipx upgrade pineapplee

Using pip

If you're inside a virtual environment or managing packages yourself:

pip install pineapplee

Update:

pip install --upgrade pineapplee

Getting externally-managed-environment error? Modern macOS/Linux (PEP 668) blocks system-wide pip installs to protect your OS Python. Use pipx instead (see above), or use a virtual environment:

python3 -m venv ~/myenv
source ~/myenv/bin/activate
pip install pineapplee

๐Ÿš€ Quick Start

# Serve the current directory
pineapplee

# Serve a specific path
pineapplee ~/Downloads

# Different port
pineapplee --port 9000

# Share publicly over the internet
pineapplee --public

# Check installed version
pineapplee --version

Open http://localhost:8089 โ€” and you're in.


๐Ÿ“– Usage

usage: pineapplee [-h] [-v] [--port PORT] [--public] [directory]

positional arguments:
  directory         Directory to serve (default: current directory)

options:
  -h, --help        show this help message and exit
  -v, --version     show installed version and exit
  --port, -p      Port to listen on (default: 8089)
  --public        Expose publicly via Cloudflare Tunnel

Local network sharing

Pineapple binds to 0.0.0.0, so any device on your LAN can reach it at the Network URL printed in the terminal:

  โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
  โ”ƒ ๐Ÿ Pineapple File Server                  โ”ƒ
  โ”ฃโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ซ
  โ”ƒ                                           โ”ƒ
  โ”ƒ   ๐Ÿ“‚ Serving     /Users/you/Documents     โ”ƒ
  โ”ƒ   ๐Ÿ”— Local       http://localhost:8089    โ”ƒ
  โ”ƒ   ๐ŸŒ Network     http://192.168.1.5:8089  โ”ƒ
  โ”ƒ   ๐Ÿ“ฆ Max upload  500 MB                   โ”ƒ
  โ”ƒ                                           โ”ƒ
  โ”ฃโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ซ
  โ”ƒ   Press Ctrl+C to stop                    โ”ƒ
  โ”—โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”›

Public sharing

pineapplee --public

On first run this downloads the cloudflared binary (~50 MB, cached to ~/.pineapplee/bin/). A public trycloudflare.com URL is printed โ€” share it with anyone, anywhere.


๐Ÿ”’ Security

  • All file paths are validated and confined to the served directory
  • Symlinks pointing outside the root are silently ignored
  • Upload size capped at 500 MB by default
  • Hidden files (dotfiles, __pycache__, node_modules, .egg-info, etc.) are never shown

Note: Pineapple is designed for local and trusted-network use. Do not expose it to the public internet without understanding the implications.


๐Ÿ“‹ Requirements

  • Python >= 3.8
  • Flask >= 2.0

All dependencies are installed automatically.


๐Ÿ› Troubleshooting

Problem Solution
externally-managed-environment error Use pipx install pineapplee instead of pip
command not found: pineapplee Run pipx ensurepath and restart your terminal. If using pip, add ~/.local/bin to your PATH: export PATH="$HOME/.local/bin:$PATH" in ~/.zshrc or ~/.bashrc
--public tunnel shows 404 Upgrade to latest version โ€” fixed IPv6/IPv4 mismatch. Also wait 5-10 sec after URL appears for DNS propagation
cloudflared blocked on macOS Upgrade to latest โ€” quarantine flag is now auto-removed. Or manually: xattr -d com.apple.quarantine ~/.pineapplee/bin/cloudflared
Folder names with spaces return 404 Upgrade to v0.1.5+ โ€” Unicode normalization fix
Slow loading on large directories Upgrade to v0.1.5+ โ€” listing is now paginated
cloudflared not found (--public) First run downloads it automatically; ensure internet access
Multiple Python versions installed Use python3 -m pip install pineapplee to ensure the right pip, or use pipx

๐Ÿ“„ License

MIT ยฉ KalaaKaar

Project details


Download files

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

Source Distribution

pineapplee-0.1.8.tar.gz (26.6 kB view details)

Uploaded Source

Built Distribution

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

pineapplee-0.1.8-py3-none-any.whl (24.2 kB view details)

Uploaded Python 3

File details

Details for the file pineapplee-0.1.8.tar.gz.

File metadata

  • Download URL: pineapplee-0.1.8.tar.gz
  • Upload date:
  • Size: 26.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.0

File hashes

Hashes for pineapplee-0.1.8.tar.gz
Algorithm Hash digest
SHA256 329ff7c2f5baca58a5a4ad22278153ac86f7f4615d7ada6f5023db316beeafac
MD5 dbe744835ffd5db533c708bb49834626
BLAKE2b-256 1f498fb08f4f83510a8774730256ea61224b1a1025a1d4221624e7cc6bbc684c

See more details on using hashes here.

File details

Details for the file pineapplee-0.1.8-py3-none-any.whl.

File metadata

  • Download URL: pineapplee-0.1.8-py3-none-any.whl
  • Upload date:
  • Size: 24.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.0

File hashes

Hashes for pineapplee-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 5f4863375591737a1340233924be240cb1ec14debe393c0e38b3e323bfc01698
MD5 b02e252a7c6649cf764124b4e6514fa5
BLAKE2b-256 e75902236a6d4d8915719c144367f2f1ce6d07847dff9dbeb55b1b377f0489bf

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