smrs

SMRS

このリポジトリには、Rustで記述されたCGIディスパッチリンクショートナーのソースコードが含まれています。以下の指示を使用して、このプロジェクトを独自の環境でホストできます。

なぜSMRS

ウェブ上のリンクはますます肥大化しています。友達は友達のマルチラインリンクを送信しません！ただし、サードパーティリンクサービスはプライバシーの悪夢です。しかし、主に、私は錆を学びたかったのですが、これは単純なプロジェクトのように思えました。

特徴

このプロジェクトは、最小限でシンプルであることを意図しています。ユーザー機能：

• 最小限で応答性の高いUI
• 簡単なAPI（以下を参照）
• 3ワードの短いURLを生成します
• オプションで短いURLを選択できます

ソフトウェア機能：

• 実際のWebサーバー（APACHE2）がTLS終了と静的ファイルのサービングを処理できるようにします。
• CGIを介してRustバイナリを実行してAPIを実装し、SQLiteと対話します。
• フロントエンドでは、ApacheのSSIを使用して、共通のヘッダーで静的ページをレンダリングします。
• インタラクティブな要素には、Alpine.jsを少し使用します。
• ログインはありませんが、短縮リンクを追跡するために、独自のセッションCookieを確認して設定できます。

スクリーンショット

インストール

このプロジェクトをインストールする推奨方法は、Docker画像を使用することです。ただし、特にAPIを使用するだけの場合は、独自のWebサーバーにバイナリを直接インストールすることもできます。

Docker経由

まず、データファイルのディレクトリを準備します。 UID 82（debian/ubuntuのwww-data）を持つユーザーが所有する必要があります。

$ 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をコンテナポート8000​​の逆プロキシとして使用します。独自の逆プロキシを使用するか、ポートを直接露出させることができます。

バイナリ経由

リポジトリをクローンし、バイナリを構築します。

$ cargo build --release

ファイルtarget/release/smrsをWebサーバーのパスのどこかに配置します。 CGIスクリプトとしてバイナリを実行するようにサーバーを構成する必要があります。コンテナ内でapache2を使用します。構成ファイルは、このレポのconf/smrs.confにあります。

API

さび的バイナリは、次のAPIエンドポイントを実装しています。

• GET /session現在のセッションを{ session: string }として返します
• POST /session - セッションクッキーを指定値に設定します{ session: string }
• POST /save - 指定されたトークンでURLを保存します（まだ使用していない場合） { url: string, token: string }
• GET /to/<token指定されたトークンでURLにリダイレクトするか、 404を返します
• GET /list - 現在のsessionで保存されたすべてのトークンとURLのリストを{ links: [{ token: string, url: string, created_at: i32 }]として返します。
• POST /forget - 指定されたトークンを削除または404 ： { token: string }としてマークします

発達

このプロジェクトをローカルに実行するには、 cargo makeツールをインストールしてdevenvタスクを実行できます。

$ cargo make devenv

開発環境はLocalHost：8000/でアクセスできます。これにより、 htdocs dirをコンテナにマウントするため、コードを反復してリロードできます。 Rustバイナリを反復するには、 iterタスクを実行します。これにより、バイナリをローカルに構築し、コンテナにコピーします。

$ cargo make iter

リクエストをプルします

いらっしゃいませ！ただし、このプロジェクトは最小限のものであることを意図していることに留意してください。私が望んでいない依存関係や機能が多すぎるPRを受け入れません。

ライセンス

mit。お気軽にフォークして、あなたがやりたいことをしてください。