Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

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

README.md

Pad

Build Status Go Report Card Docker Automated build MIT License

Pad is a standalone version of cloud notepad. Allows to share any text data by unique links. Written in Go and Bolt as embedded key/value database.

Running container

> docker run -d --rm --name pad_app \
    -p "8080:8080" \
    -e PAD_SECRET=random_salt_here \
    -e PAD_PORT=8080 \
    dotzero/pad

Running container with docker-compose

Create a docker-compose.yml file:

version: "3"
services:
  pad:
    image: dotzero/pad
    container_name: pad_app
    restart: always
    ports:
      - "8080:8080"
    environment:
      PAD_DB_PATH: /app/db
      PAD_SECRET: random_salt_here
      PAD_PORT: 8080
    volumes:
      - ./db:/app/db

Run docker-compose up -d, wait for it to initialize completely, and visit http://localhost:8080

Build container

> docker build -t dotzero/pad .

Usage

Usage:
  pad [OPTIONS]

Application Options:
      --db=      path to database (default: ./db) [$PAD_DB_PATH]
      --secret=  secret key [$PAD_SECRET]
      --host=    host (default: 0.0.0.0) [$PAD_HOST]
      --port=    port (default: 8080) [$PAD_PORT]
      --path=    path to web assets (default: ./web) [$PAD_PATH]
  -v, --verbose  enable verbose logging
      --version  show the version number and information

Help Options:
  -h, --help     Show this help message

Environment variables

PAD_DB_PATH

  • default: ./db

Path to BoltDB database. It represents a consistent snapshot of your data.

PAD_SECRET

  • default: empty

Salt that using to generate hashids. Strongly recommend to replace with your own value.

PAD_HOST

  • default: 0.0.0.0

PAD_PORT

  • default: 8080

This port must match the port that is exposed via Docker.

PAD_PATH

  • default: ./web

Path to web assets, templates and static directories.

License

http://www.opensource.org/licenses/mit-license.php

About

Pad is a standalone version of cloud notepad. Allows to share any text data by unique links

Topics

Resources

License

Releases

No releases published

Packages

No packages published
You can’t perform that action at this time.