A Fast way to generate a short URI, in others words, it's an URL shortener.

Designed with a high scalability and performance architecture, Furi is a straightforward URL shortener with integrated analytics.

The first layer of access is a CDN platform, in this case, Cloudflare. The major reason for using a CDN is security (e.g., WAF), but the frontend static content can also be cached, improving the performance of the website.

After that, the access is sent to a Web Server. Its responsibilities include serving the frontend static files, acting as a load balancer for the N instances of the Shortener API (in this case, 2 instances), and proxying access to the Analytics API.

The Shortener API creates and stores the short and original URLs into database (a SQL-like database) and uses a cache layer (key-value database) to improve response performance.

When a user accesses a short URL, metrics are collected from the user and sent to a message broker to be stored in the analytics database.

The Analytics API provides the frontend with the user metrics collected when a short URL is accessed. Basically, each short URL has its own user metrics.

The project uses a simple architecture that can be scaled horizontally easily. To scale the process of accessing and shortening URLs, just instantiate more instances of the Shortener API and add them to the load balancer.

More details about each layer of the project can be found in the respective directory.

The technologies that this project uses or has been written in are:

• Shortener API: Rust
• Analytics API: Rust
• FrontEnd: Vue.js
• Web Server: Jequi
• Cache Database: Redis
• URLs Database: Postgres
• Analytics Database: Clickhouse
• Message Broker: Redpanda
• CDN: Cloudflare

Clone the repository.

git clone [email protected]:Mewbi/furi.git

Set every required configuration and environment file. (Remember to edit the file content)

cp .env-example .env # Database config
cp ./furi/config-example.toml ./furi/config.prod.toml # Furi API config
cp ./frontend/.env-example ./frontend/.env # Frontend config

Generate SSL certificates and place them into the certs directory. If you are using the default web server configuration, the certificate files must be named furi-cert.pem and furi-key.key. For more details about this, refer to the certs directory.

Set the GeoIP database files into the geoip directory. The project uses the MaxMind GeoIP database, and the default filenames expected are GeoLite2-City.mmdb and GeoLite2-Country.mmdb. If your files have different names, you can change the Furi config file to match the correct database names. For more details about the GeoIP database, refer to the geoip directory.

Then start all services using Docker Compose:

docker compose up -d

The web server will start by default in port 8443.

A tip is edit your /etc/hosts to point every service hostname to your localhost, so you can simulate access using the domain name like:

127.0.0.1 redpanda redis postgres clickhouse furi.live www.furi.live

To access the clickhouse, execute

docker exec -it furi_clickhouse clickhouse-client

To access the postgres, execute

docker exec -it furi_postgres psql -U <user> -d <database>

It is possible to manually send data to a redpanda topic using kafkacat:

echo '{"key":"key1", "value":"value1"}' | kafkacat -b redpanda:9092 -t my-topic -P

To consume a redpanda topic from beginning

kcat -b redpanda:9092 -t my-topic -C -o beginning

Furi is an open-source project, so contributions are welcome!

Feel free to share suggestions for new features, improvements, and bug fixes.