termpad

KO | EN

gitlite — search

#javascript #react #golang #android #machine-learning #rust #macos #awesome #kubernetes #vue #security #pytorch #mcp #openai

(★ 42)

A (self hosted) pastebin for easily sharing text right from the terminal

termpad Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# termpad

termpad allows you to easily host a pastebin server for saving and viewing text right from the terminal, or the browser.

## Client Usage
Assuming termpad is running in localhost:8000 you can do this to save text using cURL:  
```shell
$ curl -d "Hello world" localhost:8000
http://localhost/DullMagnificentLock
$ # Or
$ curl --data-binary @path/to/file localhost:8000
http://localhost/BrightAliveMotorcycle
```

And this to retrieve saved text:
```shell
$ curl localhost:8000/raw/TenderCheerfulYacht
$ # You might optionally want to pipe the output to a pager like less
$ curl localhost:8000/raw/TenderCheerfulYacht | less
```

Or this for [HTTPie](https://httpie.io/):
```shell
$ echo "Hello World" | http POST localhost:8000
http://localhost/DullMagnificentLock
$ # Or for files:
$ http POST localhost:8000 < path/to/file
http://localhost/BrightAliveMotorcycle
```
And to get text it's the same as cURL:
```shell
$ http localhost:8000/raw/TenderCheerfulYacht
# Or with a pager
$ http localhost:8000/raw/TenderCheerfulYacht | less
```

Note the `/raw/` in the url, without it you will get html output

## Server Usage
### Note that environment variables are checked before assigning the default value.
### Domain (env = `DOMAIN`)
Used to construct the url returned to the user. `http/s` is added as a prefix (Default: `localhost`)
For example `DOMAIN=example.com` will return urls like: `http://example.com/BrightAliveMotorcycle`

### Port (env = `PORT`)
Set the port on which the app runs (Default: `8000`)

### Output (env = `OUTPUT`)
Relative or absolute path to the directory where you want to store user-posted pastes (Default: `~/.local/share/termpad/`)

### https (env = `HTTPS`)
If set, urls will start with `https` instead of `http`

### Delete files (env = `DELETE_AFTER`)
How many days to keep files for. If set to `0` it will keep them forever (Default: `120`)

## Install
### From source:
```shell
$ git clone https://github.com/SpyrosRoum/termpad.git
$ cd termpad
$ cargo build --release
$ ./target/release/termpad
```

### From cargo:
```shell
$ cargo install termpad
```

### With docker-compose:
```
services:
  app:
    image: spyrosr/termpad
    ports:
      - 8000:8000
    environment:
      - DOMAIN_NAME=example.com
      - HTTPS=true
      - OUTPUT=/termpad/share
      - DELETE_AFTER=0 # If you are hosting for yourself keeping them forever is probably fine
    volumes:
      - data:/termpad/share
    restart: always

volumes:
  data:
    name: termpad
```
and then `docker-compose up -d`

termpad

termpad Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

termpad

termpad Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README