Faridoon

Faridoon

Docker app from grtgbln's Repository

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

Note the screenshots below contain quotes from the site that inspired this self hosted project - bash.org - which is now offline. There are several mirrors available via search engines. These quotes were used because they've been shared wildly for over 2 decades, and they're pretty funny :-)

Faridoon Mobile Phone Screenshot

Faridoon Desktop Screenshot

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.

Features

  • Automatic highlighting of usernames.
  • Semi-intelligent removal of line breaks and weird characters.
  • User login and registration, with support for admins and non-admins.
  • Approval system for guest and non-admin submissions.
  • Easy configuration via environment variables, or configuration file.

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

Install Faridoon on Unraid in a few clicks.

Find Faridoon in Community Apps on your Unraid server, review the template, and click Install. Unraid handles the Docker app or plugin setup from the published template.

Open the Apps tab on your Unraid server Search Community Apps for Faridoon Review the template variables and paths Click Install

Requirements


        Requires a separate MySQL database.
    

Details

Repository
ghcr.io/jamesread/faridoon:latest
Last Updated2026-07-15
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