Home

py-file-server Wiki

Welcome to the documentation for py-file-server.

This wiki is organized so a new user can get running quickly, while power users and contributors can still find deeper operational and architectural details.

What this project is

py-file-server is a lightweight file sharing web app for local, LAN, and public sharing. In the current refactored release, it supports:

• Explicit runtime modes: local, lan, public
• JSON based persisted settings
• Optional tunnel based public sharing
• Concurrency controls for downloads
• Console monitoring and runtime hotkeys
• Safer path handling for shared files
• Optional admin routes
• Automated tests

Start here

If you are new to the project, read these pages first:

1. Installation
2. Quick Start
3. Running the Server
4. Configuration
5. Modes and Usage

Main sections

User docs

• Installation
• Quick Start
• Running the Server
• Configuration
• Modes and Usage
• Downloads and Performance
• Monitoring and Logs
• Security Basics
• Updating and Releases

Troubleshooting

• Troubleshooting
• FAQ

Developer docs

• Architecture Overview
• Project Structure
• CLI Reference
• Testing

Recommended reader paths

I just want to run it

Read:

1. Installation
2. Quick Start
3. Running the Server

I want to tune it for LAN use

Read:

1. Modes and Usage
2. Downloads and Performance
3. Monitoring and Logs
4. Troubleshooting

I want to understand the codebase

Read:

1. Architecture Overview
2. Project Structure
3. CLI Reference
4. Testing

Notes

• This wiki is written around the refactored release/1.3.0 layout.
• The legacy single-file entrypoint still exists for compatibility, but the application runtime is now organized as a package.

Related pages

• Quick Start
• Architecture Overview
• Troubleshooting