🔗 Free Modern URL Shortener. https://kutt.it/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
poeti8 2cbf79aef0 2.7.2 2 months ago
client Merge branches 'develop' and 'develop' of github.com:thedevs-network/kutt into develop 5 months ago
docs/api feat: add link expiration 7 months ago
server fix: remove www when checking and adding domains 2 months ago
static chor: remove unused images 1 year ago
.babelrc chore: remove unused 1 year ago
.docker.env Update .docker.env 5 months ago
.dockerignore Ignore .env (#284) 1 year ago
.eslintignore [v2-beta] Move from Neo4j to Postgres, use TypeScript for server. Fixes #217, #197, #190, #75 (#220) 1 year ago
.eslintrc feat: api v2 1 year ago
.example.env Update .example.env 5 months ago
.gitignore API doc generation! (#280) 1 year ago
.prettierrc feat: refactor client and improve design (#260) 1 year ago
.template.env Update .template.env 5 months ago
.travis.yml chore: remove scripts with error 7 months ago
Dockerfile chor: make sure postgres is up before running migrations 1 year ago
LICENSE update year and name 1 year ago
MIGRATION.md Update MIGRATION.md 1 year ago
README.md Add Gist link to a simple BASH function for the API 3 months ago
btc.png docs(readme): add donate section 7 months ago
docker-compose.yml feat: sanitize docker-compose (#360) 7 months ago
global.d.ts feat: add change email functionality 5 months ago
knexfile.ts fix: pass env.DB_SSL to Knex so that migrations succeed with SSL (#316) 9 months ago
next.config.js Upgrade to sentry (#374) 6 months ago
nodemon.json chore: rename ts config 1 year ago
package-lock.json 2.7.2 2 months ago
package.json 2.7.2 2 months ago
tsconfig.json API doc generation! (#280) 1 year ago
wait-for-it.sh chor: make sure postgres is up before running migrations 1 year ago

README.md

Kutt.it

Kutt.it

Kutt is a modern URL shortener with support for custom domains. Shorten URLs, manage your links and view the click rate statistics.

Contributions and bug reports are welcome.

https://kutt.it

Build Status Contributions GitHub license Twitter

Migration from v1

The new version of Kutt is here. In version 2, we used TypeScript and we moved from Neo4j to PostgreSQL database in favor of performance and we're working on adding new features.

If you're coming from v1, refer to MIGRATION.md to migrate data from Neo4j to PostgreSQL.

Table of Contents

Key Features

  • Free and open source.
  • Custom domain support.
  • Custom URLs for shortened links
  • Set password for links.
  • Set description for links.
  • Expiration time for links.
  • Private statistics for shortened URLs.
  • View, edit, delete and manage your links.
  • Admin account to view, delete and ban links.
  • Ability to disable registration and anonymous link creation for private use.
  • RESTful API.

Stack

  • Node (Web server)
  • Express (Web server framework)
  • Passport (Authentication)
  • React (UI library)
  • Next (Universal/server-side rendered React)
  • Easy Peasy (State management)
  • styled-components (CSS styling solution library)
  • Recharts (Chart library)
  • PostgreSQL (database)
  • Redis (Cache layer)

Setup

Manual

You need to have Node.js, PostgreSQL and Redis installed.

  1. Clone this repository or download the latest zip.
  2. Copy .example.env to .env and fill it properly (see below).
  3. Install dependencies: npm install.
  4. Run for development: npm run dev.
  5. Run for production: npm run build then npm start.

Docker

Download the docker-compose.yml and the .docker.env-file from the repository and configure the .docker.env (see below). To execute Kutt you simply have to run docker-compose up -d command and then the app should be ready on port "3000".

The docker-compose.yml uses the official kutt docker image available on Docker Hub.

Configuration

For the minimal configuration the following settings have to be changed in the .env-file:

  • DEFAULT_DOMAIN: The domain of your kutt instance
  • **DB_**: The DB credentials (when you use docker-compose you can skip these)
  • ADMIN_EMAILS: A comma-separated list of the administrator-accounts
  • **RECAPTCHA_**: Enter your credentials to use reCaptchas or delete this setting if you don't want to use it
  • **MAIL_**: Enter the SMTP-server's credentials (The experience shows SSL works better than STARTTLS; The mail config is required to easily create accounts, see this comment how it can be done manually)
  • REPORT_EMAIL: Kutt offers a form to report malicious links which are sent to this mail-address

Browser Extensions

Download Kutt's extension for web browsers via below links. You can also find the source code on kutt-extension.

API

Visit API v2 documentation on docs.kutt.it

Integrations

ShareX

You can use Kutt as your default URL shortener in ShareX. If you host your custom instance of Kutt, refer to ShareX wiki on how to setup.

Alfred Workflow

Download Kutt's official workflow for Alfred app from alfred-kutt repository.

3rd Party packages

Language Link Description
C# (.NET) KuttSharp .NET package for Kutt.it url shortener
Python kutt-cli Command-line client for Kutt written in Python
Ruby kutt.rb Kutt library written in Ruby
Rust urlshortener URL shortener library written in Rust
Rust kutt-rs Command line tool written in Rust
Node.js node-kutt Node.js client for Kutt.it url shortener
JavaScript kutt-vscode Visual Studio Code extention for Kutt
Java kutt-desktop A Cross platform Java desktop application for Kutt
Go kutt-go Go client for Kutt.it url shortener
BASH GitHub Gist Simple BASH function to access the API

Donate

Kutt.it

Kutt is free of charge and free of ads. Help us keep our servers running and motivate us to work on this project by donating to our Bitcoin wallet:

1P89WxNTinKxxDQ4FmC4jis3KUdfA9fLJB

Contributing

Pull requests are welcome. You'll probably find lots of improvements to be made.

Open issues for feedback, requesting features, reporting bugs or discussing ideas.

Special thanks to Thomas and Muthu. Logo design by Muthu.