Startseite Erkunden Hilfe
Anmelden
Vieraw
/
Kutt
1
0
Fork 0
Dateien Issues 0 Pull-Requests 0 Wiki

Free Modern URL Shortener.

Struktur: d1c28ff302
Branches Tags
Kutt
ZIP TAR.GZ
Pouria Ezzati d1c28ff302 create user_id index on visits table vor 1 Jahr
.github caeb533a25 Delete FUNDING.yml vor 3 Jahren
db 278ae08476 add db folder and point database files for sqlite to this folder vor 1 Jahr
docs 83cf492d65 remove docs js files from gitignore vor 1 Jahr
server d1c28ff302 create user_id index on visits table vor 1 Jahr
static 4c316b5cba move stats related javascript code to its own file vor 1 Jahr
.docker.env f67821b81d remove recaptcha from env vor 1 Jahr
.dockerignore b6884ea1aa Ignore .env (#284) vor 5 Jahren
.example.env 752f5ba3bd add rate limit vor 1 Jahr
.gitignore 278ae08476 add db folder and point database files for sqlite to this folder vor 1 Jahr
Dockerfile 698cf6e305 delete nextjs, update packages vor 1 Jahr
LICENSE ddc52f8b7c update year and name vor 6 Jahren
README.md ea9ac99d87 chore: remove v1 endpoints and neo4j migration guide vor 3 Jahren
btc.png 5526d89e26 docs(readme): add donate section vor 5 Jahren
docker-compose.yml f9813bb854 feat: sanitize docker-compose (#360) vor 5 Jahren
jsconfig.json 5ea233f06b more cleanups vor 1 Jahr
knexfile.js b4cfc8983b refactor dateToUTC vor 1 Jahr
package-lock.json 752f5ba3bd add rate limit vor 1 Jahr
package.json 752f5ba3bd add rate limit vor 1 Jahr
wait-for-it.sh 70c1267df4 chor: make sure postgres is up before running migrations vor 5 Jahren

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

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

  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.

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.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.