breve: a url shortener

[ gpl, program, web ] [ Propose Tags ]

Breve is a web application that provides a simple interface to shortening long urls creating links smaller and easier to remember.


[Skip to Readme]
Versions [faq] 0.0.1.0, 0.0.2.0, 0.0.2.1, 0.0.2.2, 0.0.3.0, 0.0.4.0, 0.1.0.0, 0.1.1.0, 0.2.0.0, 0.3.0.0, 0.4.0.0, 0.4.1.0, 0.4.2.0, 0.4.3.0, 0.4.3.1, 0.4.4.0, 0.4.5.0, 0.4.5.1, 0.5.0.0
Dependencies aeson, base (>=4.8 && <5.0), binary, blaze-html, bytestring, configurator, cryptohash, directory, hashtables, http-api-data, mtl, random, servant, servant-blaze, servant-server, streaming-commons, text, tls, wai, wai-extra, warp, warp-tls [details]
License GPL-3.0-only
Copyright (C) Michele Guerini Rocco 2019
Author rnhmjoj
Maintainer rnhmjoj@inventati.org
Category Web
Home page https://maxwell.ydns.eu/git/rnhmjoj/breve
Source repo head: git clone https://maxwell.ydns.eu/git/rnhmjoj/breve
Uploaded by rnhmjoj at Thu Nov 7 11:01:35 UTC 2019
Distributions NixOS:0.5.0.0
Executables breve
Downloads 7392 total (225 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs uploaded by user
Build status unknown [no reports yet]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for breve-0.5.0.0

[back to package description]

Breve

a url shortener

Breve is a web application that provides a simple interface to shortening long urls creating links smaller and easier to remember.

You can find a running instance on brve.bit

It creates links in the form of "/emeaoinqua": easier to remember than alphanumeric strings like "/1Cqw8lHw" used by several services.

It was inspired by hastebin.

Installing

Install the app with cabal-install. Run

$ cabal install breve

and start it with

$ breve

The app will start serving on https://localhost:3000, listening on every active interface.

Configure

You can change the options by editing the config file. When you start the app an empty one will be created in: $XDG_CONFIG_HOME/breve, ~/.config/breve if unset, or you can pass a path as the first argument of breve.

The default values are:

hostname = "localhost"
port     = 3000
baseurl  = "https://localhost:3000/"
urltable = "$XDG_CONFIG_HOME/breve"
tls {
  cert  = "/usr/share/tls/breve.crt"
  key   = "/usr/share/tls/breve.key"
  chain = []
}

urltable is the location of breve url hashtable

chain is a list of chain certificate files

License

Copyright (C) 2019 Michele Guerini Rocco

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.