Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/himanshub16/outbound-go
URL shortener and Redirection As A Service
https://github.com/himanshub16/outbound-go
docker gin go golang outbound redirection tracking url-shortener
Last synced: about 2 months ago
JSON representation
URL shortener and Redirection As A Service
- Host: GitHub
- URL: https://github.com/himanshub16/outbound-go
- Owner: himanshub16
- License: mit
- Created: 2018-05-27T17:40:55.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-11-10T06:32:31.000Z (about 6 years ago)
- Last Synced: 2024-06-20T16:38:02.351Z (6 months ago)
- Topics: docker, gin, go, golang, outbound, redirection, tracking, url-shortener
- Language: Go
- Homepage: https://outbound-go.herokuapp.com/
- Size: 1.53 MB
- Stars: 22
- Watchers: 3
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Outbound
URL shortener and click counter. Best suited if you are looking to host your own.
---
Table of Contents
* [What does outbound mean?](#what-does-outbound-mean)
* [Features](#features)
* [Installation](#installation)
* [Using docker](#using-docker)
* [Configuration](#configuration)
* [Usage](#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**](https://www.w3.org/TR/WCAG20-TECHS/H76.html) or [**server-side**](https://www.w3.org/TR/WCAG20-TECHS/SVR1.html).
* Shorten URLs to reduce usage.
* Count clicks on each shortened URL.
## Installation
Download the latest binary for Linux [here](https://github.com/himanshub16/outbound-go/releases/latest).
Configure and just run the binary.
### Using docker
1. Clone the repo
2. Docker compose
```
docker-compose up --build
```
3. 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`
## 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.](https://github.com/himanshub16/outbound-go/raw/master/static/paytm.png)