pasty

Pasty is a fast and lightweight code pasting server

!!! Important deprecation notices !!!

This version of pasty uses a new field name for the so far called deletionToken: modificationToken. Instances using PostgreSQL are not affected as a corresponding SQL migration will run before the first startup. If you however use another storage driver you may have to update the entries by hand or using a simple query, depending on your driver as I don't plan to ship migrations for every single storage driver. It may be important to know that the data migrator has been upgraded too. This may serve as a convenient workaround (export data (field will be renamed) and import data with changed field names again).

The old deletionToken field will be processed corresponding to these changes but I strongly recommend updating old pastes if possible.

Additionally, I changed the three DELETION_TOKEN*environment variables to their corresponding MODIFICATION_TOKEN* ones:

• DELETION_TOKENS -> MODIFICATION_TOKENS
• DELETION_TOKEN_MASTER -> MODIFICATION_TOKEN_MASTER
• DELETION_TOKEN_LENGTH -> MODIFICATION_TOKEN_LENGTH

Again, the old ones will still work because I do not want to jumble your configurations. However, please consider updating them to stay future-proof ^^.

Support

As pasty is an open source project on GitHub you can open an issue whenever you encounter a problem or feature request. However, it may be annoying to open an issue just to ask a simple question about pastys functionalities, get help with the installation process or mention something about the hosted version. This is why I created a simple Discord server you may want to join to get an answer to stuff like that pretty quickly.

Disclaimer

The pasty web frontend comes with some service-related links in it (Discord server). Of course, you are allowed to remove these references. However, a small reference to pasty would be nice ^^.

Installation

You may set up pasty in multiple different ways. However, I won't cover all of them as I want to keep this documentation as clean as possible.

1.) Building from source

To build pasty from source make sure you have Go installed.

1. Clone the repository:

git clone https://github.com/lus/pasty

2. Switch directory:

cd pasty/

3. Run go build:

go build -o pasty ./cmd/pasty/main.go

To configure pasty, simply create a .env file in the same directory as the binary is placed in.

To run pasty, simply execute the binary.

2.) Docker (recommended)

To run pasty with Docker, you should have basic understanding of it.

An example docker run command may look like this:

docker run -d \
    -p 8080:8080 \
    --name pasty \
    -e PASTY_AUTODELETE="true" \
    ghcr.io/lus/pasty:latest

Pasty will be available at http://localhost:8080.

General environment variables

AutoDelete

Pasty provides an intuitive system to automatically delete pastes after a specific amount of time. You can configure it with the following variables:

Reports

Pasty aims at being lightweight by default. This is why no fully-featured admin interface with an overview over all pastes and reports is included. However, pasty does include a way of abstract reports to allow frontends work with this information. If enabled, pasty makes a standardized request to the configured webhook URL if a paste is reported.

Storage types

Pasty supports multiple storage types, defined using the PASTY_STORAGE_TYPE environment variable (use the value behind the corresponding title in this README). Every single one of them has its own configuration variables:

File (file)

PostgreSQL (postgres)

MongoDB (mongodb)

S3 (s3)