Kutt#

Kutt Kutt your links shorter.

amd64 arm64 armv7

Information#

Docker Image: !!! LINK TO DOCKER IMAGE/ DOCKER HUB !!!
Current Image Version: latest

SETUP#

Enabling Kutt#

Command:#

vlab set kutt.enable True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

kutt
enable: True

Finalising changes:#

run: vlab update_one service=kutt

FIRST RUN#

!!! DEVELOPERS: make sure that you include any information that the user requires to get started, below. !!!

!!! Below are some examples with headings, and with some example instructions !!!

ADMINISTRATOR SETUP#

Navigate to https://False/admin

Create an account with your desired username; as this is the first user, kutt makes this account the administrator.

SMTP/ MAIL#

  1. run vlab decrypt to decrypt the vault.yml file

  2. make some changes

SMTP Settings#
smtp:
host:
port:
user:
pass:
from_email:
from_name:
  1. run vlab update_one service=kutt to complete the changes

ACCESS#

kutt (HTTPS) link: https://kutt.vivumlab.xyz/ kutt (HTTP) link: http://kutt.vivumlab.xyz/

OPTIONS#

HTTPS_ONLY#

Default: False Options: True/False

Command:#

vlab set kutt.https_only True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

kutt
https_only: True

AUTH#

Default: False Options: True/False

Command:#

vlab set kutt.auth True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

kutt
auth: True

DOMAIN#

Default: False NOTE: include the sitename and top level domain suffix. eg. name.com, site.net

Command:#

vlab set kutt.domain kutt.com

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

kutt
domain: kutt.com

SUBDOMAIN#

Default: kutt NOTE: Periods/ delimiters are not required. eg. 'media' will set the full URL as 'media.vivumlab.xyz'

Command:#

vlab set kutt.subdomain media

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

kutt
subdomain: media

VERSION#

Default: latest NOTE: Ensure that the version exists

Command:#

vlab set kutt.version 2.7

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

kutt
version: 2.7

Finalising changes:#

run: vlab update_one service=kutt

Need more help?#

Further information regarding services can be found. \ General Information can be found in the documentation. \ Additional assistance can be found on our Contact Us page.