# Faridoon

Faridoon is a lightweight self-hosted web app for saving and publishing favourite chat quotes so you can share them with others. It is open source and self-hosted, installable on Unraid.

Canonical page: https://ourlocalhost.com/app/2802/faridoon

## Description

Faridoon is a lightweight self-hosted web app for saving and publishing favourite chat quotes so you can share them with others.

## Platform availability

Available on 2 of 10 platforms: Unraid, Any server.

## Health score

70/100 (Good), based on 4 of 5 factors.
- Maintained: 95 (last commit 31 days ago)
- Popular: 35 (54 GitHub stars)
- Easy to install: 45 (2 install platforms, install notes, Docker image)
- Security check: 88 (no serious findings, 2 minor, CI, tests)

## Links

- Unraid: https://ca.unraid.net/apps/faridoon-184p5pm0kfkcwe?q=Faridoon
- Official website: https://jamesread.github.io/Faridoon/
- GitHub: https://github.com/jamesread/faridoon
- Documentation: https://jamesread.github.io/Faridoon/

## Common questions

### Which database is expected in the Docker Compose setup?

Faridoon connects to a MySQL database in the recommended Docker Compose setup. The schema is managed with sql-migrate.

### How does Faridoon handle user accounts and moderation?

It supports user login and registration, with admins and privilege-based moderators. Guest and non-privileged submissions enter an approval queue, and rejecting a submission deletes the quote.

### Where do I configure Faridoon settings?

Use YAML for listen, database, and auth settings, with environment variables for database connectivity and a few bootstrap values. Admin settings can also change database cvars for options such as site title, voting, registration, guest add, and syntax highlighting.

## Alternatives

- Your Quote: Share your words with the world.

---
Source: Our Local Host (https://ourlocalhost.com/app/2802/faridoon), the self-hosted and open-source app directory.
