PiShare

PiShare is a spiritual successor to the Piratebox project. Its aim is to allow offline sharing of information.

Features

• File Sharing
• Chat

Setting up PiShare

Clone PiShare

git clone https://github.com/qasterr/pishare.git
cd pishare

Set up a virtual environment

If you don't know how to do this, see Real Python's introduction to virtual environments.

Install the required dependencies

pip install -r requirements.txt

Configure PiShare

Create a file named config.py in the directory named instance. Copy the configuration from the Configuration Keys section and change the values you wish to change.

Starting PiShare

Linux or Mac

./run.sh

Windows

Unfortunately, PiShare doesn't work on Windows due to gunicorn — the server program we use — not working on Windows. If you find a way to use PiShare on Windows without WSL, feel free to open an issue.

Configuration Keys

Example instances/config.py file:

SECRET_KEY = "<YOUR_SECRET_KEY>"
UPLOAD_FOLDER = "uploads"

SECRET_KEY

A secret key used by Flask. If you do not know how to generate one see this Stack Overflow answer.

UPLOAD_FOLDER

The name of the folder to use for downloaded files. Will default to uploads if not set.

Open Source Licenses

PiShare is built upon great software by the open source community. These are their licenses.

Flask — BSD-3-Clause License

Flask-Autoindex — MIT License

Socket.IO — MIT License

Flask-SocketIO — MIT License

MarkupSafe — BSD-3-Clause License

Flask-SocketIO-Chat — MIT License