Скачать smrs - Скачать исходный код smrs

smrs

Другие категории

1.0.0

Скачать

SMRS

Этот репозиторий содержит исходный код для CGI-диспетчерского шортенера, написанного в Rust. Вы можете разместить этот проект в своей среде, используя приведенные ниже инструкции.

Почему SMRS

Ссылки в Интернете становятся все более раздутыми. Друзья не присылают друзьям многострочные ссылки! Тем не менее, сторонние услуги ссылки являются кошмаром конфиденциальности. Но в основном я хотел выучить ржавчину, и это казалось простым проектом.

Функции

Этот проект должен быть минимальным и простым. Пользовательские функции:

Минимальный, отзывчивый пользовательский интерфейс
Простой API (см. Ниже)
Генерирует короткие URL-адреса с тремя слоями
Позволяет, если вам следует выбрать короткий URL -адрес

Функции программного обеспечения:

Мы позволяем реальному веб -серверу (APACHE2) обрабатывать завершение TLS и статическое обслуживание файла.
Мы выполняем двоичный файл ржавчины через CGI, чтобы реализовать API и взаимодействовать с SQLite.
Фронт-энд использует SSI Apache для отображения статических страниц с общим заголовком.
Мы используем немного Alpine.js для интерактивных элементов.
Там нет входа в систему, но вы можете увидеть и установить собственные куки с сеансом, чтобы отслеживать ваши сокращенные ссылки.

Скриншот

Установка

Рекомендуемый способ установить этот проект - использовать изображение Docker. Однако, особенно если вы просто хотите использовать API, вы также можете установить двоичный файл непосредственно на своем собственном веб -сервере.

Через Docker

Во -первых, подготовьте каталог для файла данных. Он должен принадлежать пользователю с UID 82 (www-data на Debian/Ubuntu).

$ mkdir -p ${STORAGE} /smrs/data
$ sudo chown 82:82 ${STORAGE} /smrs/data

Вот пример Docker-Compose Stanza:

  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

Это использует Traefik в качестве обратного прокси для контейнера.

Через бинарный

Клонировать репозиторий и построить бинарный:

$ cargo build --release

Поместите target/release/smrs куда -нибудь на пути вашего веб -сервера. Вам нужно будет настроить ваш сервер для запуска двоичного файла в виде скрипта CGI. Я использую apache2 внутри контейнера. Файл конфигурации находится в conf/smrs.conf в этом репо.

API

Двоина в ржавчине реализует следующие конечные точки API:

GET /session - возвращает текущий сеанс как { session: string }
POST /session - устанавливает файл cookie сеанса в заданное значение { session: string }
POST /save - сохраняет URL -адрес в заданном токен (если еще не используется) { url: string, token: string }
GET /to/<token - перенаправление на URL -адрес в данном токене или возвращает 404
GET /list - Возвращает список всех токенов и URL -адресов, сохраненных текущим session как { links: [{ token: string, url: string, created_at: i32 }]
POST /forget - отмечает заданный токен как удаленный, или 404 : { token: string }

Разработка

Чтобы запустить этот проект локально, вы можете установить инструмент cargo make и запустить задачу devenv :

$ cargo make devenv

Среда DEV будет доступна по адресу Localhost: 8000/. Это будет связывать DIR htdocs в контейнер, чтобы вы могли просто итерации по коду и перезагрузить. Чтобы итерация на бинарном ржавчине, вы можете запустить задачу iter , которая построит двоичный файл локально и копировать в контейнер:

$ cargo make iter

Получить запросы

Добро пожаловать! Но имейте в виду, что этот проект должен быть минимальным. Я не буду принимать PR, которые добавляют слишком много зависимостей или функций, которые мне не нужны.