Links

This is a simple URL shortener made by TrueWinter using NodeJS and Sqlite3 as the database.

Configuration

A config.js file is used to configure this software. Below is an example configuration file

var config = {
	length: 6,
	dbFile: './db.sqlite3',
	expressProxy: 'loopback',
	password: 'password',
	port: '19282',
	domain: 'short.url',
	homeRedirect: 'https://example.com',
	customLogic: '',
	sessionSecret: 'lkhasdlfaslkfdjsl',
	prometheus: {
		enabled: false,
		port: '19292'
	}
};

module.exports = config;

You should use a proxy such as Nginx to proxy requests to the URL shortener's port (19282 by default).

Usage

Short URL Creation

Go to {domain}/admin/new and enter the long URL, an optional short ID (if left out, one will be randomly generated). You should receive a message containing the short URL.

Stats

Go to {domain}/admin.

Uptime Monitoring

{domain}/onlinecheck returns OK with a 200 status code and should be used for uptime monitoring.

Prometheus

Support for Prometheus is still in beta. To enable it, set config.prometheus.enabled to true.