42l
/
rs-short
3
3
Fork 3
Code Issues 5 Pull Requests Releases 16 Wiki Activity
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
master
3.2.0
3.1.0
1.0.0
1.1.0
2.0.0
2.1.0
2.1.1
2.1.2
2.2.0
2.2.1
2.2.2
2.2.3
2.2.4
3.0.0
3.0.1
3.0.2
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'master'
${ noResults }
rs-short/README.md

4.0 KiB
Raw Permalink Blame History Unescape Escape

rs-short

Link shortener in Rust.

Developed to be as minimal and lightweight as possible.

Powered by the Actix framework using (server-side) Askama templates.

  • Around 1000 lines of code, including 20% of comments
  • Consumes between 5MB and 20MB of RAM
  • No JS, no CSS framework
  • No tracking features, user IPs are not saved in database
  • No unsafe block
  • Compiles on Rust stable

Features:

  • Includes a captcha as a minimal protection against spamming
  • Easily customizable assets, contact details and hoster information
  • Light / dark theme
  • Only needs a SQLite database to work
  • Robust caching features to serve content even with database locks
  • Localization (available in French, English, Croatian and Occitan, please translate!)
  • Basic protection against spambots (captcha with a customizable difficulty)
  • Active detection of phishing links (detects "suspicious activity")
  • Counting clicks
  • Allows shortcut deletion by the user
  • Allows marking a shortcut as "phishing", which displays a awareness-raising message to victims
  • Blocks URL with regexes, includes a default blocklist

Official instance: https://s.42l.fr/

Screenshots

Main page:

Main page screenshot

Admin page for users when they create a link:

New link screenshot

Page displayed when a link is marked as phishing by the server administrator:

Main page screenshot

Running an instance

First, you must install Cargo and the latest stable version of Rust by following the instructions on this website. Alternatively, you can use the liuchong/rustup Docker image.

  • Clone the project:
git clone https://git.42l.fr/42l/rs-short.git

  • Edit what you need. You might want to change the following files:

    • assets/hoster-logo.svg: replace with the logo of your organization
    • assets/logo.svg: the software logo
    • assets/themes/light/background.jpg: the default background for the light theme

  • Copy config.toml.sample to config.toml and edit its values to suit your needs:

    • Important: Replace default values of cookie_key and phishing_password.

  • Edit the policy lists in lists.toml at your convenience.

You can configure a fail2ban instance and watch your favourite reverse-proxy logs to see which IPs are getting a 403 Forbidden and ban accordingly for the duration of your choice.

  • Choose a database:
    • cargo run --release for SQLite (default, don’t use in production)
    • cargo run --release --no-default-features --features postgres for PostgreSQL
    • cargo run --release --no-default-features --features mysql for MySQL

To integrate the service with a systemd or nginx configuration, please check the wiki.

Contributing

Here are many ways to contribute:

  • Translate!
    • Add your entries in the lang.json file.
    • Once you're done, edit init.rs and add your language in the ValidLanguages structure.
  • Add some more CSS themes
  • Rework default themes' CSS (they've gone a bit messy since then. hopefully they are commented)
  • Develop a more resilient protection to spambots
    • Add JS? :(
  • Add a toggle to disable the captcha
  • Experiment around captchas to match accessibility needs. I have no idea... :(

This software is mainly developed and maintained by Neil for the Association 42l.

If you like the work done on this project, please consider to donate or join the association. Thank you!

Graphical credits