Skip to content

Commit

Permalink
docs(readme): remove useless section
Browse files Browse the repository at this point in the history
  • Loading branch information
kwaa committed Jan 30, 2024
1 parent ab65429 commit 1f8674f
Showing 1 changed file with 0 additions and 50 deletions.
50 changes: 0 additions & 50 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,60 +27,10 @@ cargo install just
just
```

<!-- ###### Cargo
```bash
# run
cargo run
# build (debug)
cargo build
# build (release)
cargo build --release
# install
cargo install
# lint
cargo clippy
# lint fix
cargo clippy --fix
# format
cargo fmt
```
###### Docker
```bash
# docker build
docker build .
# docker compose up
docker-compose up -d
```
###### ORM (optional)
```bash
# install sea-orm-cli
cargo install sea-orm-cli
# migrate
sea-orm-cli migrate up
# generate entity
sea-orm-cli generate entity -o src/entities/models
``` -->

The goal of this project is to provide a self-hosted and easy-to-use alternative to [Bridgy Fed](https://github.com/snarfed/bridgy-fed).

It will crawl the feed ([JSON Feed 1.1](https://jsonfeed.org/version/1.1) / [Atom 1.0](https://validator.w3.org/feed/docs/atom.html) / [RSS 2.0](https://www.rssboard.org/rss-specification)) to get the data instead of going through Webmention / Microformats, but the response from Fediverse will still be converted to a Webmention back to the source.

### Environments

| Environment | Default | .env.example | Remarks |
| ----------------------- | ----------------- | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `DATABASE_URL` | `sqlite::memory:` | `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) |
| `HATSU_DOMAIN` | | `hatsu.local` | The domain name you assigned to this Hatsu instance. For example, `hatsu.example.com` |
| `HATSU_LISTEN_HOST` | `localhost` | `0.0.0.0` | The hostname on which Hatsu is listening. |
| `HATSU_LISTEN_PORT` | `3939` | `3939` | The port on which Hatsu is listening. |
| `HATSU_PRIMARY_ACCOUNT` | | `www.jsonfeed.org` | The primary account for this Hatsu instance, which cannot be removed and is used as a `signed_fetch_actor`. |
| `HATSU_ACCESS_TOKEN` | | | For accessing Admin API. (optional) |

### Fediverse compatibility

Hatsu uses the same library as [Lemmy](https://github.com/LemmyNet/lemmy), [Activitypub-Federation](https://github.com/LemmyNet/activitypub-federation-rust), so it should behave similarly in practice.
Expand Down

0 comments on commit 1f8674f

Please sign in to comment.