-
-
Notifications
You must be signed in to change notification settings - Fork 5
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
7 changed files
with
121 additions
and
21 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
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,61 @@ | ||
# Environments | ||
|
||
Hatsu supports dotenv, and you can set environment variables via the `.env` file. | ||
|
||
It is required unless it has a suffix (optional). | ||
|
||
However, it may exist as a built-in preset (in the source code) or an example preset (in [`.env.example`](https://github.com/importantimport/hatsu/blob/main/.env.example)) | ||
|
||
## DATABASE_URL | ||
|
||
- default: `sqlite::memory:` | ||
- example: `sqlite://hatsu.sqlite3` | ||
|
||
Should be a valid `sqlite:` or `postgres:` URL. see [sea-ql.org](https://www.sea-ql.org/SeaORM/docs/install-and-config/connection/#connection-string) | ||
|
||
`sqlite::memory:` is used by default to ensure that hatsu does not report errors as a result. | ||
|
||
If you're not using a Postgres database, I recommend keeping the `sqlite://hatsu.sqlite3`. | ||
|
||
## HATSU_DOMAIN | ||
|
||
- default: None | ||
- example: `hatsu.local` | ||
|
||
The domain name you assigned to this Hatsu instance. | ||
|
||
## HATSU_LISTEN_HOST | ||
|
||
- default: `127.0.0.1` | ||
- example: `0.0.0.0` | ||
|
||
The hostname on which the Hatsu server listens. | ||
|
||
## HATSU_LISTEN_PORT | ||
|
||
- default: `3939` | ||
- example: `3939` | ||
|
||
The port on which the Hatsu server listens. | ||
|
||
## HATSU_PRIMARY_ACCOUNT | ||
|
||
- default: None | ||
- example: None | ||
|
||
The primary account for this Hatsu instance, which cannot be removed and is used as a `signed_fetch_actor`. | ||
|
||
## HATSU_ACCESS_TOKEN (optional) | ||
|
||
- default: None | ||
- example: None | ||
|
||
For accessing Admin API. | ||
|
||
If this value is not set, the Hatsu Admin API will not be available. | ||
|
||
This can be any string, but I recommend generating a random uuid v4. | ||
|
||
```bash | ||
echo "\nHATSU_ACCESS_TOKEN = \"$(cat /proc/sys/kernel/random/uuid)\"" >> .env | ||
``` |
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,13 @@ | ||
# Binary Installation | ||
|
||
## Stable | ||
|
||
Doesn't have a stable version yet. | ||
|
||
## Nightly | ||
|
||
Hatsu provides nightly Binary builds. | ||
|
||
Please note that it is unstable and may contain breaking changes. | ||
|
||
You can find the latest artifacts on the [Workflow runs page](https://github.com/importantimport/hatsu/actions/workflows/nightly.yml) (containing `x86_64-unknown-linux-gnu` and `aarch64-unknown-linux-gnu`). |
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,35 @@ | ||
# Docker Installation | ||
|
||
## Stable | ||
|
||
Doesn't have a stable version yet. | ||
|
||
## Nightly | ||
|
||
Hatsu provides nightly Docker image builds. | ||
|
||
Please note that it is unstable and may contain breaking changes. | ||
|
||
```bash | ||
docker pull ghcr.io/importantimport/hatsu:nightly | ||
``` | ||
|
||
Run with `docker run`: | ||
|
||
```bash | ||
docker run -d \ | ||
--name hatsu \ | ||
--restart unless-stopped \ | ||
-p 3939:3939 \ | ||
-v /opt/hatsu/hatsu.sqlite3:/app/hatsu.sqlite3 \ | ||
-e DATABASE_URL=sqlite://hatsu.sqlite3 \ | ||
-e HATSU_DOMAIN={{hatsu-instance-domain}} \ | ||
-e HATSU_LISTEN_HOST=0.0.0.0 \ | ||
-e HATSU_PRIMARY_ACCOUNT={{your-static-site}} \ | ||
-e HATSU_ACCESS_TOKEN=edc7e5a7-f2ce-44a6-a57e-b7706503f642 \ | ||
ghcr.io/importantimport/hatsu:nightly | ||
``` | ||
|
||
You need to specify all environment variables at once. For more information, see [Environments](./environments.md). | ||
|
||
<!-- You can also use the docker-compose example in examples. (TODO) --> |
This file was deleted.
Oops, something went wrong.
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 @@ | ||
# Install |