Simply-Shorten#

Simply-Shorten A simple selfhosted URL shortener with no name because naming is hard

amd64
arm64
armv7

Information#

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

SETUP#

Enabling simply_shorten#

Command:#

vlab set simply_shorten.enable True

File alteration:#

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

eg.

simply_shorten
enable: True

Finalising changes:#

run: vlab update_one service=simply_shorten

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, simply_shorten 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=simply_shorten to complete the changes

ACCESS#

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

OPTIONS#

HTTPS_ONLY#

Default: False
Options: True/False

Command:#

vlab set simply_shorten.https_only True

File alteration:#

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

eg.

simply_shorten
https_only: True
Finalising changes:#

run: vlab update_one service=simply_shorten

AUTH#

Default: False
Options: True/False

Command:#

vlab set simply_shorten.auth True

File alteration:#

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

eg.

simply_shorten
auth: True
Finalising changes:#

run: vlab update_one service=simply_shorten

DOMAIN#

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

Command:#

vlab set simply_shorten.domain simply_shorten.com

File alteration:#

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

eg.

simply_shorten
domain: simply_shorten.com
Finalising changes:#

run: vlab update_one service=simply_shorten

SUBDOMAIN#

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

Command:#

vlab set simply_shorten.subdomain media

File alteration:#

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

eg.

simply_shorten
subdomain: media
Finalising changes:#

run: vlab update_one service=simply_shorten

VERSION#

Default: latest
NOTE: Ensure that the version exists

Command:#

vlab set simply_shorten.version 2.7

File alteration:#

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

eg.

simply_shorten
version: 2.7
Finalising changes:#

run: vlab update_one service=simply_shorten

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.