An open API service indexing awesome lists of open source software.

https://github.com/foxyiscoding/tinybin

A pastebin alternative with a much more cleaner interface and other functions
https://github.com/foxyiscoding/tinybin

docker foss js mysql pastebin self-host self-hosted svelte ts

Last synced: 8 months ago
JSON representation

A pastebin alternative with a much more cleaner interface and other functions

Awesome Lists containing this project

README

          

# TinyBin

TinyBin is a modern, minimal, and ad-free pastebin for your notes and code.
Built with Node.js, Express, and MySQL.
Easily self-host with Docker!

---

## ✨ Features

- 📝 Create and share notes with unique URLs
- ⏳ Notes auto-expire after 24 hours or more
- ⚡ Fast and simple UI
- 🐳 Easy Docker Compose setup

---

## 🚀 Quick Start (Docker Compose)

### 1. Download `docker-compose.yml`

```sh
curl -O -L https://github.com/FoxyIsCoding/TinyBin/raw/refs/heads/main/docker-compose.yml
```

### 2. Start Everything with Docker Compose

```sh
docker-compose up
```

- This will:
- Spin up a MySQL 8 database (with user/password: `pastefox`)
- Build and run the PasteFox app (Node.js)
- Automatically run DB migrations on startup

### 3. Visit PasteFox

Open [http://localhost:3000](http://localhost:3000) in your browser.

---

## 🐳 Docker Compose Details

- **MySQL** runs privately on port `3306`, with data persisted in a Docker volume.
- **PasteFox App** runs publically on port `3000`.
- Environment variables are set automatically for DB connection.

**You can customize DB credentials in `docker-compose.yml` if needed.**

---

## 🧩 Environment Variables

PasteFox uses these env vars (set automatically in Docker):

- `DB_HOST`, `DB_PORT`, `DB_USER`, `DB_PASSWORD`, `DB_NAME`
- `WEB_PORT` (default: 3000)

---

## 🗃️ Database Migration

On every start, PasteFox will auto-create the `notes` table and indexes if they don't exist.
No manual SQL needed!

---

## ❤️ Support

If you like this project, consider [supporting me on Ko-fi](https://ko-fi.com/foxyk)!
Your support keeps PasteFox ad-free and open source.

---

## 📄 License

Apache License, Version 2.0

---

## 🔑 Credits

Huge thank you to [Loudbook](https://github.com/Loudbooks) for design inspiration and Docker help.
Huge thank you to [Error](https://github.com/Err0r430) for writing out a better backend structure and consulting on how to migrate to a more sophisticated stack. Couldnt have done it without him.

---