/shortr

Shortr is an Golang URL shortener

Primary LanguageGoGNU General Public License v3.0GPL-3.0

Shortr - an Golang URL shortener

Shortr is inspired by Sam Wierema' Go URL Shortener, and more a project to get familiar with Golang.

Features

Scope of the application is to shorten urls using only [a-z0-9] characters and redirect requests to the corresponding site. In addtion the application has a tiny api interface to auhenticate and create short urls with a jwt token. Use case is the idea of a user based url shortener api due to common laws of countries to be responsible for content of provided services.

In addition, ther are several features implemented as:

  • Redirect to your main website when no slug, or incorrect slug, is entered, e.g. http://domain.tdl/ → http://website.domain.tdl/.
  • Doesn’t create a short URLs again if there's an attempt to shorten same URL. Therefor script returns already existing short URL.
  • Additionally validation and security checks as: (1) Avoid flooding. Limit creation of short urls in a defined time interval. (2) Check if url host is valid. (3) Avoiding self reference on base url.

API Requests

All requests json-encoded and returns as response a json.

Requests Variables Type Response Token
/auth {'username':{user},'password':{password}} POST {'url':{shortr_url},'status':{2xx}} -
/shortr {'url':{url_to_shorten}} POST {'token':{bearer_token},'status':{2xx}} X

Please note error response will return {'error':{error_msg},'status':{4xx}}

Examples: curl -X POST "domain.tdl/auth" -H "Content-Type: application/json" -d "{"user":"test","password":"pass"}" curl -X POST "domain.tdl/shortr" -H "Content-Type: application/json" -H "Authorization: bearer {token}" -d "{"url":"domain_to_shorten.tdl"}"

Installation

  1. Download the source code and install it using the make shortr command.
  2. Use separately database.sql in install/db to create tables.
  3. Create a config file in /path/to/shortr/ named env.json. Use env-example.json as a example.
  4. Adding the following configuration to Apache (make sure you've got mod_proxy enabled):
<VirtualHost *:80>
	ServerName your-short-domain.ext

	ProxyPreserveHost on
	ProxyPass / http://localhost:8080/
	ProxyPassReverse / http://localhost:8080/
</VirtualHost>

Using the run.sh script

Generally you can run the program by go run src/*.go or ./shortr using parameters with defined flags at main.go. But for purposes of convenience run.sh is maybe a better choice.

  • Run the program by using ./run.sh. Write output to a log file use parameter -l for indicate a path and see it at .shortr.log.
  • Stop the program by using ./run.sh stop.