Skip to content

Latest commit

 

History

History
66 lines (49 loc) · 1.59 KB

README.md

File metadata and controls

66 lines (49 loc) · 1.59 KB

chamsae

chamsae is a lightweight ActivityPub server for a single user. chamsae is for a single user who wants to join the fediverse, but not want to run a massive software. chamsae means an Eurasian tree sparrow.

Features

  • Mastodon or Misskey like microblogging service TODO
  • Misskey like emoji reactions TODO

Usage

NOTE You need a public accessible S3 compatible object storage. This is not optional.

NOTE You have to serve chamsae with HTTPS. This is not optional. For development, Caddy is helpful.

Requirements

  • PostgreSQL
  • Public accessible S3 compatible object storage

Backend

RUST_LOG=info \
  DEBUG=true \
  DOMAIN=localhost \
  USER_HANDLE=admin \
  USER_PASSWORD_BCRYPT={your_password_hash} \
  DATABASE_HOST={host} \
  DATABASE_PORT={port} \
  DATABASE_USER={user} \
  DATABASE_PASSWORD={password} \
  DATABASE_DATABASE={db} \
  OBJECT_STORAGE_REGION={region} \
  OBJECT_STORAGE_ENDPOINT={endpoint} \
  OBJECT_STORAGE_BUCKET={bucket} \
  OBJECT_STORAGE_PUBLIC_URL_BASE={base_url} \
  OBJECT_STORAGE_PATH_STYLE={true|false} \
  OBJECT_STORAGE_ACCESS_KEY={access_key} \
  OBJECT_STORAGE_SECRET_KEY={secret_key} \
  cargo run --bin chamsae

To serve HTTPS with caddy:

caddy reverse-proxy --to :3000

You may need to run sudo setcap cap_net_bind_service=+ep $(which caddy) first.

Frontend

TODO

License

chamsae is licensed under the terms of AGPL v3.0. See LICENSE file for details.