alf.io

アルフアイオ

オープンソースのチケット予約システム。

Alf.io ([ˈalfjo]) は、顧客のプライバシー、セキュリティ、公正な価格設定ポリシーを重視するイベント主催者向けに開発された、無料のオープンソースのイベント出席管理システムです。

目次

1. 前提条件
2. スプリングプロファイル
3. 開発モードで実行する
4. alf.io への貢献
5. 更新する依存関係を確認する
6. Dockerコンテナの実行
7. 貢献者

前提条件

alf.io をビルドして実行するには、Java バージョン17 (Oracle、OpenJDK、またはその他のディストリビューションなど) をインストールしておく必要があります。ビルドプロセスには JDK が必要であることに注意してください。

PostgreSQL バージョン 10 以降。

さらに、テーブルを作成および使用するデータベース ユーザーは「SUPERUSER」であってはなりません。そうしないと、行セキュリティ ポリシー チェックが適用されません。

注記

Alf.io v2 の作業が開始されているため、このブランチには不安定でテストされていないコードが含まれている可能性があります。 alf.io を自分でビルドしてデプロイする場合は、リリースされたバージョンから開始してください。

スプリングプロファイル

以下のスプリングプロファイルがあります

• dev : 開発モードを有効にする
• spring-boot : spring-boot によって起動されるときに追加されます
• demo : デモ モードを有効にすると、管理者のアカウントがその場で作成されます
• disable-jobs : ジョブを無効にする
• jdbc-session : ユーザーセッションをデータベースに永続化します

開発モードで実行する

グラドルビルド

このビルドには、Gradle ラッパーのコピーが含まれています。プロジェクトをビルドするためにシステムに Gradle がインストールされている必要はありません。たとえば、適切なタスクとともにラッパーを実行するだけです。

 ./gradlew clean

複数のプロファイルで実行する

コマンド ラインでプロジェクト プロパティを指定する必要があります。たとえば、

 ./gradlew -Pprofile=dev :bootRun

ローカルの「bootRun」タスクには次の前提条件があります。

• localhost:5432 上で稼働している PostgreSQL (バージョン 10 以降) インスタンス
• パスワードを持つpostgresユーザー:パスワード
• alfioという名前のデータベース

 docker run -d --name alfio-db -p 5432:5432 -e POSTGRES_PASSWORD=password -e POSTGRES_DB=alfio --restart unless-stopped postgres 

alf.io が開始されると、データベース内に必要なテーブルがすべて作成され、http://localhost:8080/admin で利用可能になります。デフォルトのユーザー名adminと、コンソールに表示されたパスワードを使用してログインできます。

次のコマンドを実行すると、サポートされているすべての Gradle タスクのリストを取得できます。

 ./gradlew tasks --all

次のファイルを作成し、1 行に 1 つのプロパティを追加することで、追加のシステム プロパティを構成できます (必要な場合)。

 vi custom.jvmargs

このファイルには機密情報 (Google マップのプライベート API キーなど) が含まれている可能性があるため、git によって自動的に無視されることに注意してください。

デバッグ用

Custom.jvmargs に-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005新しい行を追加します。

alf.io への貢献

Gradle プロジェクトを Intellij と Eclipse にインポートすると、両方とも機能します。

注:

• このプロジェクトは Project Lombok を使用します。 IDE に統合するには、対応する Lombok プラグインをインストールする必要があります。
• このプロジェクトでは、TestContainers を使用して、実際の PostgreSQL データベースに対して統合テストを実行します。構成が要件を満たしていることを確認してください

Podman を使用して TestContainers を構成する方法 (Fedora 34)

TestContainers はコンテナーを管理するために Docker ソケットを想定しているため、次のことを行う必要があります (詳細については元の問題を参照してください)。

2 つの環境を定義します。変数：

 export TESTCONTAINERS_RYUK_DISABLED=true
export DOCKER_HOST=unix:///run/user/1000/podman/podman.sock

そして、別のコンソールで実行します。

 podman system service -t 0

