Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lukewhrit/spacebin
🔠spacebin: text sharing for the final frontier
https://github.com/lukewhrit/spacebin
go go-chi hastebin pastebin postgresql selfhosted spacebin
Last synced: 3 months ago
JSON representation
🔠spacebin: text sharing for the final frontier
- Host: GitHub
- URL: https://github.com/lukewhrit/spacebin
- Owner: lukewhrit
- License: apache-2.0
- Created: 2020-04-19T06:46:57.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-11-11T01:24:25.000Z (3 months ago)
- Last Synced: 2024-11-11T02:26:50.684Z (3 months ago)
- Topics: go, go-chi, hastebin, pastebin, postgresql, selfhosted, spacebin
- Language: Go
- Homepage: https://spaceb.in
- Size: 55.2 MB
- Stars: 92
- Watchers: 4
- Forks: 9
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# 🚀 Spacebin
[](https://codecov.io/gh/lukewhrit/spacebin) [](LICENSE) [](https://github.com/orca-group/spirit/actions/workflows/build.yml)
[](https://goreportcard.com/report/github.com/orca-group/spirit)
Spacebin is a modern Pastebin server implemented in Go and maintained by Luke Whritenour. It is capable of serving notes, novels, code, or any other form of text! Spacebin was designed to be fast and reliable, avoiding the problems of many current pastebin servers. Spacebin features JavaScript-based text highlighting, but works completely fine with JS disabled. Besides text highlighting, we have many more features in the works. It is entirely self-hostable, and available in a Docker image.
Pastebins 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](https://en.wikipedia.org/wiki/Pastebin).
## Table of Contents
- [🚀 Spacebin](#-spacebin)
- [Table of Contents](#table-of-contents)
- [Documentation](#documentation)
- [Self-hosting](#self-hosting)
- [Usage](#usage)
- [On the Web](#on-the-web)
- [CLI](#cli)
- [API](#api)
- [Credits](#credits)
- [Vulnerabilities](#vulnerabilities)
- [License](#license)
## Documentation
### Self-hosting
**Using Docker**
```sh
# 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. You can access the web app at [spaceb.in](https://spaceb.in). You must use `https://spaceb.in/api` to access the API routes.
#### 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:**
```sh
curl -v -F content="Hello, world!" https://spaceb.in/ | jq payload.id
```
**To upload from a file:**
```sh
curl -v -F [email protected] https://spaceb.in/ | jq payload.id
```
### API
There are three primary API routes to: create a document, fetch a documents text content in JSON format, and fetch a documents **plain text** content.
* `/api/`: Create Document
* Accepts JSON and multipart/form-data
* For both formats, include document content in a `content` field
* Only accepts POST requests
* Instances are able to specify a maximum document length.
* `spaceb.in` uses a 4MB maximum size.
* Successful requests return a JSON body with the following format:
```json
{
"error": "",
"payload": {
"id": "WfwKGJfs",
"content": "hello",
"created_at": "2023-08-06T00:01:33.143532-04:00",
"updated_at": "2023-08-06T00:01:33.143532-04:00"
}
}
```
* `/api/{document}`: Fetch Document
* `{document}` = Document ID
* Document ID lengths vary between instances. For `spaceb.in`, they will be exactly characters.
*
* Upon successful request, returns a JSON body with the following format:
```json
{
"error": "",
"payload": {
"id": "WfwKGJfs",
"content": "hello",
"created_at": "2023-08-06T00:01:33.143532-04:00",
"updated_at": "2023-08-06T00:01:33.143532-04:00"
}
}
```
* `/api/{document}/raw`: Fetch Document - Raw
* `{document}` = Document ID
* Document ID lengths vary between instances. For `spaceb.in`, they will be exactly 8 characters
* Returns a `plain/text` file containing the content of the document.
There are two additional non-API routes that are documented: `/ping`: returns a 200 OK if the service is online, and `/config`: returns a JSON body with the instances configuration settings.
## Credits
Spacebin (and all other associated programs) is a project designed and maintained by Luke Whritenour. Spirit was forked from [hastebin](https://github.com/toptal/haste-server) 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](https://github.com/go-chi/chi), and [pq](https://github.com/lib/pq), [Ozzo Validation](https://github.com/go-ozzo/ozzo-validation), [Cron](https://github.com/robfig/cron), [env](https://github.com/caarlos0/env), and (of course) [Go](https://go.dev/) itself!
You can see a full list of code contributors to Spirit [here, on Github](https://github.com/orca-group/spirit/graphs/contributors).
Additionally, we'd like to thank [@jackdorland](https://github.com/jackdorland) for designing our logo/brand.
## Vulnerabilities
The Spacebin team takes security very seriously. If you detect a vulnerability please contact us: . 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`](LICENSE) file.