Skip to content

Latest commit

 

History

History
158 lines (104 loc) · 6.85 KB

README.ja-jp.md

File metadata and controls

158 lines (104 loc) · 6.85 KB
Raw


Pingvin Share

READMEを別の言語で読む: Spanish, English, Simplified Chinese, 日本語

Pingvin Share は、セルフホスト型のファイル共有プラットフォームであり、WeTransfer、ギガファイル便などの代替プラットフォームです。

✨ 特徴的な機能

  • リンクを用いたファイル共有
  • ファイルサイズ無制限 (ストレージスペースの範囲内で)
  • 共有への有効期限の設定
  • 訪問回数の制限とパスワードの設定により共有を安全に保つ
  • メールでリンクを共有
  • ClamAVと連携して、ウイルスチェックが可能

🐧 Pingvin Shareについて知る

⌨️ セットアップ

注意: Pingvin Shareは、早期段階であり、バグが含まれている場合があります。

Dockerでインストール (おすすめ)

  1. docker-compose.ymlファイルをダウンロード
  2. docker-compose up -dを実行

Webサイトは、http://localhost:3000でリッスンされます。これでPingvin Shareをお使い頂けます🐧!

スタンドアローンインストール

必要なツール:

  • Node.js >= 16
  • Git
  • pm2 Pingvin Shareをバックグラウンドで動作させるために必要
git clone https://github.com/stonith404/pingvin-share
cd pingvin-share

# 最新バージョンをチェックアウト
git fetch --tags && git checkout $(git describe --tags `git rev-list --tags --max-count=1`)

# バックエンドを開始
cd backend
npm install
npm run build
pm2 start --name="pingvin-share-backend" npm -- run prod

#フロントエンドを開始
cd ../frontend
npm install
npm run build
pm2 start --name="pingvin-share-frontend" npm -- run start

Webサイトは、http://localhost:3000でリッスンされます。これでPingvin Shareをお使い頂けます🐧!

連携機能

ClamAV (Dockerのみ)

ClamAVは、共有されたファイルをスキャンし、感染したファイルを見つけた場合に削除するために使用されます。

  1. ClamAVコンテナをDocker Composeの定義ファイル(docker-compose.ymlを確認)に追加し、コンテナを開始してください。
  2. Dockerは、Pingvin Shareを開始する前に、ClamAVの準備が整うまで待機します。これには、1分から2分ほどかかります。
  3. Pingvin Shareのログに"ClamAV is active"というログが記録されます。

ClamAVは、非常に多くのリソースを必要とします、詳しくはリソースをご確認ください。

追加情報

新しいバージョンへのアップグレード

Pingvin Shareは早期段階のため、アップグレード前に必ずリリースノートを確認して、アップグレードしても問題ないかどうかご確認ください。

Docker

docker compose pull
docker compose up -d

スタンドアローン

  1. アプリを停止する

    pm2 stop pingvin-share-backend pingvin-share-frontend

  2. git cloneのステップを除いて、インストールガイドをくり返してください。

    cd pingvin-share

# 最新バージョンをチェックアウト
git fetch --tags && git checkout $(git describe --tags `git rev-list --tags --max-count=1`)

# バックエンドを開始
cd backend
npm run build
pm2 restart pingvin-share-backend

#フロントエンドを開始
cd ../frontend
npm run build
pm2 restart pingvin-share-frontend

設定

管理者のダッシュボード内の「設定」ページから、Pingvin Shareをカスタマイズできます。

環境変数

インストール時の特定の設定で、環境変数を使用できます。次の環境変数が使用可能です:

バックエンド
変数名 デフォルト値 説明
PORT 8080 バックエンドがリッスンするポート番号
DATABASE_URL file:../data/pingvin-share.db?connection_limit=1 SQLiteのURL
DATA_DIRECTORY ./data データを保管するディレクトリ
CLAMAV_HOST 127.0.0.1 ClamAVサーバーのIPアドレス
CLAMAV_PORT 3310 ClamAVサーバーのポート番号
フロントエンド
変数名 デフォルト値 説明
PORT 3000 フロントエンドがリッスンするポート番号
API_URL http://localhost:8080 フロントエンドからアクセスするバックエンドへのURL

🖤 コントリビュート

翻訳

Pingvin Shareをあなたが使用している言語に翻訳するお手伝いを募集しています。 Crowdin上で、簡単にPingvin Shareの翻訳作業への参加が可能です。

あなたの言語がありませんか？ 気軽にリクエストしてください。

翻訳中に問題がありましたか？ ローカライズに関するディスカッションに是非参加してください。

プロジェクト

Pingvin Shareへのコントリビュートをいつでもお待ちしています！ コントリビューションガイドを確認して、是非参加してください。