-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
8 changed files
with
564 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
--- | ||
title: ようこそHolloへ! | ||
description: >- | ||
Holloは1人用の連合マイクロブログソフトウェアです。 | ||
template: splash | ||
hero: | ||
tagline: >- | ||
1人用の連合マイクロブログソフトウェア。 | ||
ActivityPub、Mastodon互換API、CommonMark、Misskeyスタイルの引用をサポート。 | ||
image: | ||
light: ../../../assets/logo-black.svg | ||
dark: ../../../assets/logo-white.svg | ||
actions: | ||
- text: Holloとは? | ||
link: /ja/intro | ||
icon: right-arrow | ||
variant: secondary | ||
- text: インストール | ||
link: /ja/install/railway | ||
icon: rocket | ||
variant: primary | ||
- text: 公式インスタンス | ||
link: https://hollo.social/@hollo | ||
icon: external | ||
variant: minimal | ||
--- | ||
|
||
import { Card, CardGrid } from "@astrojs/starlight/components"; | ||
|
||
<CardGrid> | ||
<Card title="1人用" icon="seti:lock"> | ||
Holloは1人用に設計されているため、 | ||
インスタンスを所有し、データに完全な制御権を持つことができます。 | ||
個人用のマイクロブログ、ノート、日記に最適です。 | ||
</Card> | ||
<Card title="複数アカウント" icon="seti:folder"> | ||
Holloは1人用に設計されていますが、 | ||
同じインスタンスで複数のアカウントを持つことができます。 | ||
アカウント間の切り替えも簡単で、 | ||
各アカウントには独自のプロフィール、投稿、設定を持ちます。 | ||
</Card> | ||
<Card title="Mastodon互換API" icon="puzzle"> | ||
Holloには独自のウェブインターフェースがありません。 | ||
代わりに、[Mastodon API]と互換性があり、 | ||
どんなMastodon互換クライアントアプリでも | ||
Holloを利用することができます。 | ||
|
||
[Mastodon API]: https://docs.joinmastodon.org/methods/ | ||
</Card> | ||
<Card title="CommonMark" icon="seti:markdown"> | ||
[CommonMark](通称Markdown)で投稿を作成できます。 | ||
そのようにして作成した投稿は、 | ||
フェディバース(fediverse)の他のソフトウェアでもうまく表示されます。 | ||
また、投稿ごとに最大4,096文字まで作成できます。 | ||
|
||
[CommonMark]: https://commonmark.org/ | ||
</Card> | ||
<Card title="Misskeyスタイルの引用" icon="comment"> | ||
Holloは[Misskey]スタイルの引用機能をサポートしているため、 | ||
他の投稿を引用して自分の投稿に含めることができます。 | ||
これはMisskey、[Akkoma]、[Fedibird]、[Threads]など、 | ||
Misskeyスタイルの引用をサポートする他のフェディバースソフトウェアとも互換性があります。 | ||
|
||
[Misskey]: https://misskey-hub.net/ja/ | ||
[Akkoma]: https://akkoma.social/ | ||
[Fedibird]: https://github.com/fedibird/mastodon | ||
[Threads]: https://www.threads.net/ | ||
</Card> | ||
<Card title="FedifyとBunベース" icon="bun"> | ||
HolloはTypeScript向けのActivityPubサーバーフレームワークである[Fedify]で作られており、 | ||
Node.jsの代替となる超高速JavaScriptランタイムである[Bun]上で動作します。 | ||
|
||
[Fedify]: https://fedify.dev/ | ||
[Bun]: https://bun.sh/ | ||
</Card> | ||
</CardGrid> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
--- | ||
title: Dockerでデプロイ | ||
description: HolloをDockerでデプロイする方法を説明します。 | ||
--- | ||
|
||
Holloは[GitHub Packages]で公式のDockerイメージを提供しています。 | ||
そのイメージをローカルマシンでHolloをデプロイできます: | ||
|
||
~~~~ sh frame="none" | ||
docker pull ghcr.io/dahlia/hollo:latest | ||
~~~~ | ||
|
||
Holloを実行するには、PostgreSQLのデータベースとメディアを保存するためのS3互換のオブジェクトストレージが必要です。 | ||
[PostgreSQL]の公式のDockerイメージとS3互換のオブジェクトストレージである[MinIO]を使うことができます。 | ||
またはAWSの[RDS]、[ElastiCache]、[S3]などのマネージドサービスを使用することもできます。 | ||
|
||
Holloにこれらのサービスを組み合わせるには、 | ||
`docker run`コマンドの[`-e`/`--env`オプションまたは`--env-file`オプション][1]を使用して | ||
環境変数を設定する必要があります。 | ||
Holloがサポートする環境変数のリストは[**環境変数**](./env)章で確認できます。 | ||
|
||
[GitHub Packages]: https://github.com/dahlia/hollo/pkgs/container/hollo | ||
[PostgreSQL]: https://hub.docker.com/_/postgres | ||
[MinIO]: https://hub.docker.com/r/minio/minio | ||
[RDS]: https://aws.amazon.com/rds/ | ||
[ElastiCache]: https://aws.amazon.com/elasticache/ | ||
[S3]: https://aws.amazon.com/s3/ | ||
[1]: https://docs.docker.com/reference/cli/docker/container/run/#env | ||
|
||
|
||
Docker Compose | ||
-------------- | ||
|
||
import { Code } from "@astrojs/starlight/components"; | ||
import composeYaml from "../../install/docker/compose-yaml?raw"; | ||
|
||
PostgreSQLとS3互換のオブジェクトストレージなどをHolloに接続してデプロイするために、 | ||
[Docker Compose]を使用することができます。以下は*compose.yaml*ファイルの例です: | ||
|
||
<Code code={composeYaml} lang="yaml" title="compose.yaml" /> | ||
|
||
上記のファイルを作業ディレクトリに*compose.yaml*として保存し、次のコマンドを実行します: | ||
|
||
~~~~ sh frame="none" | ||
docker compose up -d | ||
~~~~ | ||
|
||
[Docker Compose]: https://docs.docker.com/compose/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,93 @@ | ||
--- | ||
title: 環境変数 | ||
description: Holloの設定を行うための環境変数について説明します。 | ||
--- | ||
|
||
import { Aside, Badge } from '@astrojs/starlight/components'; | ||
|
||
Holloは環境変数を使って設定を行います。 | ||
環境変数はプロジェクトの最上位ディレクトリに*.env*ファイルを作成するか、 | ||
Dockerの`-e`/`--env`オプションを使うか、 | ||
Railwayのenvironment variablesメニューから設定できます。 | ||
|
||
### `DATABASE_URL` <Badge text="Railwayでは使われない" variant="tip" /> | ||
|
||
PostgreSQLのデータベースのURL。例:`postgresql://hollo:password@localhost/hollo` | ||
|
||
### `REDIS_URL` <Badge text="オプション" /> <Badge text="Railwayでは使われない" variant="tip" /> | ||
|
||
RedisサーバーのURL。例:`redis://localhost/0` | ||
|
||
設定されない場合、キャッシュとメッセージキューにPostgreSQLが使用されます。 | ||
|
||
### `HOME_URL` <Badge text="オプション" /> | ||
|
||
設定された場合、トップページへにアクセスした時にこのURLにリダイレクトされます。 | ||
設定されていない場合、トップページにはアカウント一覧が表示されます。 | ||
|
||
### `SECRET_KEY` <Badge text="Railwayでは使われない" variant="tip" /> | ||
|
||
セッションを保護するための秘密鍵。 | ||
次のコマンドで安全なランダムな秘密鍵を生成できます: | ||
|
||
~~~~ sh frame="none" | ||
openssl rand -hex 32 | ||
~~~~ | ||
|
||
### `LOG_LEVEL` <Badge text="オプション" /> | ||
|
||
アプリケーションのログレベル。 | ||
`debug`、`info`、`warning`、`error`、`fatal`のいずれかを選択してください。 | ||
|
||
デフォルトは`info`です。 | ||
|
||
### `BEHIND_PROXY` <Badge text="オプション" /> <Badge text="Railwayでは使われない" variant="tip" /> | ||
|
||
Holloがリバースプロキシの後ろにある場合は`true`に設定します。 | ||
HolloがL7ロードバランサーの後ろにある場合(通常はそうする必要があります)、 | ||
このオプションを有効にします。 | ||
|
||
基本的にはオフになっています。 | ||
|
||
<Aside> | ||
このオプションをオンにすると、 | ||
Holloはリバースプロキシから受け取った`X-Forwarded-For`、`X-Forwarded-Proto`、`X-Forwarded-Host`ヘッダを信頼します。 | ||
この動作はセキュリティ上注意が必要です。 | ||
</Aside> | ||
|
||
### `S3_REGION` <Badge text="オプション" /> | ||
|
||
S3互換オブジェクトストレージのリージョン。例:`us-east-1` | ||
|
||
一部の非AWS S3互換サービスでは、この値が必要ないかもしれません。 | ||
|
||
デフォルトは`auto`です。 | ||
|
||
### `S3_BUCKET` | ||
|
||
S3互換オブジェクトストレージのバケット名。例:`hollo` | ||
|
||
### `S3_URL_BASE` | ||
|
||
S3互換オブジェクトストレージの公開URLベース。 | ||
例:`https://hollo.s3.us-east-1.amazonaws.com` | ||
|
||
### `S3_ENDPOINT_URL` | ||
|
||
S3互換オブジェクトストレージのエンドポイントURL。 | ||
例:`https://s3.us-east-1.amazonaws.com` | ||
|
||
### `S3_FORCE_PATH_STYLE` | ||
|
||
S3互換オブジェクトストレージに対してパススタイルURLを強制するかどうか。(`true`または`false`) | ||
非AWS S3互換サービスで必要な場合があります。 | ||
|
||
基本的にはオフになっています。 | ||
|
||
### `AWS_ACCESS_KEY_ID` | ||
|
||
S3互換オブジェクトストレージのアクセスキー。 | ||
|
||
### `AWS_SECRET_ACCESS_KEY` | ||
|
||
S3互換オブジェクトストレージのシークレットキー。 |
Oops, something went wrong.