Skip to content

kyleyannelli/tiny.kmfg

Repository files navigation

tiny.kmfg

Administrative url aliasing service for managing long and large url collections.

HTTPS by default & PASETO for web auth.

Made to run hassle free or with fine grained control. The API is read only and the Web UI for management are served separately for peace of mind when exposing the API to the internet.

Setup

Note: The docker-compose.yml is ready to go with the below default values. Simply run docker compose up -d

Environment Variables

Variable Default Description
KMFG_TINY_TRUSTED_IPS nil ip or ips in a comma separated list for trusted proxies. For example, "127.0.0.1" or "127.0.0.1, 10.10.1.60". Please use this if you are behind reverse proxy or tunnel.
KMFG_TINY_API_PORT 30108 port for the API server
KMFG_TINY_API_TLS true set to false to disable https for the api server
KMFG_TINY_WEB_PORT 30109 port for the web management server
KMFG_TINY_WEB_TLS true set to false to disable https for the web server
KMFG_TINY_CERT_FILE Auto-Generated provide the certificate file if exposing directly to the internet without a reverse proxy
KMFG_TINY_KEY_FILE Auto-Generated provide the key file if exposing directly to the internet without a reverse proxy
KMFG_TINY_DB ./tiny.kmfg.db sqlite database location
KMFG_TINY_DB_LOG false set to true for database logging

Run the Service

Run the binary, build it yourself with go build, or use go run .

Screenshot of tiny.kmfg startup logs

Thanks

This project is built on the below

About

Administrative url aliasing service

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published