https://github.com/kizzycode/urlredirect-rust

`url-redirect` is a trivial, headless URL redirection service
https://github.com/kizzycode/urlredirect-rust

Last synced: about 2 months ago
JSON representation

`url-redirect` is a trivial, headless URL redirection service

• Host: GitHub
• URL: https://github.com/kizzycode/urlredirect-rust
• Owner: KizzyCode
• Created: 2023-01-14T02:29:32.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2023-02-17T03:21:38.000Z (over 2 years ago)
• Last Synced: 2025-02-06T04:44:16.683Z (3 months ago)
• Language: Rust
• Size: 24.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE BSD 2-CLAUSE.md

Awesome Lists containing this project

README

        
[![License BSD-2-Clause](https://img.shields.io/badge/License-BSD--2--Clause-blue.svg)](https://opensource.org/licenses/BSD-2-Clause)

[![License MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

[![AppVeyor CI](https://ci.appveyor.com/api/projects/status/github/KizzyCode/UrlRedirect-rust?svg=true)](https://ci.appveyor.com/project/KizzyCode/UrlRedirect-rust)

# `url-redirect`

Welcome to `url-redirect` 🎉

`url-redirect` is a trivial, headless URL redirection service.

## Quickstart

To start the server, simply run `url-redirect`. By default, `url-redirect` expects `config.toml` and `db.toml`. You can

override this behavior by exporting `CONFIG_FILE=/path/to/config.toml` respective `DB_FILE=/path/to/db.toml` into the

environment.

### `config.toml`

```toml

[server]

# The address to listen on

address = "0.0.0.0:8088"

# The connection hart limit; i.e. the amount of threads to spawn at max to process incoming connections

# This field is optional, the default value is 2048

#connection_limit = 2048

```

### `db.toml`

```toml

# The redirect database

# Please note: All redirect paths must start with a leading `/`, like in the example

[redirects]

"/testolope" = "https://example.com"

```

## TODO

 - [ ] Admin-API (always returns 403 for now)