Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/aatxe/meep

A simple pasting service with syntax highlighting support.
https://github.com/aatxe/meep

command-line curl pastebin-service rocket-rs rust

Last synced: 21 days ago
JSON representation

A simple pasting service with syntax highlighting support.

Host: GitHub
URL: https://github.com/aatxe/meep
Owner: aatxe
License: agpl-3.0
Created: 2018-03-01T20:06:18.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2019-11-06T20:50:40.000Z (almost 5 years ago)
Last Synced: 2024-09-14T01:36:41.528Z (about 2 months ago)
Topics: command-line, curl, pastebin-service, rocket-rs, rust
Language: Rust
Homepage: https://commie.club/m/
Size: 174 KB
Stars: 6
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

# meep [![Build Status][ci-badge]][ci] [![Crates-io][cr-badge]][cr] [![Built with Spacemacs][bws]][sm]

[ci-badge]: https://travis-ci.org/aatxe/meep.svg
[ci]: https://travis-ci.org/aatxe/meep
[cr-badge]: https://img.shields.io/crates/v/meep.svg
[cr]: https://crates.io/crates/meep
[bws]: https://cdn.rawgit.com/syl20bnr/spacemacs/442d025779da2f62fc86c2082703697714db6514/assets/spacemacs-badge.svg
[sm]: http://spacemacs.org

A simple pasting service powered by [Rocket][rocket].

[rocket]: https://rocket.rs/

## Installation

Setting up a new instance is easy, but it requires using Rust nightly.

1. Install `meep` with `cargo` via `cargo +nightly install --force meep`.
- If you're not using `rustup` but still have nightly, use `cargo install --force meep` instead.
- The `--force` flag ensures that you'll update any current installations to the latest version.
2. Run `meep` in a directory where you want it to create `meep.toml` and `meep.db`.
- You can also create a `Rocket.toml` which can be useful, e.g. for setting production templates.
- You can set a specific path for the configuration with the `MEEP_CONFIG` environment variable.
3. Install a set of templates to use in `templates/` within your working directory.
- You can configure this path in `Rocket.toml` (including per-environment).
- You can use the default templates in the repository as a starting point.
4. Edit the configuration in `meep.toml` and then re-run `meep`.
- You should always run production instances with `ROCKET_ENV` set to `production`.
- You should also make sure to deploy `meep` behind a proxy through `nginx` or `apache`.

## Example Configurations

### meep.toml

```toml
maintainer = "Aaron Weiss"
maintainer-email = "[email protected]"
meep-root = "https://commie.club/m"
database-url = "meep.db"
default-theme = "InspiredGitHub"
extra-syntaxes-path = "syntaxes"
```

### Rocket.toml

```toml
[development]
port = 8080
template_dir = "templates/"

[production]
port = 8080
template_dir = "prod_templates/"
```

## Manpage

```
meep(1) MEEP meep(1)

dMMMMMMMMb dMMMMMP dMMMMMP dMMMMb
dMP"dMP"dMPdMP dMP dMP.dMP
dMP dMP dMPdMMMP dMMMP dMMMMP"
dMP dMP dMPdMP dMP dMP
dMP dMP dMPdMMMMMP dMMMMMP dMP

SYNOPSIS
| curl --data-binary "@-" $MEEP_ROOT

DESCRIPTION
Simply POST data to $MEEP_ROOT to paste

OPTIONS
add / to resulting url for syntax highlighting
add // for syntax highlighting with a specific theme

THEMES
default $DEFAULT_THEME
gh InspiredGitHub
light Solarized (light)
dark Solarized (dark)

EXAMPLES
(meep) cat src/main.rs | curl --data-binary "@-" $MEEP_ROOT
$MEEP_ROOT/iVse
(meep) firefox $MEEP_ROOT/iVse/rs

MAINTAINER
Instance maintained by $MAINTAINER <$MAINTAINER_EMAIL>