注意すべき点:

• 理由は不明ですが、podman が不足しているイメージを初めてダウンロードするときに、testcontainers が失敗します。もう一度実行すると機能します。
• 理論的には、systemd + ソケットのアクティブ化によりサービスが自動的に開始されるはずですが、現時点ではそれを機能させることができませんでした。

更新する依存関係を確認する

./gradlew dependencyUpdates

Dockerコンテナの実行

コンテナー イメージは https://hub.docker.com/r/alfio/alf.io/tags で入手できます。

alf.io は、Docker Compose (開発モード) で実行することもできます。

 docker-compose up

Docker compose を使用して本番環境で alf.io を実行することは、正式にはサポートされていません。ただし、そうする場合は、いくつかの変更を加える必要があります。

• docker-compose.ymlファイル内のalfioサービスのコメントを解除します。
• .envファイル内のサービスのユーザーとパスワードを確認してください。
• SSL 終了処理 (例: tutum/haproxyなど) 443 -> 8080

alf.io アプリケーションをテストする

• alfio ログを確認します: docker logs alfio
• 管理者パスワードを安全な場所にコピーします
• Docker コンテナの IP を取得します: (Mac/Windows のみ、Linux ではプロキシがパブリック IP に直接バインドされます)
  • Mac/Windows 上のboot2docker IP
• https://DOCKER_IP/adminでブラウザを開きます。
• ユーザー admin とコピーしたパスワードを入力します

新しいバージョンの alfio/alf.io Docker イメージを生成します

アプリケーションと Dockerfile をビルドする

 ./gradlew distribution

あるいは、Docker (実験的) を使用することもできます。

 docker run --rm -u gradle -v "$PWD":/home/gradle/project -w /home/gradle/project gradle:7.0.0-jdk11 gradle --no-daemon distribution -x test

現時点では、上記のコマンドは自動テストを実行せずにビルドを実行することに注意してください。ご自身の責任でご使用ください。

Docker イメージを作成します。

 docker build -t alfio/alf.io ./build/dockerize

同梱のAppleWWDRCAG4.cerについて

src/main/resources/alfio/certificates/AppleWWDRCAG4.cer の証明書は、https://github.com/ryantenney/passkit4j#usage 機能用にインポートされました。有効期限は 2030 年 10 月 12 日 (YYYY-MM-DD - https://www.apple.com/certificateauthority/ 時点) となります。

貢献者

コードの貢献者

このプロジェクトは、貢献してくださったすべての人々のおかげで存在します。

翻訳貢献者 (POEditor)

POEditor で私たちを助けてくれた翻訳者の方々にも大きな「ありがとう」を送ります。

(明示的な同意を得た場合にのみ、完全な名前/プロフィールが表示されます)

言語	名前	ギットハブ	ツイッター
オランダ語 (nl)	マティス
トルコ語 (tr)	ディレク
スペイン語 (エス)	マリオ・ヴァローナ	@mvarona	@MarioVarona
スペイン語 (エス)	セルジ・アルマル	@サルマル	@sergialmar
スペイン語 (エス)	ジェレミアス
ブルガリア語 (BG)	マーティン・ジェコフ	@マーティン03	@MartensZone
ポルトガル語 (pt)	ヒューゴ
スウェーデン語 (SV)	ヨハン
ルーマニア語 (ro)	ダニエル
ポーランド語 (pl)	パヴェル
デンマーク語 (da)	スネ

翻訳は完了したがまだ統合されていない (WIP)

言語	名前	ギットハブ	ツイッター
日本語 (jp)	マーティン
中国語 (台湾) (cn_TW)	リン・ユーチェン

スポンサー

このプロジェクトは以下によって後援されています。

オープンソース プログラム

資金提供者

財政的に貢献して、コミュニティの維持にご協力ください。 [貢献する]

個人

組織

あなたの組織でこのプロジェクトをサポートしてください。あなたのロゴが Web サイトへのリンクとともにここに表示されます。 [貢献する]