🚀 Spirit

Spirit is the primary implementation of the Spacebin Server, written in Go and maintained by the Orca Group. Spacebin itself is a standardized pastebin server, that's capable of serving notes, novels, code or any other form of text!

Pastebin's are a type of online content storage service where users can store plain text document, e.g. program source code. For more information and the history of Pastebin see Wikipedia's article on them.

Table of Contents

• 🚀 Spirit
  • Table of Contents
  • Documentation
    • Self-hosting
    • Usage
      • On the Web
      • CLI
    • API
  • Credits
  • Vulnerabilities
  • License

Documentation

Self-hosting

Using Docker

# Pull and run docker image on port 80
$ sudo docker pull spacebinorg/spirit
$ sudo docker run -d -p 80:9000 spacebinorg/spirit

Manually

WIP

Usage

On the Web

To use Spacebin on the web, our team provides a web app written in Svelte: Pulsar. A public instance of Spacebin using this client is available at https://spaceb.in (the /api route can be used to access Spirit itself).

CLI

Since Spirit supports multipart/form-data uploads, it's extremely easy to use on the command line via curl. The scripts also use jq so that you can get a machine-readable version of the document's ID, instead of a lengthy JSON object.

To upload a string of text:

curl -v -F content="Hello, world!" https://spaceb.in/api | jq payload.id

To upload from a file:

curl -v -F content=@helloworld.txt https://spaceb.in/api | jq payload.id

API

Work in progress. Check out the documentation website: docs.spaceb.in.

Credits

Spacebin (and Spirit) is a project by Luke Whritenour, associated with the Orca Group—a developer collective. Spirit was forked from hastebin by John Crepezzi (now managed by Toptal), and although it no longer contains any code from the original we'd like to thank him regardless. Spirit itself is built using Chi, sqlx and pq, Ozzo Validation, Cron, env, and (of course) Go itself!

You can see a full list of code contributors to Spirit here, on Github.

Additionally, we'd like to thank @uwukairi for designing our logo/brand.

Vulnerabilities

The Spacebin team takes security very seriously. If you detect a vulnerability please contact us: hello@spaceb.in. We request that you hold of on publishing any vulnerabilities until after they've been patched, or at least 60 days have passed since you reported it.

License

Spirit is licensed under the Apache 2.0 license. A copy of this license can be found within the LICENSE file.