Go to file

usbharu 9d53444edd Merge branch 'refs/heads/develop' into feature/owl # Conflicts: # gradle.properties # gradle/wrapper/gradle-wrapper.jar # hideout-core/build.gradle.kts # hideout-worker/gradle/wrapper/gradle-wrapper.properties # hideout-worker/gradlew # hideout-worker/gradlew.bat # owl/owl-broker/owl-broker-mongodb/build.gradle.kts		2024-05-11 23:02:19 +09:00
.github/workflows	chore(deps): update actions/setup-java action to v4	2024-05-07 13:26:23 +00:00
hideout-core	Merge branch 'refs/heads/develop' into feature/owl	2024-05-11 23:02:19 +09:00
hideout-worker	Merge branch 'refs/heads/develop' into feature/owl	2024-05-11 23:02:19 +09:00
owl	Merge branch 'refs/heads/develop' into feature/owl	2024-05-11 23:02:19 +09:00
.gitignore	feat: KJOBの使用箇所をなくした	2024-05-08 18:55:12 +09:00
LICENSE	chore: ライセンスの追加	2024-02-17 10:45:13 +09:00
README.md	Create README.md	2024-02-16 22:06:15 +09:00
detekt.yml	style: fix lint	2023-12-12 17:52:58 +09:00
gradle.properties	Merge branch 'refs/heads/develop' into feature/owl	2024-05-11 23:02:19 +09:00
hideout.iml	chore: プロジェクト構成を変更	2024-05-04 02:01:06 +09:00
libs.versions.toml	feat: Consumerを読み込んで起動できるように	2024-05-11 19:04:57 +09:00
license-list.xml	chore: ライセンスの確認をするように	2024-02-18 12:06:44 +09:00
renovate.json	Add renovate.json	2024-05-06 08:01:29 +00:00

README.md

Hideout

HideoutはMastodon互換APIを備えたSNSで、ActivityPubに対応し、KotlinとSpring Frameworkを使用して制作されているソフトウェアです。現在は開発中で、SNSとして主要な機能を備えていますが、セキュリティの問題や不安定なテーブル定義などがあるためホストすることはおすすめしません。

特徴

ActivityPubでつながるネットワーク

ActivityPubを実装しているためMastodonやMisskey、Pleromaとつながることができます。また、ActivityPub以外の分散型の通信プロトコルを実装することがあるかもしれません。

Mastodon互換API

OAuth2プロバイダーを含めたほとんどのAPIがMastodonとの互換性を持っているため、既存のMastodon クライアントを使用することができます!また、今後Fedibirdやglitch-soc互換のAPIを実装するかもしれません。

セルフホスト

[!CAUTION] 免責事項

本ソフトウェアを利用して発生したすべての事象に対して開発者は責任を負いません。本ソフトウェアはApache License 2.0を採用しています。

現時点でセルフホストはおすすめしませんが、実験用としてホストすることはできます!

使用技術

Kotlin 強力な言語機能でアプリケーションの安全性を高めます。
Spring Framework (Spring Boot/Spring Security/Spring Web/Spring Data) 豊富な機能と堅牢なライブラリでソフトウェアの基幹部分を担います。
OpenAPI スキーマファーストのエンドポイント自動生成はAPIの安定性を高めます。

要件

起動

Java 21
PostgreSQL 12+
MongoDB(必須でない) 4.4.x+

ビルド

Java 21
Gradle 8+

実験用途として、PostgreSQLはH2DB(バンドル)のPostgreSQL互換モードでも問題ありません。

Java 17でもビルド/起動ができますが、サポートしません。

MongoDBを使用しない場合、構成でhideout.use-mongodbをfalseにする必要があります。

ビルド

今後のリリースでビルド済みjarなどを使う場合はスキップしてください。

gradle bootJar

build/libs/hideout-x.x.x.jarが生成されます。

起動

適切に設定したapplication-dev.ymlなどをクラスパス上に準備します。

devはprodなどに置き換えたり、複数指定することもできます。

java -jar build/libs/hideout-x.x.x.jar --spring.profiles.active=dev

https://spring.pleiades.io/spring-boot/docs/current/reference/html/getting-started.html#getting-started.first-application.executable-jar.gradle

注意事項

本ソフトウェアは開発中です。正常に機能しない場合があります。また、連合先に迷惑をかける事になる可能性があります。DB/設定ファイル/その他リソースなどの利用方法に破壊的な変更が入る可能性があります。