outbound-go

Outbound

URL shortener and click counter. Best suited if you are looking to host your own.

Table of Contents

• What does outbound mean?
• Features
• Installation
• Using docker
• Configuration
• Usage

Features

• Written in Go - just a binary with 0 dependencies and yeah, it's fast.
• Supports both MongoDB and PostgreSQL.
• Redirect your preferred way - client-side or server-side.
• Shorten URLs to reduce usage.
• Count clicks on each shortened URL.

Installation

Download the latest binary for Linux here. Configure and just run the binary.

Using docker

1. Clone the repo
2. Docker compose

docker-compose up --build

1. To change configurations update docker.env

Configuration

.env.postgresql.json, .env.mongodb.json or environment variables is what you are looking for.

It first checks CONFIG_FILE environment variable for required file, and if not found fetches each environment variable. The variables are described as under:

Usage

• Create a new entry

Make a post request to /new with access_token (if required) and url. The result will be a new Link object with the short_id of the shortened URL.

• Redirect a shortened URL (short_id)
  • Client side : /c/:short_id
  • Server side : /s/:short_id
  • Default : /r/:short_id

What does outbound mean?

• Outbound refers to traffic outside your domain/website.
• Websites log clicks to other domains for analytical purpose. Example, Facebook uses lm.facebook.com, Slack uses slack-redir.net, Twitter has t.co, etc.

This is similar to https://git.io

Liked this? Star this repo, or Grab me a coffee.