https://github.com/igor47/smrs
a cgi-dispatched link shortener in rust
https://github.com/igor47/smrs
apache2 cgi minimal rust self-hosted
Last synced: about 1 year ago
JSON representation
a cgi-dispatched link shortener in rust
- Host: GitHub
- URL: https://github.com/igor47/smrs
- Owner: igor47
- License: mit
- Created: 2021-03-07T22:03:59.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-08-30T16:29:20.000Z (over 2 years ago)
- Last Synced: 2025-03-14T18:54:28.395Z (about 1 year ago)
- Topics: apache2, cgi, minimal, rust, self-hosted
- Language: Rust
- Homepage:
- Size: 452 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SMRS
This repository contains the source code for a cgi-dispatched link shortener written in rust.
You can host this project in your own environment using the instructions below.
## Why SMRS
Links on the web are getting increasingly more bloated.
Friends don't send friends multi-line links!
However, third-party link services are a privacy nightmare.
But mainly, I wanted to learn Rust and this seemed like a simple project.
## Features
This project is meant to be minimal and simple.
User features:
* Minimal, responsive UI
* Simple API (see below)
* Generates three-word short urls
* Allows you to optionally pick your short url
Software features:
* We allow a real web server (Apache2) to handle TLS termination and static file serving.
* We execute the rust binary via CGI to implement the API and interact with [sqlite](https://sqlite.org/index.html).
* The front-end uses Apache's [SSIs](https://httpd.apache.org/docs/current/howto/ssi.html) to render static pages with a common header.
* We use a little bit of [Alpine.js](https://alpinejs.dev/) for interactive elements.
* There is no login, but you can see and set your own session cookie to keep track of your shortened links.
## Screenshot
## Installation
The recommended way to install this project is to use the docker image.
However, especially if you just want to use the API, you can also install the binary directly in your own web server.
### Via Docker
First, prepare a directory for the data file.
It must be owned by the user with UID 82 (www-data on Debian/Ubuntu).
```bash
$ mkdir -p ${STORAGE}/smrs/data
$ sudo chown 82:82 ${STORAGE}/smrs/data
```
Here's an example docker-compose stanza:
```yaml
smrs:
image: ghcr.io/igor47/smrs:v0.1.1
restart: unless-stopped
container_name: smrs
labels:
- "traefik.enable=true"
- "traefik.http.routers.smrs.rule=Host(`example.com`,`www.example.com`)"
- "traefik.http.routers.smrs.tls=true"
- "traefik.http.routers.smrs.tls.certresolver=letsencrypt"
- "traefik.http.routers.smrs.entrypoints=https"
- "traefik.http.services.smrs.loadbalancer.server.port=8000"
volumes:
- ${STORAGE}/smrs/data:/smrs/data
```
This uses Traefik as a reverse proxy to the container port 8000.
You can use your own reverse proxy, or expose the port directly.
### Via Binary
Clone the repository and build the binary:
```bash
$ cargo build --release
```
Put the file `target/release/smrs` somewhere in your web server's path.
You'll need to configure your server to run the binary as a CGI script.
I use `apache2` inside the container.
The config file is in [conf/smrs.conf](https://github.com/igor47/smrs/blob/master/conf/smrs.conf) in this repo.
## API
The rust binary implements the following API endpoints:
* `GET /session` - returns the current session as `{ session: string }`
* `POST /session` - sets the session cookie to the given value `{ session: string }`
* `POST /save` - saves the URL at the given token (if not already in-use) `{ url: string, token: string }`
* `GET /to/