How to run locally (Kave Version):

1. copy env.sample .env, values are ready for local development.
2. npm install --force, to install all needed dependencies. Use NPM. Do not use yarn.
3. docker compose up to spin up the database and redis services.
4. npm run dev to start the server.

How to deploy to production (Kave Version):

This repository holds the helm chart's custom values we used to deploy self-managed Kutt on Kubernetes.

Also, we are using Terraform to provision a CloudSQL instance for the Kutt database.

Prerequisites

service-account.json

At 1Password look for "Terraform Service Account for Kave Tech Services", copy and paste it at the terrafom/kutt/ folder. Name it service-account.json.

Once it is done, cd to the terrafom/kutt/ folder and perform a terraform init.

Apply terraform

terraform apply

Wait until terraform finish.

Go to GCP on secret manager, view the secret named url_shortener_password and copy the database password to vault k8s/kv/kave-tech-services/url-shortener -> DATABASE_PASSWORD key.

Go to SQL instances and get the private ip of kutt-url-shortener instance and copy on helm/custom-values.yaml

externalPostgresql:
  auth:
    hostname: <Private IP here>

Prepare the namespace to use helm

Kutt has been deployed in k8s Kave Tech Services' services-prod cluster using the official Helm Chart under the url-shortener namespace.

If it's first time: See how to use ssl cert -> Use Google-managed SSL Cert

Now let's use helm

cd helm/url-shortener

to install:

helm install url-shortener . --namespace url-shortener --values custom-values.yaml --create-namespace

to update:

helm upgrade url-shortener . --namespace url-shortener --values custom-values.yaml 

to uninstall:

helm uninstall url-shortener --namespace url-shortener

See the results

First wait until the Google managed cert has been created and ACTIVE. When the cert is ACTIVE, you can go to https://kave.to

How to deploy new code changes

1. Push the branch and make a PR.

2. Run the github action "Deploy new image version" using your branch or if you merged the PR first, using develop branch.

3. The github action will build and push the image and run a helm upgrade with the new image.

NOTE: The upgrade only changes the image tag, if you want to apply other changes on custom-values run helm upgrade manually.

To run manually: Go to github and ensure that the image number it's equals on github and on custom-values.yaml and change on custom-values the last tag manually.

Original Readme:

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

Table of Contents

• How to run locally (Kave Version):
• How to deploy to production (Kave Version):
• Original Readme:
• Kutt.it
  • Table of Contents
  • Key Features
  • Stack
  • Setup
    • Manual
    • Docker
    • Configuration
  • Browser Extensions
  • API
  • Integrations
    • ShareX
    • Alfred Workflow
  • 3rd Party packages
  • Donate
  • Contributing

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

1. Download the docker-compose.yml and the .docker.env files.
2. Rename .docker.env to .env and fill it properly (see below).
3. 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.

• Chrome
• Firefox

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
C# (.NET)	Kutt.NET	✂️🔗 C# API Wrapper for Kutt
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 extension 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
BASH	url-shortener	Simple BASH script with GUI

Donate

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.