From b6f10ec66960825c517c22540d0568a2fca3a44d Mon Sep 17 00:00:00 2001 From: rasul Date: Sun, 2 Feb 2020 19:45:09 -0600 Subject: [PATCH] readme for the github pages site --- readme.html | 104 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 104 insertions(+) create mode 100644 readme.html diff --git a/readme.html b/readme.html new file mode 100644 index 0000000..d36bec7 --- /dev/null +++ b/readme.html @@ -0,0 +1,104 @@ + + + + + + + + + + + pastebucket + + +
+

pastebucket

+ +

+ + Pipeline Status + + + Coverage + + + MIT License + + +

+ A pastebin like web application. Useful for pasting text into a form to store. + Syntax highlighting is selected via a dropdown menu and is applied server side. + No javascript to load, just some CSS. + +

+ Curl may be used to submit text, but there is no option at this time to specify + the language (for syntax highlighting) via curl: + +

cargo check | curl -T- https://p.rascul.xyz
+curl -T- https://p.rascul.xyz < src/main.rs
+
+ +

+ The git repo is located at https://gitlab.com/rascul/pasteb. + There is an instance running at https://p.rascul.xyz. + +

+ pastebucket is written in rust and uses the + gotham web application framework. + +

Building

+ +

+ First, clone the repo: + +

git clone https://gitlab.com/rascul/pasteb
+
+ +

+ Enter the directory and create your configuration: + +

cd pasteb
+cp config.toml.default config.toml
+$EDITOR config.toml
+
+ +

+ Build pastebucket + +

cargo build --release
+
+ +

Running

+ +

+ Run pastebucket + +

cargo run --release
+
+ +

+ It is best to run a web server such as Apache or + nginx and reverse proxy connections to pastebucket. + +

+ You may run the executable directly (without cargo), it is located at + target/release/pastebucket. + +

+ pastebucket should be run from the directory containing config.toml. At this + time there is no option specify where to load the config from via the command + line. + +

+ A sample systemd service file is included in the git repo. +

+ +