Repolode
jamesread

jamesread/Faridoon

A self-hosted web app for saving, sharing and voting on favourite chat quotes, backed by Go and MySQL.

Stars
53
Forks
3
Open issues
6
Last commit
2 days ago

What is it?

Faridoon lets a group save memorable chat exchanges as quotes and publish them for others to read. Pasting a chat log produces a formatted quote with a live preview, and each quote gets its own permalink page. Usernames are automatically highlighted in colour, and stray line breaks and odd characters are cleaned up.

The site is administered from the browser. Admins can set the site title, voting, registration, guest submissions and syntax highlighting, and moderators work through an approval queue before quotes go live. Quotes from guests and non-privileged users wait in that queue, and rejecting one deletes it.

The service is written in Go with a Vue 3 front end and uses MySQL for storage, with schema migrations handled by sql-migrate. The project recommends running it with Docker against a MySQL database, and it needs no internet connection to function.

Key features

  • 01Pasting a chat log produces a formatted quote with a live preview.
  • 02Usernames are automatically highlighted in their own colours.
  • 03Approval queue for guest and non-privileged submissions with moderator controls.
  • 04Site settings are managed from the browser, with no config files to edit.
  • 05Users can vote on quotes, and dark mode is available.

Use cases

  • A friend group or community sharing its funniest chat moments on a private site.
  • A homelab user self-hosting a quote board with Docker and MySQL.
  • A moderated community that wants guest submissions reviewed before publication.

Quick start

  1. 1

    Read the installation docs (Docker recommended, with a MySQL database)

  2. 2

    Open the documentation site for installation and usage details

Things to know

  • Requires a MySQL database to run.
  • Installation is documented on an external site rather than in the README.

In collections

Topics

FAQ

What is Faridoon?
A self-hosted web app for saving, sharing and voting on favourite chat quotes, backed by Go and MySQL. Faridoon lets a group save memorable chat exchanges as quotes and publish them for others to read. Pasting a chat log produces a formatted quote with a live preview, and each quote gets its own permalink page. Usernames are automatically highlighted in colour, and stray line breaks and odd characters are cleaned up.
Is Faridoon free to use? What license does it have?
Faridoon is open source under the AGPL-3.0 license. Check the license terms before using it in commercial products.
Is Faridoon still maintained?
Actively maintained. The last commit to Faridoon was on Nov 6, 2026.
What can I use Faridoon for?
A friend group or community sharing its funniest chat moments on a private site. A homelab user self-hosting a quote board with Docker and MySQL. A moderated community that wants guest submissions reviewed before publication.
How do I install Faridoon?
Read the installation docs (Docker recommended, with a MySQL database) Open the documentation site for installation and usage details
Where can I get Faridoon?
The source code and installation instructions are on GitHub: https://github.com/jamesread/Faridoon

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects