# Galette

**Membership management for non-profit organizations** — web-based PHP application to manage members, dues, contributions, and mailing lists. Multilingual (FR/EN and more), with plugin system, PDF export, and email notifications.

**Official site:** https://galette.eu
**Source:** https://github.com/galette/galette
**License:** GPL-3.0

---

## Compatible Combos

| Infra | Runtime | Notes |
|-------|---------|-------|
| Any VPS / bare metal | PHP + MySQL/MariaDB | Standard LAMP/LEMP stack |
| Any VPS / bare metal | PHP + PostgreSQL | Also supported |

---

## Inputs to Collect

### Phase 1 — Planning
- Domain / hostname
- Database type: MySQL/MariaDB or PostgreSQL

### Phase 2 — Deploy
- Database credentials (name, user, password, host)
- Admin account email and password
- SMTP config for membership notifications

---

## Software-Layer Concerns

- **Stack:** PHP, MySQL/MariaDB or PostgreSQL
- **Installation:** Download tarball from galette.eu; web-based installer at `/install/`
- **Data dirs:** `galette/data/` — uploads, attachments, logs; must be writable by web server user
- **Config file:** `galette/config/config.inc.php` — generated by installer
- **Plugins:** Available via plugin manager; extend with features like maps, social links, events
- **PDF/reports:** Built-in PDF export for membership cards, lists, contribution receipts
- **Download URL:** https://galette.eu/download/galette-1.2.1.tar.bz2 (latest stable)

---

## Deployment

1. Download latest stable release from https://galette.eu
2. Extract to web server document root (set root to `galette/webroot/`)
3. Set permissions: `chown -R www-data:www-data galette/data galette/config galette/logs galette/cache`
4. Visit `https://your-domain/install/` and follow the web installer
5. Remove or restrict access to `galette/install/` after setup

Full documentation: https://doc.galette.eu/en/develop

---

## Upgrade Procedure

1. Back up the database and `galette/data/` directory
2. Download new release tarball
3. Replace all files except `galette/data/` and `galette/config/config.inc.php`
4. Visit `https://your-domain/install/` and run the upgrade wizard

Full upgrade guide: https://doc.galette.eu/en/develop/installation/upgrade.html

---

## Gotchas

- **Remove `/install/` after setup** — leaving it accessible is a security risk
- **`galette/data/` must be writable** — uploads and logs go here; incorrect permissions cause silent failures
- **Document root must point to `galette/webroot/`** — not the repo root; misconfigured web server will expose config files
- **Nightly build** is available but not for production use; stick to stable releases
- **French-first project** — primary documentation and community is in French; English docs exist and are maintained

---

## Links

- Upstream README: https://github.com/galette/galette#readme
- Documentation (English): https://doc.galette.eu/en/develop
- Documentation (French): https://doc.galette.eu/fr/develop
- Download: https://galette.eu/download/galette-1.2.1.tar.bz2
- Bug tracker: https://bugs.galette.eu/projects/galette
