servekit

サーブキット

⚡️ 静的ファイルを提供するためのマイクロ HTTP サーバー。

モチベーション

フロントエンドの静的ファイル、バックエンド サーバー、nigix (リバース プロキシ) が Docker コンテナ内で実行されていると想像してください。この時点で問題が発生します。静的ファイルをリバース プロキシに提供するにはどうすればよいでしょうか。フロントエンドコンテナに nigix をもう 1 つインストールします。これはやりすぎです。これがServekitが作られた理由です。

クイックスタート

ローカルから始める

リリースページから最新のバイナリを取得します

./servekit # serving ./static directory 

Docker から始める

 FROM cjaewon/servekit:2.0.0
COPY ./static /static

EXPOSE 3000

docker compose から始める

 version : " 3.8 "

services :
  app :
    image : cjaewon/servekit:2.0.0
    volumes :
      - ./static:/static
    environment :
      - SERVEKIT_SERVER_PORT : :3000
      - SERVEKIT_SERVER_PATH : ./static
      - SERVEKIT_SERVER_404 : none
      - SERVEKIT_SERVER_OVERVIEW : false 

構成

設定ファイルあり

構成ファイルまたは環境変数を使用して、ポート、サービス提供パスなどを設定できます。 Servekit は$HOMEにある.servekit.tomlスキャンします.ディレクトリ

 # ## Config file sample
[ server ]
  port = " :3000 " # :3000 (default)
  path = " ./static " # ./static (default)
  
  404 = " none " # none (default), html file
  # if you are using client side rendering, you have to change none to index.html

  overview = false # false (default), true
  # if your are using true, directory's file list will be show
  # and, it can only true when 404 config is "none"

環境変数あり

dockerでは以下のように環境変数を設定できます。 (未定義の設定ではデフォルト値が使用されます)

 ENV SERVEKIT_SERVER_PORT :3000
ENV SERVEKIT_SERVER_PATH ./static
ENV SERVEKIT_SERVER_404 none
ENV SERVEKIT_SERVER_OVERVIEW false