Bepasty Server

Permissions are assigned to specific login credentials or to anonymous (not logged-in) users. The available permission levels are:

• create: Ability to create pastebins.
• modify: Ability to modify existing pastebins.
• read: Ability to read or download pastebins.
• delete: Ability to delete pastebins.
• list: Ability to list (discover) all pastebins. (Note: Granting this to everyone reduces privacy).
• admin: Ability to lock/unlock files and perform actions even if an upload is incomplete or an item is locked.

Bepasty provides a SHA256 hash for every file. You can use this hash as a 'fingerprint' to ensure file integrity:

• Post-upload: Compare the size and hash shown on Bepasty with your local file to confirm a successful upload.
• Post-download: Compare the hash of your downloaded file with the hash shown on Bepasty.
• End-to-end: Compare the hash of the file at the source (Location A) with the hash at the destination (Location C) to ensure no corruption occurred during the transfer via Bepasty.

bepasty uses a storage backend API to manage file data and metadata.

Currently, the following backends are available:

• Filesystem Storage: The standard implementation. To use it, configure a filesystem directory where the server will store <uuid>.meta and <uuid>.data files.
• Ceph Cluster Storage: A specialized implementation for Ceph. Note that this is currently not available in the master branch or official releases; it is maintained in the ceph-storage branch due to ongoing issues.

Create an executable shell script at /home/bepasty/bin/gunicorn_bepasty to manage the Gunicorn process. This script sets the BEPASTY_CONFIG environment variable and uses the gevent worker class.

Ensure you make the script executable with chmod +x ~/bin/gunicorn_bepasty after creation.

#!/bin/bash

NAME="bepasty"
HOME=/home/bepasty
SOCKFILE=$HOME/gunicorn.sock  # we will communicate using this unix socket
PIDFILE=$HOME/gunicorn.pid
NUM_WORKERS=3                 # how many worker processes should Gunicorn spawn
export BEPASTY_CONFIG=$HOME/bepasty.conf

source $HOME/bin/activate

cd $HOME/repo

exec gunicorn bepasty.wsgi \
  --name $NAME \
  --workers $NUM_WORKERS \
  --log-level=info \
  --bind=unix:$SOCKFILE \
  --pid $PIDFILE \
  -k gevent

To run the Bepasty server with a specific configuration, set the BEPASTY_CONFIG environment variable to the absolute path of your configuration file.

Development vs. Production: The built-in WSGI server is intended for development only. For production environments, use a production-grade WSGI server like Gunicorn, Apache + mod_wsgi, or Nginx + uWSU6.

# Development (using built-in server)
BEPASTY_CONFIG=/srv/bepasty/bepasty.conf bepasty-server

# Production (using Gunicorn)
gunicorn bepasty.wsgi

All Bepasty CLI commands require access to a configuration file. You can provide this either by using the --config <configfilename> argument or by setting the BEPASTY_CONFIG environment variable.

Common commands include bepasty-object, which operates on objects in storage. Subcommands for bepasty-object include:

• info: Get information about objects.
• set: Set flags on objects.
• purge: Remove objects based on criteria.
• consistency: Check storage consistency.
• migrate: Upgrade stored metadata to the current schema (required after upgrades).

# Example: Purge objects (dry-run) that are >= 10MiB and >= 14 days old
bepasty-object purge --dry-run --size 10 --age 14 '*'

# Example: Migrate metadata after an upgrade
bepasty-object migrate '*'

You can install Bepasty from PyPI for the latest stable release, or directly from the Git repository for the latest available code. If you require MIME type detection via python-magic, install the [magic] extra.

# from PyPI:
pip install bepasty

# with python-magic support:
pip install bepasty[magic]

# from Git repository:
pip install -e git+https://github.com/bepasty/bepasty-server.git#egg=bepasty-server

To create a text paste:

1. Enter your text into the large upper text input box.
2. Content-Type: Optionally select a content type below the box to enable syntax highlighting (powered by Pygments). For example, typing pyt will suggest Python options.
3. File name: Optionally provide a filename. If provided, browsers will use this name when downloading the file.
4. Maximum lifetime: Set an expiration time after which the file will be automatically deleted.
5. Click Submit. Bepasty will redirect you to a unique URL for your paste.

To develop on bepasty-server, you should use a virtual environment and install the package in editable mode. This allows changes to the source code to take effect immediately without re-installing, and enables auto-reloading during development.

Follow these steps:

1. Create and activate a new virtual environment.
2. Clone the repository.
3. Install the package in editable mode using pip install -e ..
4. Run the server in debug mode.

# Create a new virtualenv
virtualenv bepasty-server-env

# Activate the virtualenv
source bepasty-server-env/bin/activate

# Clone the official bepasty-server
git clone https://github.com/bepasty/bepasty-server.git
cd bepasty-server

# Install in editable mode (enables auto-reload and uses current directory)
pip install -e .

# Run the Bepasty server in debug mode
bepasty-server --debug