outbound-go
outbound-go copied to clipboard
Published
20 hours ago •
himanshub16
himanshub16
URL shortener and Redirection As A Service
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
- Clone the repo
- Docker compose
docker-compose up --build
- 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:
| Field | Description | Example |
|---|---|---|
| DBTYPE | string : one of postgresql or mongodb |
mongodb |
| DB_URL | URL of database instance (mongodb/postgresql) | mongodb://localhost:27017 |
| LINKS_COLL | The collection which stores the links | links |
| COUNTER_COLL | The collection which stores the counter | counter |
| PORT | 9000 | |
| REDIRECT_METHOD | Default redirect method, one of client-side and server-side |
client-side |
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
- Client side :
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.
himanshub16