Skip to content
master
Switch branches/tags
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
e2e
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

logpaste

CircleCI Docker Pulls License

A minimalist web service for uploading and sharing log files.

LogPaste animated demo

Features

  • Accept text uploads from command-line, JavaScript, and web UI
  • Simple to deploy
    • Runs in a single Docker container
    • Fits in the free tier of Heroku
  • Easy database management
    • Syncs persistent data to any S3-compatible cloud storage provider
  • Customizable UI without changing source code

Demo

Run LogPaste

From source

PORT=3001 go run main.go

From Docker

To run LogPaste within a Docker container, mount a volume from your local system to store the LogPaste sqlite database.

docker run \
  -e "PORT=3001" \
  -p 3001:3001/tcp \
  --volume "${PWD}/data:/app/data" \
  --name logpaste \
  mtlynch/logpaste

From Docker + cloud data replication

If you specify settings for an S3 bucket, LogPaste will use Litestream to automatically replicate your data to S3.

You can kill the container and start it later, and it will restore your data from the S3 bucket and continue as if there was no interruption.

LITESTREAM_ACCESS_KEY_ID=YOUR-ACCESS-ID
LITESTREAM_SECRET_ACCESS_KEY=YOUR-SECRET-ACCESS-KEY
LITESTREAM_REGION=YOUR-REGION
DB_REPLICA_URL=s3://your-bucket-name/db

docker run \
  -e "PORT=3001" \
  -e "LITESTREAM_ACCESS_KEY_ID=${LITESTREAM_ACCESS_KEY_ID}" \
  -e "LITESTREAM_SECRET_ACCESS_KEY=${LITESTREAM_SECRET_ACCESS_KEY}" \
  -e "LITESTREAM_REGION=${LITESTREAM_REGION}" \
  -e "DB_REPLICA_URL=${DB_REPLICA_URL}" \
  -p 3001:3001/tcp \
  --name logpaste \
  mtlynch/logpaste

Some notes:

  • Only run one Docker container for each S3 location
    • LogPaste can't sync writes across multiple instances.

With custom site settings

LogPaste offers some options to customize the text for your site. Here's an example that uses a custom title, subtitle, and footer:

SITE_TITLE="My Cool Log Pasting Service"
SITE_SUBTITLE="Upload all your logs for FooBar here"
SITE_FOOTER="<h2>Notice</h2><p>Only cool users can share logs here.</p>"
SITE_SHOW_DOCUMENTATION="false" # Hide usage information from homepage
PER_MINUTE_LIMIT="5" # Allow only 5 pastes per minute per IP

docker run \
  -e "PORT=3001" \
  -e "SITE_TITLE=${SITE_TITLE}" \
  -e "SITE_SUBTITLE=${SITE_SUBTITLE}" \
  -e "SITE_FOOTER=${SITE_FOOTER}" \
  -e "SITE_SHOW_DOCUMENTATION=${SITE_SHOW_DOCUMENTATION}" \
  -e "PER_MINUTE_LIMIT=${PER_MINUTE_LIMIT}" \
  -p 3001:3001/tcp \
  --name logpaste \
  mtlynch/logpaste

Parameters

Command-line flags

Flag Meaning Default Value
-title Title to display on homepage "LogPaste"
-subtitle Subtitle to display on homepage "A minimalist, open-source debug log upload service"
-footer Footer to display on homepage (may include HTML)
-showdocs Whether to display usage documentation on homepage true
-perminutelimit Number of pastes to allow per IP per minute 0 (no limit)

Docker environment variables

You can adjust behavior of the Docker container by passing these parameters with docker run -e:

Environment Variable Meaning
PORT TCP port on which to listen for HTTP connections (defaults to 3001)
SITE_TITLE Value to set the -title command-line flag
SITE_SUBTITLE Value to set the -subtitle command-line flag
SITE_FOOTER Value to set the -footer command-line flag
SITE_SHOW_DOCUMENTATION Value to set the -showdocs command-line flag
PER_MINUTE_LIMIT Value to set the -perminutelimit command-line flag
DB_REPLICA_URL S3 URL where you want to replicate the LogPaste datastore (e.g., s3://mybucket.mydomain.com/db)
LITESTREAM_REGION AWS region where your S3 bucket is located
LITESTREAM_ACCESS_KEY_ID AWS access key ID for an IAM role with access to the bucket where you want to replicate data.
LITESTREAM_SECRET_ACCESS_KEY AWS secret access key for an IAM role with access to the bucket where you want to replicate data.

Docker build args

If you rebuild the Docker image from source, you can adjust the build behavior with docker build --build-arg:

Build Arg Meaning Default Value
litestream_version Version of Litestream to use for data replication 0.3.6

Deployment

LogPaste is easy to deploy to cloud services. Here are some places it works well:

Further reading