Skip to content

CheetahDoesStuff/kiln

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Kiln

A simple url shortener thats not yet another bitly wrapper
image

Features

  • Actual URL shortening using sqlite
  • Seperated links and homepage ports, to allow for binding to 2 different domains (like homepage on bitly.com and links on bit.ly)
  • A clean and minimal frontend
  • Instant setup using docker

Usage

There is a live demo hosted publicly at https://kiln.ch0.dev.

Selfhost

Note: The homepage binds to port 8080 by default and the urls bind to port 8081 by default.
You can also host it yourself using docker:

docker pull cheetahdoesstuff/kiln
docker run -p 8080:8080 -p 8081:8081 \
  -e LINK_HOST="your url host" \
  -e MAIN_HOST="your main host" \
  cheetahdoesstuff/kiln

Where LINK_HOST is the domain the the urls are on (eg l.ch0.dev) and MAIN_HOST is the domain the homepage is on (eg kiln.ch0.dev).

You can then verify the container is running using:

docker ps

Tech stack

  • Rust
  • Axum
  • Sqlite
  • tailwind CSS & HTML/JS

License

This project is dual-licensed under the MIT and APACHE licenses.

Contributing

You are always welcome to contribute to the project! But your contribution must follow the following guidelines:

  • No code shall be generated or written by AI
  • No code shall be harmful in any way to the host or users of the project, nor the developers.
  • No code shall be written for the benefit of the contributor, such as monetization or ads.
  • Code shall be properly formatted using cargo fmt, and shall not raise any warnings from clippy.
  • The code must be fully functional and not break any part of the codebase.

With those guidelines in place, happy contributing!

Note: for the auth to work you must have a .env file with the same environment values as the docker command above at the selfhosting section.

About

No description, website, or topics provided.

Resources

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors