JLCarveth / nutty

A very simple HTTP server, and a paste server implementation.

Home Page:https://paste.jlcarveth.dev

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Nutty

A simple HTTP paste server - Contributions Welcome!

Nutty is a self-hostable paste server, allowing you to easily upload and share text files instantly.

Features

  • A simple HTTP interface
  • A simple Web interface (WIP)
  • Public and private pastes
  • Low memory footprint
  • Burn-on-read - Pastes that can only be read once
  • Automatic Syntax Highlighting

Installation

  1. Make sure you have Deno installed on your system. If not, you can install it by following the instructions on the Deno website.
  2. Clone the repository by running git clone https://github.com/JLCarveth/nutty.git.
  3. Change into the cloned directory by running cd nutty.
  4. Run the paste.ts file with Deno by running deno run -A --unstable paste.ts.

A simple systemd service can also be setup to handle stopping/starting Nutty:

[Unit]
Description=File pasting API

[Service]
ExecStart=/home/jlcarveth/.deno/bin/deno run -A --unstable paste.ts
Restart=always
User=jlcarveth
Group=jlcarveth
WorkingDirectory=/opt/paste
EnvironmentFile=/opt/paste/.env
StandardOutput=journal
StandardError=journal

[Install]
WantedBy=multi-user.target

Environment

Nutty depends on a couple of environment variables to be established before running.

Variable Name Description Example Values
TARGET_DIR The directory where pastes will be stored. /opt/paste/data
BASE_URL The base URL at which the API can be accessed. https://paste.mysite.com/api
SECRET_KEY Used for signing JWTs. A secret key can be generated with openssl rand -base64 32 GDZ1FzBF18dtAk2enanqqxskVf5hptmPjy/pcBm384M=
PORT The port to listen to. Default is 5335 5335
PUBLIC_PASTES Whether to allow users to create pastes without an access token. 1,0,true,false
DEBUG Logs incoming requests for debugging purposes. 1,0,true,false
DOMAIN The domain used for the HTTP cookie, as well as the burn URLs. paste.jlcarveth.dev

Usage

There is a simple client bash script which provides a simple example of using Nutty.

export TOKEN=$(curl https://paste.jlcarveth.dev/api/login -X POST -H "Content-Type: application/json" -d '{"email":"jlcarveth@gmail.com","password":"notmypassword"}')
export EMAIL="jlcarveth@gmail.com" # Email is used for signing PGP messages
uuid=$(cat file.txt | bash client.sh)

If the client runs successfully, a UUID associated with the new paste is returned. This paste can then be retrieved with a simple GET request:

curl $API_URL/$UUID -H "X-Access-Token: $TOKEN"

About

A very simple HTTP server, and a paste server implementation.

https://paste.jlcarveth.dev

License:MIT License


Languages

Language:TypeScript 73.4%Language:CSS 18.2%Language:JavaScript 7.0%Language:Shell 1.4%