breve: a url shortener

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain] [Publish]

Warnings:

'ghc-options: -O2' is rarely needed. Check that it is giving a real benefit and not just imposing longer compile times on your users.

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

[Skip to Readme]

Properties

Versions	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.0, 0.4.5.1, 0.5.0.0, 0.5.1.0
Change log	None available
Dependencies	aeson, base (>=4.8 && <5.0), binary, blaze-html, bytestring, configurator, cryptohash, directory, hashtables, http-types, mtl, random, Spock, Spock-core, text, tls, transformers, wai, wai-extra, wai-middleware-static, warp, warp-tls, xdg-basedir [details]
License	GPL-3.0-only
Copyright	(C) Michele Guerini Rocco 2015
Author	rnhmjoj
Maintainer	micheleguerinirocco@me.com
Category	Web
Home page	https://github.com/rnhmjoj/breve
Source repo	head: git clone https://github.com/rnhmjoj/breve
Uploaded	by rnhmjoj at 2019-05-15T01:08:28Z

Downloads

breve-0.4.5.0.tar.gz [browse] (Cabal source package)
Package description (as included in the package)

Maintainer's Corner

Package maintainers

rnhmjoj

For package maintainers and hackage trustees

edit package information

Readme for breve-0.4.5.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

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/.