2023-03-05 14:23:11 +00:00
# Karton
2022-06-04 23:20:23 +00:00
2023-03-05 14:23:11 +00:00
A small, rusty pastebin with URL shortener functionality.
2022-04-23 15:57:45 +00:00
2023-03-05 14:37:48 +00:00
The github repository is a mirror of [this gitlab repository ](https://gitlab.com/obsidianical/microbin ).
2023-03-05 14:23:11 +00:00
This is a fork of [MicroBin ](https://github.com/szabodanika/microbin ).
2022-11-07 15:57:50 +00:00
2023-03-05 15:07:08 +00:00
## 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 ](https://github.com/kognise/water.css )
- Customizable endpoints
2023-03-09 19:44:38 +00:00
## Installation guide
Karton is available on [Docker hub ](https://hub.docker.com/r/schrottkatze/karton ), [crates.io ](https://crates.io/crates/karton ) and using the nix flake.
The only "officially supported" (I will actively debug and search for the problem) method is the last one using nix flakes.
### Installation via the nix flake
Add the repository to your inputs.
```nix
karton.url = "git+https://gitlab.com/obsidianical/microbin.git";
```
```nix
# microbin.nix
{ inputs, config, pkgs, ... }:
{
environment.systemPackages = [ inputs.karton.defaultPackage."x86_64-linux" ];
systemd.services.karton = {
after = [ "network.target" ];
wantedBy = [ "multi-user.target" ];
environment = {
# set environment variables to configure karton
KARTON_HASH_IDS = "";
KARTON_EDITABLE = "";
KARTON_PRIVATE = "";
KARTON_HIGHLIGHTSYNTAX = "";
# adjust this to your domain
KARTON_PUBLIC_PATH = "https://example.org";
KARTON_QR = "";
# configure endpoints to be shorter
KARTON_URL_EP = "u";
KARTON_RAW_EP = "r";
KARTON_PASTA_EP = "p";
};
script = "${inputs.karton.defaultPackage."x86_64-linux"}/bin/karton";
# register a simple systemd service
serviceConfig = {
Type = "simple";
RootDirectory="/";
WorkingDirectory = "/karton";
};
};
}
```
2023-02-17 23:02:28 +00:00
## Contact
2022-06-03 16:24:34 +00:00
2023-02-17 23:02:28 +00:00
This fork of MicroBin was created by [Schrottkatze ](https://schrottkatze.de ).
2022-10-01 06:12:24 +00:00
2023-02-17 23:02:28 +00:00
Join [the matrix room ](https://matrix.to/#/#s10e-microbin:matrix.org ) to chat!
2023-03-05 15:07:08 +00:00
Contact me via e-mail at [contact@schrottkatze.de ](mailto:contact@schrottkatze.de ).