Faridoon

Faridoon

Docker app from grtgbln's Repository

A web app to publish your favourite chat quotes.

Requirements


        Requires a separate MySQL database.
    
Overview
A web app to publish your favourite chat quotes.
project logo

Faridoon

Easily save and publish your favourite chat quotes for others to see.

Static Badge GitHub Actions Workflow Status Discord

Documentation for how to install and use Faridoon is available at https://jamesread.github.io/Faridoon/

Screenshots

Latest quotes

Latest quotes

The front page lists the newest quotes, with each chat username highlighted in its own colour. Signed-in users can vote quotes up or down.

Quote permalink

Quote permalink

Every quote has its own page, so a favourite exchange is easy to link to and share.

Add a quote

Add a quote

Paste a chat log and a live preview shows exactly how the quote will look before it is submitted.

Approval queue

Approval queue

Quotes from guests and regular users wait in an approval queue, where moderators can approve, reject or tidy them up before they go live.

Settings

Settings

Admins configure the site from the browser, including the site title, voting, registration, guest submissions and theme, with no config files to edit.

Dark mode

Dark mode

A built-in dark theme, which users can switch to from the header.

Screenshots use fictional test data and are regenerated with make screenshots (see var/marketing/screenshots).

Getting Started

Documentation is available at: https://jamesread.github.io/Faridoon/ , the recommended installation method is via Docker, connected to a MySQL Database. Faridoon runs just fine with low system resources - 1 vCPU and a 1 GB of RAM is plenty.

Stack

  • Go service with ConnectRPC
  • Vue 3 + Vue Router + picocrank UI components
  • MySQL schema managed with sql-migrate
  • Authentication via armature-httpauthshim (sessions; users stored in MySQL)

Features

  • Automatic highlighting of usernames.
  • Semi-intelligent removal of line breaks and weird characters.
  • User login and registration, with admins and privilege-based moderators.
  • Approval queue for guest and non-privileged submissions (reject deletes the quote).
  • Admin Settings (database cvars) for site title, voting, registration, guest add, and syntax highlighting.
  • Header links, webhooks (approval.requested), audit logs, and diagnostics.
  • YAML config for listen/database/auth; environment variables for database connectivity (and a few bootstrap values).

Faridoon is a No-Nonsense Open Source project;

  • All code and assets are Open Source (AGPL).
  • No company is paying for development, there is no paid-for support from the developers.
  • No separate core and premium version, no plus/pro version or paid-for extra features.
  • No SaaS service or "special cloud version".
  • No "anonymous data collection", usage tracking, user tracking, telemetry or email address collection.
  • No requests for reviews in any "app store" or feedback surveys.
  • No prompts to "upgrade to the latest version".
  • No internet-connection required for any functionality.

Docs

Documentation for how to install and use Faridoon is available at https://jamesread.github.io/Faridoon/

Media gallery

1 / 2

Categories

Links

Details

Repository
ghcr.io/jamesread/faridoon:latest
Last Updated2026-11-22
First Seen2025-01-08

Runtime arguments

Web UI
http://[IP]:[PORT:8080]/
Network
bridge
Privileged
false

Template configuration

Web UI PortPorttcp

Container Port: 8080

Target
8080
Default
8080
Value
8080
MySQL - HostVariable

MySQL host

Target
DB_HOST
MySQL - NameVariable

MySQL database name

Target
DB_NAME
Default
faridoon
Value
faridoon
MySQL - UserVariable

MySQL user

Target
DB_USER
Default
faridoon
Value
faridoon
MySQL - PasswordVariable

MySQL password

Target
DB_PASS
Admin PasswordVariable

Admin password

Target
ADMIN_PASSWORD
Site TitleVariable

Title of the site

Target
SITE_TITLE
Default
Faridoon
Value
Faridoon
Enable VotingVariable

Set to 1 to enable voting on quotes.

Target
ENABLE_VOTING
Default
0|1
Enable Syntax HighlightingVariable

Set to 1 to enable syntax highlighting in quotes.

Target
ENABLE_SYNTAX_HIGHLIGHTING
Default
0|1
Config PathPathrw

Path to store configuration files

Target
/config
Default
/mnt/user/appdata/faridoon/config
Value
/mnt/user/appdata/faridoon/config