https://github.com/fawni/tamako
🐞 Cozy anonymous whispers
https://github.com/fawni/tamako
actix-web askama bubbletea sqlx
Last synced: 10 days ago
JSON representation
🐞 Cozy anonymous whispers
- Host: GitHub
- URL: https://github.com/fawni/tamako
- Owner: fawni
- License: osl-3.0
- Created: 2022-08-10T13:13:55.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-08-18T18:50:44.000Z (5 months ago)
- Last Synced: 2025-08-18T19:28:57.251Z (5 months ago)
- Topics: actix-web, askama, bubbletea, sqlx
- Language: Rust
- Homepage: https://tamako.fawn.moe
- Size: 4.45 MB
- Stars: 4
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# tamako🐞
[](https://ci.codeberg.org/repos/12523)
[](https://crates.io/crates/tamako)
[](https://deps.rs/repo/codeberg/fawn/tamako)
tamako is a cozy, minimalistic, single-user, _anonymous_ whispers service
## Prerequisites
- [sqlx-cli](https://crates.io/crates/sqlx-cli)
- a postgresql database
## Environment variables
| Name | Type | Default | Notes |
| ------------------------- | ------ | ------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| `TAMAKO_HOST` | String | 127.0.0.1 | the host to run the server on |
| `TAMAKO_PORT` | u16 | 8715 | the port to serve the server on |
| `DATABASE_URL` | String | _none_ | the database url. this should be a valid postgresql connection url |
| `WEBHOOK_URL` | String | _none_ | _(optional)_ the discord webhook url. this will be used to send _private and public_ whispers to a discord channel |
| `TAMAKO_SECRET` | String | _none_ | the secret key used for authentication. think of it like a master password |
| `TAMAKO_USER_NAME` | String | tamako | _(optional)_ used in the fronted header |
| `TAMAKO_USER_DESCRIPTION` | String | Cozy anonymous whispers 🐞 | _(optional)_ used in the fronted header |
## Installation
### Docker Compose (Recommended)
This will also create a postgres service container.
1. Clone the repo
2. Configure `docker-compose.yml` to match your setup, most importantly change the environment variables
3. `docker compose up -d`
### Locally
1. Clone the repo
2. Rename `.env.example` to `.env` and change env variables inside it
3. Build tamako: `cargo build --release`
4. Run tamako: `./target/release/tamako`
### Docker
Using docker directly is possible, but you have to configure the container yourself.
```sh
docker run -d --name tamako --restart unless-stopped -p 8715:8715 fawni/tamako:latest
```
## TUI
tamako comes with a pretty little tui frontend for it called mochi
### Installation
```sh
go install codeberg.org/fawn/tamako/cmd/mochi@latest
```
### Usage
```sh
mochi --url https://tamako.fawn.moe
```
`mochi -h` for more info.
## License
[OSL-3.0](LICENSE)