mirror of
https://github.com/taigrr/shorturl
synced 2025-01-18 04:03:16 -08:00
a3409454c0
* Changed URL format to shortuuid * Fixed drone CI failure * Moved database to Bitcask and some minor changes * Moved database to Bitcask and some minor changes * Delete coverage.txt
52 lines
1.7 KiB
Markdown
52 lines
1.7 KiB
Markdown
# shorturl - A self-hosted URL shortener web app and service
|
|
|
|
[](https://cloud.drone.io/prologic/shorturl)
|
|
[](https://codecov.io/gh/prologic/shorturl)
|
|
[](https://goreportcard.com/report/prologic/shorturl)
|
|
[](https://godoc.org/github.com/prologic/shorturl)
|
|
[](https://sourcegraph.com/github.com/prologic/shorturl?badge)
|
|
|
|
shorturl is a web app that allows you to create short urls of much longer more
|
|
complex urls for easier sharing or embedding.
|
|
|
|
## Installation
|
|
|
|
### Source
|
|
|
|
Due to the necessity of the way assets are handled if you are building/installing from source and intend to run outside of the source tree you need to do something like this:
|
|
|
|
```#!bash
|
|
$ go get github.com/GeertJohan/go.rice/rice
|
|
$ go get github.com/prologic/shorturl
|
|
$ cd $GOPATH/src/github.com/prologic/shorturl
|
|
$ rice embed-go
|
|
$ go build
|
|
```
|
|
|
|
## Usage
|
|
|
|
Run shorturl:
|
|
|
|
```#!bash
|
|
$ shorturl
|
|
```
|
|
|
|
Then visit: http://localhost:8000/
|
|
|
|
## Configuration
|
|
|
|
By default shorturl stores urls in `db` subdirectory of the local directory. This can
|
|
be configured with the `-dbpath /path/to/db/` option.
|
|
|
|
shorturl also displays an absolute url after creating and uses the value of
|
|
`-baseurl` (*default: `""`*) for display purposes. This is useful for copying
|
|
and pasting the shorturl.
|
|
|
|
## Data Storage
|
|
|
|
Data is currently stored in a [Bitcask](https://github.com/prologic/bitcask) key/value store configured via the `-dbpath` option.
|
|
|
|
## License
|
|
|
|
MIT
|