Awesome
markdownshare
Markdownshare is the code which is behind markdownshare.com, which is essentially a pastebin site which happens to transform markdown into a HTML.
The code on the master branch in this repository should always be stable and usable for all those who wish to self-host. The actual code which is deployed can be found in the develop branch; there are minor differences largely as I go through the process of retiring and closing down the publicly-hosted instance of the service.
Installation
If you wish to install from source simply clone this repository, somewhere outside your GOPATH (if you even have one setup!) and run the standard commands:
go build .
go install .
If you prefer you can fetch a binary from our release page.
Usage
Once installed like this you'll should find a markdownshare application. The application has several modes, implemented via sub-commands, run with no-arguments to see a list.
To launch the server for real you'll want to run:
$ markdownshare serve [-host 127.0.0.1] [-port 3737] [-redis localhost:6379]
(Redis is only used to perform simple rate-limiting of incoming HTTP-accesses, it is entirely optional.)
Storage
Initially all user-uploaded content was stored in a local Redis database, but over time I've started to prefer to use redis only for transient/session-data - so the contents were moved to a local SQLite database.
Due to issues with embedding SQLite in golang I've now moved to storing data upon the filesystem, beneath a common prefix, which is slightly less efficient but still good enough for the volume of users I see.
Rate-Limiting
The server has support for rate-limiting, you can enable this by passing the address of a redis server to the binary:
$ markdownshare serve -redis=127.0.0.1:6379
If this flag is not present then rate-limiting will be disabled. If a client
makes too many requests they will be returned a HTTP 429 status-code. Each request made will return a series of headers
prefixed with X-RateLimit to allow clients to see how many requests they
Notes
The generated HTML views are stored inside the compiled binary to ease deployment, along with a couple of the bundled markdown files. If you wish to tweak the look & feel by editing them then you're more then welcome.
The raw HTML-templates are located beneath data/, and you can edit them
then rebuild the compiled versions via the implant tool.
If you don't already have implant installed please install, following the
instructions here:
Using implant you can regenerate the compiled version(s) of the templates
and rebuild the binary to make your changes:
implant -input data/ -output static.go
go build .
(A simple make should do the correct thing upon a GNU/Linux host.)
Github Setup
This repository is configured to run tests upon every commit, and when pull-requests are created/updated. The testing is carried out via .github/run-tests.sh which is used by the github-action-tester action.
Releases are automated in a similar fashion via .github/build, and the github-action-publish-binaries action.