All apps · 0 apps
kutt
OfficialDocker app from c4artz' Repository
Overview
Kutt is a modern URL shortener with support for custom domains. Shorten URLs, manage your links and view the click rate statistics.
[b]This container requires Redis a Postgres database and a functioning FQDN![b]
Setup:
- Install the Postgres container from your Apps tab.
- Create a database an user.
- Give the user permissions on the created database.
- Install the Redis container from your Apps tab.
- Setup an email account which Kutt can use. (technically optional but highly recommended!)
- Setup an your preferred method of exposing Kutt to the outside world.
- Fill out this template.
Optional:
- Setup Google Safe Browsing
- Setup Google Analytics
Install Kutt on Unraid in a few clicks.
Find Kutt in Community Apps on your Unraid server, review the template, and click Install. Unraid handles the Docker app or plugin setup from the published template.
Categories
Download Statistics
Total Downloads Over Time
Related apps
Explore more like this
Explore allLinks
Details
kutt/kuttRuntime arguments
- Web UI
http://[IP]:[PORT:3000]- Network
bridge- Privileged
- false
Template configuration
Container Port: 3000
- Target
- 3000
- Default
- 8080
IP of your Postgres instance
- Target
- DB_HOST
Port of your postgres instance
- Target
- DB_PORT
- Default
- 5432
Name of your database. Make sure the database is already created and your user has the needed permissions!
- Target
- DB_NAME
- Default
- kutt
Name of your database user
- Target
- DB_USER
- Default
- kutt
Password of your database user
- Target
- DB_PASSWORD
Use SSL for database connection
- Target
- DB_SSL
- Default
- false
IP of your Redis instance
- Target
- REDIS_HOST
Port of your Redis instance
- Target
- REDIS_PORT
- Default
- 6379
Password for your Redis instance. Leave blank if you didn't set one!
- Target
- REDIS_PASSWORD
Hostname (FQDN or IP) of your mail provider. Used to send verification emails
- Target
- MAIL_HOST
Port of your mail provider. 25 (unencrypted), 587 (TLS), 465 (SMTPS)
- Target
- MAIL_PORT
Set to true if using port 465
- Target
- MAIL_SECURE
- Default
- false
Your email username. Most likely your email address
- Target
- MAIL_USER
Password of your email user
- Target
- MAIL_PASSWORD
Sender address
- Target
- MAIL_FROM
Comma seperated list of admin email adresses
- Target
- ADMIN_EMAILS
The email address that will receive submitted reports
- Target
- REPORT_EMAIL
Support email to show on the app
- Target
- CONTACT_EMAIL
The domain that this website is on
- Target
- DEFAULT_DOMAIN
The name of the site where Kutt is hosted
- Target
- SITE_NAME
- Default
- Kutt
Generated link length
- Target
- LINK_LENGTH
- Default
- 6
Disable registration
- Target
- DISALLOW_REGISTRATION
- Default
- false
Disable anonymous link creation
- Target
- DISALLOW_ANONYMOUS_LINKS
- Default
- false
Default limit for how many links a user can create per day
- Target
- USER_LIMIT_PER_DAY
- Default
- 50
Number of links anonymous users can create per minute. Ignored if anonymous link creation is disabled
- Target
- NON_USER_COOLDOWN
- Default
- 0
Max number of visits for each link to have detailed stats
- Target
- DEFAULT_MAX_STATS_PER_LINK
- Default
- 5000
A passphrase to encrypt JWT. Use a long and secure key.
- Target
- JWT_SECRET
- Default
- securekey
Invisible reCaptcha key. Create one here https://www.google.com/recaptcha/intro/
- Target
- RECAPTCHA_SITE_KEY
Container Variable: RECAPTCHA_SECRET_KEY
- Target
- RECAPTCHA_SECRET_KEY
Google Cloud API to prevent from users from submitting malware URLs. Get one from https://developers.google.com/safe-browsing/v4/get-started
- Target
- GOOGLE_SAFE_BROWSING_KEY
your GA key
- Target
- GOOGLE_ANALYTICS
Your universal GA key
- Target
- GOOGLE_ANALYTICS_UNIVERSAL
Internal application port. Do not change this!
- Target
- PORT
- Default
- 3000