schrottkatze/karton
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases 2 Packages Wiki Activity

updated readme and cargo stuff

Browse source
This commit is contained in:
Schrottkatze 2023-02-18 00:02:28 +01:00
parent 7abb3c5d11
commit 7bfebb27d9
4 changed files with 31 additions and 61 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
Cargo.lock generated
View file

@ -1283,7 +1283,7 @@ dependencies = [
[[package]] [[package]]
name = "microbin" name = "microbin"
version = "1.2.0" version = "2.0.0"
dependencies = [ dependencies = [
"actix-files", "actix-files",
"actix-multipart", "actix-multipart",

8
Cargo.toml
View file

@ -1,13 +1,13 @@
[package] [package]
name = "microbin" name = "microbin"
version = "1.2.0" version = "2.0.0"
edition = "2021" edition = "2021"
authors = ["Daniel Szabo <daniel.szabo99@outlook.com>"] authors = ["Daniel Szabo <daniel.szabo99@outlook.com>", "Jade <jade@schrottkatze.de>"]
license = "BSD-3-Clause" license = "BSD-3-Clause"
description = "Simple, performant, configurable, entirely self-contained Pastebin and URL shortener." description = "Simple, performant, configurable, entirely self-contained Pastebin and URL shortener."
readme = "README.md" readme = "README.md"
homepage = "https://github.com/szabodanika/microbin" homepage = "https://gitlab.com/obsidianical/microbin"
repository = "https://github.com/szabodanika/microbin" repository = "https://gitlab.com/obsidianical/microbin"
keywords = ["pastebin", "pastabin", "microbin", "actix", "selfhosted"] keywords = ["pastebin", "pastabin", "microbin", "actix", "selfhosted"]
categories = ["pastebins"] categories = ["pastebins"]

70
README.md
View file

@ -1,58 +1,40 @@
# MicroBin # MicroBin
MicroBin is a super tiny, feature rich, configurable, self-contained and self-hosted paste bin web application. It is very easy to set up and use, and will only require a few megabytes of memory and disk storage. It takes only a couple minutes to set it up, why not give it a try now? This is a fork of [MicroBin](https://github.com/szabodanika/microbin) intends to fix some bugs and add some features to MicroBin.
## Note about this fork I deliberately removed docker support for now.
I've forked MicroBin due to apparent neglect from the maintainer, and to fix various issues and annoyances to me personally. Please do not ask for help in the issues of the original MicroBin repository, I'd be happy to help you with any problems here though.
### TODOs: ## TODOs:
- [ ] Rebrand
- [ ] New name and logo
- [ ] New README
- [ ] Website
- [ ] Official central instance
- [ ] Donation thing?
- [ ] Distribution
- [ ] nixpkgs
- [ ] crates.io
- [ ] Docker
- [ ] Various other distribution specific repositories?
- [ ] Proper database (_seriously, json isn't a database_) - [ ] Proper database (_seriously, json isn't a database_)
- [ ] Configurable endpoints (_so a url shortener isn't lengthened by /url/_) - [ ] Configurable endpoints (_so a url shortener isn't lengthened by /url/_)
- [ ] Proper auth and permissions (_so a single user can also use it and send links_) - [ ] Proper auth and permissions (_so a single user can also use it and send links_)
- [ ] multi-user
- [ ] Customizable keys (_so you can make fixed pastas_) - [ ] Customizable keys (_so you can make fixed pastas_)
- [ ] Customizable wordset and length for the names - [x] Customizable wordset
- [ ] Non-env/args configurations - [ ] Non-env/args configurations
- [ ] encrypted pastas
- [ ] image embeds
- [ ] further endpoint configuration
- [ ] disable remove
## Features ## Contact
- Is very small This fork of MicroBin was created by [Schrottkatze](https://schrottkatze.de).
- Entirely self-contained executable, MicroBin is a single file!
- Animal names instead of random numbers for pasta identifiers (64 animals)
- File uploads (eg. `server.com/file/pig-dog-cat`)
- Raw text serving (eg. `server.com/raw/pig-dog-cat`)
- URL shortening and redirection
- QR code support
- Very simple database (JSON + files) for portability, easy backups and integration
- Listing and manually removing pastas (`/pastalist`)
- Private and public, editable and final, automatically and never expiring pastas
- Syntax highlighting
- Automatic dark mode and custom styling support with very little CSS and only vanilla JS (see [`water.css`](https://github.com/kognise/water.css))
- Most of the above can be toggled on and off!
## What is a "pasta" anyway? Join [the matrix room](https://matrix.to/#/#s10e-microbin:matrix.org) to chat!
In MicroBin, a pasta can be:
- A text that you want to paste from one machine to another, eg. some code,
- A file that you want to share, eg. a video that is too large for Discord, a zip with a code project in it or an image,
- A URL redirect.
## When is MicroBin useful?
You can use MicroBin:
- As a URL shortener/redirect service,
- To send long texts to other people,
- To send large files to other people,
- To serve content on the web, eg. configuration files for testing, images, or any other file content using the Raw functionality,
- To move files between your desktop and a server you access from the console,
- As a "postbox" service where people can upload their files or texts, but they cannot see or remove what others sent you - just disable the pastalist page
- To take notes! Simply create an editable pasta.
...and many other things, why not get creative?
MicroBin and MicroBin.eu are available under the [BSD 3-Clause License](LICENSE).
© Dániel Szabó 2022

12
SECURITY.md
View file

@ -1,12 +0,0 @@
# Security Policy
## Version Support
Currently we only have capacity to support the latest version of MicroBin. We recommend that you always update to the newest one and check our pages regularly for announcements.
## Reporting a Vulnerability
Security vulnerabilities can be reported directly to the developer/maintainer at d@szab.eu.
Sensitive information may be GPG encrypted with my public key available at
https://szab.eu/assets/files/daniel-szabo-pub.asc.