fawn/tamako
fawn/tamako
1
4
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity
Cozy anonyomus whispers 🐞 https://tamako.fawn.moe
140 commits 1 branch 0 tags 4.6 MiB
Rust 46.5%
Go 27.4%
HTML 23.5%
Dockerfile 1.9%
Just 0.7%
Find a file
fawn 9ad07e1145
All checks were successful
ci/woodpecker/push/golint Pipeline was successful
Details
ci/woodpecker/push/clippy Pipeline was successful
Details
chore: rename meta folder to .meta
2024-11-16 00:47:57 +02:00
.github/workflows 🚀 deploy: switch to woodpecker, push to multiple registeries 2023-11-25 15:04:14 +02:00
.meta chore: rename meta folder to .meta 2024-11-16 00:47:57 +02:00
.sqlx
.vscode
.woodpecker 🔨 chore(woodpecker): extend golint timeout 2024-03-12 10:55:30 +02:00
assets
cmd/mochi 🔨 chore: crlf -> lf 2024-08-30 03:52:01 +03:00
migrations
src 📦 deps: bump 2024-10-14 14:51:47 +03:00
templates 🔨 chore: crlf -> lf 2024-08-30 03:52:01 +03:00
.dockerignore
.env.example 🔨 chore: clean up docker compose file, mention it in the readme 2023-11-24 10:14:12 +02:00
.gitignore ♻️ refactor: switch to actix web away from tide (#5) 2023-08-17 03:26:31 +00:00
build.rs ♻️ refactor: actual 404 error handling 2023-08-22 23:30:34 +03:00
Cargo.lock 📦 deps: bump 2024-10-14 14:51:47 +03:00
Cargo.toml 📦 deps: bump 2024-10-14 14:51:47 +03:00
docker-compose.yml 🔨 chore(docker): pin postgres image version 16 2024-10-19 20:58:27 +03:00
Dockerfile 🔨 chore: crlf -> lf 2024-08-30 03:52:01 +03:00
fly.toml
justfile 🔨 chore: crlf -> lf 2024-08-30 03:52:01 +03:00
LICENSE 🔨 chore: crlf -> lf 2024-08-30 03:52:01 +03:00
README.md chore: rename meta folder to .meta 2024-11-16 00:47:57 +02:00
rinja.toml 📦 deps: switch from askama to rinja 2024-08-30 03:26:18 +03:00

README.md

tamako🐞

status-badge crates.io dependency status

tamako is a cozy, minimalistic, single-user, anonymous whispers service

scrot

Prerequisites

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.

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

mochi

Installation

go install codeberg.org/fawn/tamako/cmd/mochi@latest

Usage

mochi --url https://tamako.fawn.moe

mochi -h for more info.

License

OSL-3.0