diff --git a/Cargo.lock b/Cargo.lock index 220c77b..9479b4a 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1283,7 +1283,7 @@ dependencies = [ [[package]] name = "microbin" -version = "1.2.0" +version = "2.0.0" dependencies = [ "actix-files", "actix-multipart", diff --git a/Cargo.toml b/Cargo.toml index 54e79a8..b1db321 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,13 +1,13 @@ [package] name = "microbin" -version = "1.2.0" +version = "2.0.0" edition = "2021" -authors = ["Daniel Szabo "] +authors = ["Daniel Szabo ", "Jade "] license = "BSD-3-Clause" description = "Simple, performant, configurable, entirely self-contained Pastebin and URL shortener." readme = "README.md" -homepage = "https://github.com/szabodanika/microbin" -repository = "https://github.com/szabodanika/microbin" +homepage = "https://gitlab.com/obsidianical/microbin" +repository = "https://gitlab.com/obsidianical/microbin" keywords = ["pastebin", "pastabin", "microbin", "actix", "selfhosted"] categories = ["pastebins"] diff --git a/README.md b/README.md index 04903b3..dcaf6f9 100644 --- a/README.md +++ b/README.md @@ -1,58 +1,40 @@ # 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_) - [ ] 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_) + - [ ] multi-user - [ ] Customizable keys (_so you can make fixed pastas_) - - [ ] Customizable wordset and length for the names + - [x] Customizable wordset - [ ] Non-env/args configurations +- [ ] encrypted pastas +- [ ] image embeds +- [ ] further endpoint configuration + - [ ] disable remove -## Features +## Contact -- Is very small -- 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! +This fork of MicroBin was created by [Schrottkatze](https://schrottkatze.de). -## What is a "pasta" anyway? - -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 +Join [the matrix room](https://matrix.to/#/#s10e-microbin:matrix.org) to chat! diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 695fc0f..0000000 --- a/SECURITY.md +++ /dev/null @@ -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.