schrottkatze/karton
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases 2 Packages Wiki Activity
No description
181 commits 6 branches 11 tags 3.9 MiB
Rust 56.3%
HTML 26.9%
CSS 14.5%
Nix 1.4%
Dockerfile 0.9%
Find a file
Jade c83a775ac2 add direnv directory to gitignore
2023-03-09 20:05:23 +01:00
.github changes like 2023-02-17 11:28:09 +01:00
src removed unnecessary import 2023-03-05 16:08:26 +01:00
templates rebrand + added dockerfile agian 2023-03-05 15:21:12 +01:00
.envrc changes like 2023-02-17 11:28:09 +01:00
.gitignore add direnv directory to gitignore 2023-03-09 20:05:23 +01:00
Cargo.lock rebrand + added dockerfile agian 2023-03-05 15:21:12 +01:00
Cargo.toml removed keyword 2023-03-05 16:10:19 +01:00
default.nix changes like 2023-02-17 11:28:09 +01:00
Dockerfile docker! 2023-03-05 17:02:18 +01:00
flake.lock flake.lock: Update 2023-03-05 19:35:07 +01:00
flake.nix docker! 2023-03-05 17:02:18 +01:00
LICENSE Create LICENSE 2022-04-27 16:00:53 +01:00
README.md README: reorganize TODOs to roadmap 2023-03-06 12:12:47 +01:00
shell.nix changes like 2023-02-17 11:28:09 +01:00

README.md

Karton

A small, rusty pastebin with URL shortener functionality.

The github repository is a mirror of this gitlab repository.

This is a fork of MicroBin.

Features

  • Animal names (by default) or custom namefiles instead of just hashes (though hashes are an option too!)
  • File and image uploads
  • raw text serving
  • URL shortening
  • QR codes
  • Listing and removing pastas (though currently everyone can do that)
  • Expiration times
  • Editable pastas
  • Syntax highlighting
  • Styling via water.css
  • Customizable endpoints

Roadmap

This is only a rough time guide for what to get done by which version, nothing fixed.

v2.0

  • Removed light mode
  • Rebrand
    • New name and logo
    • New README
    • New theme
  • Distribution on crates.io
  • Distribution on Docker hub
  • Image embedding in pasta page
  • Custom names file
  • Click logo/name to get to root

v2.1

  • Installation guides
  • Copying embed urls more easily (some button for that)
  • Api for requesting customized url info
  • Config file support
  • Markdown pastas

v2.2

  • Proper docs
  • Improved rustdoc
  • Non-web client library
  • CLI client
  • Easier customization of instance names and logos
  • Easier basic themeing
    • Colors
    • Corner rounding

v2.3

  • Encrypted pastas

v3.0

  • Deprecate JSON db, replace with SQLite
  • Rework internal data structures
    • Map custom keys to ids
    • Make hash ids, names and custom keys usable at once
  • Users
    • Reporting pastas
    • Admin panel
  • Improve remove api
  • Status/health/info improvements
    • Storage thats left
    • Db status
    • Pastas on the instance
    • Users
    • Errors

future

  • Federation
    • Requesting pastas from other instances
    • When cli is complete, set default instance to route requests over
    • Fine grained permissions
  • Postgresql db support
  • Pasta comments?

not related to features, therefor not versioned

  • Official central instance
  • Donation setup?
  • Distribution on nixpkgs
  • Website

Contact

This fork of MicroBin was created by Schrottkatze.

Join the matrix room to chat!

Contact me via e-mail at contact@schrottkatze.de.