Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cjdenio/shorty
High-performance link shortener
https://github.com/cjdenio/shorty
diesel-rs docker link-shortener link-shortener-api postgres postgresql rocket-rs rust self-hosted
Last synced: about 16 hours ago
JSON representation
High-performance link shortener
- Host: GitHub
- URL: https://github.com/cjdenio/shorty
- Owner: cjdenio
- Created: 2021-02-19T19:38:42.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-02-05T06:17:02.000Z (almost 2 years ago)
- Last Synced: 2023-03-05T14:57:15.866Z (over 1 year ago)
- Topics: diesel-rs, docker, link-shortener, link-shortener-api, postgres, postgresql, rocket-rs, rust, self-hosted
- Language: Rust
- Homepage: https://clb.li
- Size: 118 KB
- Stars: 52
- Watchers: 4
- Forks: 4
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# shorty
đ High-performance link shortener written in Rust
[](https://heroku.com/deploy?template=https://github.com/cjdenio/shorty)
## đž Hosting
In addition to being easy to build from source (`cargo build --release`), shorty is available as a Docker image on both [Docker Hub](https://hub.docker.com/r/cjdenio/shorty) and [GitHub Container Registry](https://ghcr.io/cjdenio/shorty).
### đ Prerequisites
- Some sort of Docker or Rust-compatible hosting. [clb.li](https://clb.li) runs on [CapRover](https://caprover.com), for example, but [Heroku](https://heroku.com) is a good free option.
- A Postgres database (Heroku Postgres is your friend if you're running shorty on Heroku)
### đ Environment variables
- `DATABASE_URL` - a valid Postgres URL, e.g. postgres://user:password@localhost:5432/database _(automatically set when using Heroku Postgres)_
- `TOKEN` - your desired API token; only required if you're using the API (described below).
- `PORT` - Change the port the server listens on; defaults to `8000`
## đ Public links page
There's a page available at /links that displays all links with the `public` field set to `true`.
Check out [clb.li/links](https://clb.li/links) for an example!
If you _haven't_ set up a redirect for the root URL, it'll show this page as well.
## đĄ API
You can use shorty's API to add/remove links. No UI is available quite yet, but will be soon!
### Authentication
Provide your `TOKEN` (described above) as a bearer token, so set the `Authorization` header to `Bearer `. 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:
```jsonc
{
// False if something went wrong
"ok": true,
// Will be a string if something went wrong
"err": null,
"data": {
// Response data here...
}
}
```
---
### đ `GET /api/link` - list all links
This method has no options.
---
### â `POST /api/link` - create 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 5-character ID.
- `public` (bool, optional) - Whether or not to display this link on the public links page.
- `description` (string, optional) - This field is displayed on the public links page (if `public` is set to `true`)
âšī¸ Note:
**`/` and `root` are special values for `` that create redirects for the root URL. You may use either.**
---
### đ `PATCH /api/link/` - update a named link
Options:
This method takes the same parameters as `POST /api/link`, except they're all optional.
âšī¸ Note:
**Please URL encode the `` parameter if necessary; `/` will become `%2F`**
---
### â `DELETE /api/link/` - delete a named link
example: `curl -X DELETE http://localhost:8000/api/link/gh`
âšī¸ Note:
**Please URL encode the `` parameter if necessary; `/` will become `%2F`**
---
## đ Roadmap
Check the [issues page](https://github.com/cjdenio/shorty/issues) for more information on in-progress features!