# FlagFlow Documentation

> Official documentation website for FlagFlow - a modern, self-hosted feature flag management system. Built with SvelteKit 5 as a static site with component-based documentation architecture.

This site provides comprehensive guides for installation, configuration, user management, TypeScript integration, and migration workflows for the FlagFlow feature flag platform.

## Core Documentation

- [Getting Started](https://flagflow.net/docs): Complete guide to setting up and using FlagFlow
- [Installation Guide](https://flagflow.net/docs/installation/prerequisites): System requirements, Docker, Kubernetes, and etcd setup
- [User Management](https://flagflow.net/docs/user-management/authentication): Authentication, permissions, and Keycloak integration
- [Flag Types](https://flagflow.net/docs/flags/flag-types): Boolean, Integer, String, Object, Enum, Tag, and AB-Test flags
- [TypeScript Integration](https://flagflow.net/docs/typescript/ts-schema): Type-safe client code with auto-generated schemas
- [REST API](https://flagflow.net/docs/rest-api): OpenAPI 3.0 specification and authentication guide

## Installation & Deployment

- [Prerequisites](https://flagflow.net/docs/installation/prerequisites): Node.js 22+, etcd requirements, system dependencies
- [Docker Installation](https://flagflow.net/docs/installation/docker): Containerized deployment with docker-compose
- [Kubernetes Deployment](https://flagflow.net/docs/installation/kubernetes): K8s manifests, Helm charts, production setup
- [etcd Configuration](https://flagflow.net/docs/installation/etcd): Distributed storage setup and clustering
- [Filesystem Storage](https://flagflow.net/docs/installation/filesystem-storage): Lightweight alternative for small deployments
- [Environment Variables](https://flagflow.net/docs/installation/env-variables): Complete configuration reference

## User Management & Security

- [Authentication Overview](https://flagflow.net/docs/user-management/authentication): Security model and SSO integration
- [Built-in Users](https://flagflow.net/docs/user-management/built-in-users): Simple authentication for small teams
- [Keycloak Integration](https://flagflow.net/docs/user-management/keycloak): Enterprise SSO with OAuth2 and OpenID Connect
- [Permissions System](https://flagflow.net/docs/user-management/permissions): Role-based access control (RBAC)
- [Audit Log](https://flagflow.net/docs/user-management/audit-log): Compliance logging and change tracking

## Flag Management

- [Flag Types](https://flagflow.net/docs/flags/flag-types): Boolean with killswitches, Integer, String, Object, Enum, Tag, AB-Test
- [Flag Hierarchy](https://flagflow.net/docs/flags/hierarchy): Organizing flags with namespaces and grouping
- [Accessing Flags](https://flagflow.net/docs/flags/access-flags): REST API and client SDK integration

## TypeScript & Type Safety

- [TypeScript Schema](https://flagflow.net/docs/typescript/ts-schema): Auto-generated interfaces with IntelliSense support
- [Zod Schema Validation](https://flagflow.net/docs/typescript/zod-schema): Runtime type validation and parsing
- [Hash Validation](https://flagflow.net/docs/typescript/hash): SHA-1 consistency checking and cache control

## Migration & Operations

- [Export & Backup](https://flagflow.net/docs/migration/export-backup): Creating portable backups for disaster recovery
- [Restore Operations](https://flagflow.net/docs/migration/restore): Recovering configurations from backup files
- [Cross-Environment Migration](https://flagflow.net/docs/migration/migration): Transferring flags between dev, staging, and production

## Development & Testing

- [Testing Infrastructure](https://flagflow.net/docs/testing): Vitest, @testing-library/svelte, E2E patterns

## Quick Start Example

```bash
# Run FlagFlow with Docker
docker run -d -p 3000:3000 \
  -e ETCD_HOST=etcd-server \
  -e ETCD_PORT=2379 \
  flagflow/flagflow:latest

# Access web interface
open http://localhost:3000

# Fetch a flag value
curl http://localhost:3000/flag/my-feature-flag
```

## Website Repository

- [GitHub Repository](https://github.com/flagflow/website): Documentation website source code
- [CLAUDE.md](https://github.com/flagflow/website/blob/main/CLAUDE.md): Development guide for contributing to docs
- [README.md](https://github.com/flagflow/website/blob/main/README.md): Project structure and setup instructions

## External Links

- [FlagFlow Main Repository](https://github.com/flagflow/flagflow): Core application source code
- [Demo Environment](https://demo.flagflow.net): Live demonstration instance
- [Issue Tracker](https://github.com/flagflow/website/issues): Bug reports and feature requests for documentation