shorty
High-performance link shortener written in Rust
💾
Hosting
In addition to being easy to build from source, shorty is available as a Docker image on Docker Hub.
🏁
Prerequisites
🌎
Environment variables
DB_URL- a valid Redis URL, e.g. redis://localhost:1234TOKEN- your desired API token; only required if you're using the API (described below).
⚙️
Server configuration
Configure the server through environment variables or Rocket.toml; check this guide for more information. shorty runs on port 8000 by default.
📡
API
Use shorty's API to add/remove links.
Authentication
Provide your TOKEN (described above) as a bearer token, so set the Authorization header to Bearer <token>. Example: curl -H "Authorization: Bearer token1234" http://localhost:8000/api/example/route
Requests
POST requests must all contain JSON payloads. x-www-form-urlencoded is not supported.
Responses
All responses are JSON, and follow this rough schema:
{
// False if something went wrong
"ok": true,
// Will be a string if something went wrong
"err": null,
"data": {
// Response data here...
}
}
➕
POST /api/link - create or update a named link
Options:
url(string, required) - The URL the redirect to.name(string, optional) - The link's name. Leave blank to randomly generate a 10-character ID.public(bool, optional) - Whether or not to display this link on the public links page; coming soon
/ is a special value for <name> that creates a redirect for the root URL.
❌
DELETE /api/link/<name> - delete a named link
example: curl -X DELETE http://localhost:8000/api/link/gh
<name> parameter if necessary; / will become %2F
🚗
Roadmap
- UI
- Redirect code configuration
3 Oct 8, 2023
2 Mar 28, 2022
5 Jul 26, 2023
259 Dec 19, 2022
30 Dec 17, 2022
9 Dec 25, 2022
1.3k Jan 2, 2023
2 Sep 14, 2022
12 Nov 7, 2022
80 Feb 22, 2023
112 Apr 7, 2023
4 May 7, 2023
11 Oct 27, 2023
5 Apr 30, 2024
15 Jun 10, 2022
2 Apr 27, 2022
30 Apr 12, 2024
259 Jan 6, 2023
4 Nov 16, 2022
7 Apr 21, 2024