Skip to content
/ felm Public

Discordで送信されたメッセージへのリンクを展開します

License

Notifications You must be signed in to change notification settings

aqyuki/felm

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

b0375ef · Jan 5, 2025

History

23 Commits
Dec 24, 2024
Dec 24, 2024
Dec 29, 2024
Dec 24, 2024
Dec 23, 2024
Dec 23, 2024
Dec 24, 2024
Dec 29, 2024
Dec 29, 2024
Dec 24, 2024
Dec 23, 2024
Jan 4, 2025
Jan 4, 2025
Dec 24, 2024
Dec 24, 2024
Dec 24, 2024
Jan 5, 2025
Dec 24, 2024

Repository files navigation

📖 README

FelmはDiscordで送信されたメッセージへのリンクを展開するBotです。

✨ Features

FelmはDiscordのテキストチャットに送信されたメッセージリンクのうち 同一サーバーかつNSFWチャンネルでないチャンネルに送信されたメッセージを対象に展開し、もとのメッセージにリプライします。

🚀 Deployment

Important

Felmは現在Docker経由でのデプロイのみ公式にサポートしています。

docker composeコマンドが使用できることを確認してください。

Warning

docker compose v1は現在非推奨となっています。
公式ドキュメントをもとにdocker compose v2を使用してください。

以下の内容のcompose.ymlを作成した後、.envファイルにて必要な環境変数を指定してください。

services:
  bot:
    container_name: felm
    image: ghcr.io/aqyuki/felm:latest
    env_file:
      - .env
    restart: unless-stopped

.envで指定することができる環境変数は次のとおりです。

環境変数名 内容 既定値 必須
FELM_TOKEN Discord Botのトークンを指定してください。 ---
FELM_TIMEOUT ハンドラーのタイムアウトを設定できます。 5s

📄 Licese

このプロジェクトは、MITライセンスのもとで公開されています。ライセンスの概要はLicense.txtを確認してください。 また、このプロジェクトで利用しているOSSのライセンス等はNOTICE.mdを参照してください。