Free Modern URL Shortener.

xescure 75dceaeefc Update docker-build-release.yaml		4 年之前
.github	75dceaeefc Update docker-build-release.yaml	4 年之前
client	23557ac94e Merge branches 'develop' and 'develop' of github.com:thedevs-network/kutt into develop	5 年之前
docs	00fc1faed9 feat: add link expiration	5 年之前
server	5e42185df5 fix: remove www when checking and adding domains	5 年之前
static	f658e8bab9 chor: remove unused images	5 年之前
.babelrc	edac550441 chore: remove unused	6 年之前
.docker.env	31b51218cb Update .docker.env	5 年之前
.dockerignore	b6884ea1aa Ignore .env (#284)	5 年之前
.eslintignore	33320f0205 [v2-beta] Move from Neo4j to Postgres, use TypeScript for server. Fixes #217, #197, #190, #75 (#220)	6 年之前
.eslintrc	25903bf3cd feat: api v2	6 年之前
.example.env	03922fa6fd Update .example.env	5 年之前
.gitignore	2c261ad4af API doc generation! (#280)	6 年之前
.prettierrc	4680a0dbec feat: refactor client and improve design (#260)	6 年之前
.template.env	771713dd12 Update .template.env	5 年之前
.travis.yml	5d82ee69d1 chore: remove scripts with error	5 年之前
Dockerfile	70c1267df4 chor: make sure postgres is up before running migrations	5 年之前
LICENSE	ddc52f8b7c update year and name	6 年之前
MIGRATION.md	00494abc38 Update MIGRATION.md	6 年之前
README.md	a8b20f8893 Add link to a simple BASH client with GUI	5 年之前
btc.png	5526d89e26 docs(readme): add donate section	5 年之前
docker-compose.yml	f9813bb854 feat: sanitize docker-compose (#360)	5 年之前
global.d.ts	9e99c2ce51 feat: add change email functionality	5 年之前
knexfile.ts	1b70e84513 fix: pass env.DB_SSL to Knex so that migrations succeed with SSL (#316)	5 年之前
next.config.js	b3b7a0273c Upgrade to sentry (#374)	5 年之前
nodemon.json	b83ce016dd chore: rename ts config	6 年之前
package-lock.json	7084c070e8 chore(deps): bump elliptic from 6.5.3 to 6.5.4	4 年之前
package.json	2cbf79aef0 2.7.2	5 年之前
tsconfig.json	2c261ad4af API doc generation! (#280)	6 年之前
wait-for-it.sh	70c1267df4 chor: make sure postgres is up before running migrations	5 年之前

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

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.

Key Features
Stack
Setup
Browser Extensions
API
Integrations
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.

Clone this repository or download the latest zip.
Copy .example.env to .env and fill it properly (see below).
Install dependencies: npm install.
Run for development: npm run dev.
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
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.

README.md