Repository files navigation

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

• Key Features
• Stack
• Setup
• Browser Extensions
• API
• Integrations
• 3rd Party Packages
• Donate
• Contributing

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

• 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)

You need to haveNode.js,PostgreSQL andRedis installed.

1. Clone this repository ordownload 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 thennpm start.

1. Download thedocker-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 rundocker-compose up -d command and then the app should be ready on port "3000".

Thedocker-compose.yml uses the official kutt docker image available onDocker Hub.

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, seethis comment how it can be done manually)
• REPORT_EMAIL: Kutt offers a form to report malicious links which are sent to this mail-address

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

• Chrome
• Firefox

Visit API v2 documentation ondocs.kutt.it

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

Download Kutt's official workflow forAlfred app fromalfred-kutt repository.

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

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 toThomas andMuthu. Logo design byMuthu.