Comptasse
v1.4.7

Installation

Installer et démarrer Comptasse en quelques minutes

Prérequis

  • Docker et Docker Compose installés
  • Un accès à une base de données PostgreSQL (version 15 ou supérieure)
  • Un stockage compatible S3 (AWS S3, MinIO, RustFS, etc.)
Information
Vous n'avez pas de PostgreSQL ou de S3 ? Utilisez la méthode Compose avec services intégrés qui inclut tout dans un seul fichier.

Méthode 1 : Script d'installation (recommandé)

Le script d'installation guide pas à pas et configure automatiquement l'environnement. Il fonctionne sur macOS et Linux et installe l'API, le Dashboard et le CLI.

Exemple - Installation automatique
curl -fsSL https://comptasse.com/install.sh | sh
Exemple - Ce que fait le script
  • Vérifie que Docker est installé et en cours d'exécution
  • Demande si vous avez déjà un PostgreSQL et un S3, ou si vous souhaitez des services intégrés
  • Si services intégrés : configure PostgreSQL et RustFS automatiquement
  • Si services externes : demande les identifiants de connexion
  • Génère une clé de signature des sessions (COOKIES_KEY) si non fournie
  • Crée le répertoire de configuration dans ~/.comptasse
  • Télécharge et démarre les images Docker API + Dashboard (le site web est hébergé par l'équipe Comptasse)
  • Installe le CLI sur la machine hôte depuis les GitHub Releases
Information
Le script choisit la source des images en fonction de l'origine du téléchargement : depuishttps://comptasse.com (production), il télécharge les images publiées (API + Dashboard) sur GHCR ; depuis tout autre origine, par exemple http://localhost en développement, il construit les images à partir des sources sans passer par un registre — ce qui requiert une copie du dépôt Comptasse sur la machine.
Exemple - Après l'installation
  • Dashboard : http://localhost:5173
  • API : http://localhost:3000
  • CLI : comptasse --help (installé dans ~/.local/bin)

Méthode 2 : Installation manuelle avec Docker

Pour un contrôle total sur la configuration, lancez les conteneurs API et Dashboard avec docker run.

Exemple - Avec vos propres services
docker run -d \
  --name comptasse-api \
  -p 3000:3000 \
  -e ENV=production \
  -e VERBOSE=false \
  -e PORT=3000 \
  -e CORS_ORIGIN=http://localhost:5173 \
  -e COOKIES_DOMAIN=localhost \
  -e COOKIES_KEY=UNE_CLE_SIGNATURE_32_CARACTERES \
  -e API_BASE_URL=http://localhost:3000 \
  -e WEBSITE_BASE_URL=https://comptasse.com \
  -e DASHBOARD_BASE_URL=http://localhost:5173 \
  -e SQL_DATABASE_URL=postgres://user:password@host:5432/comptasse \
  -e STORAGE_ENDPOINT=https://s3.amazonaws.com \
  -e STORAGE_BUCKET_NAME=my-bucket \
  -e STORAGE_ACCESS_KEY=VOTRE_CLE_ACCES_S3 \
  -e STORAGE_SECRET_KEY=VOTRE_CLE_SECRETE_S3 \
  ghcr.io/comptasse/api

docker run -d \
  --name comptasse-dashboard \
  -p 5173:80 \
  ghcr.io/comptasse/dashboard
Exemple - Variables d'environnement (API)
  • SQL_DATABASE_URL (requis) : chaîne de connexion PostgreSQL
  • STORAGE_ENDPOINT (requis) : URL du service S3
  • STORAGE_BUCKET_NAME (requis) : nom du bucket
  • STORAGE_ACCESS_KEY (requis) : clé d'accès S3
  • STORAGE_SECRET_KEY (requis) : clé secrète S3
  • STORAGE_REGION (optionnel) : région S3, défaut fr-par
  • CORS_ORIGIN (requis) : origine autorisée pour le navigateur
  • COOKIES_KEY (optionnel) : clé de signature, générée automatiquement si absente

Méthode 3 : Compose avec services intégrés

Si vous n'avez pas de PostgreSQL ou de S3, ce fichier compose.yml inclut tout : l'API, le Dashboard, PostgreSQL et RustFS (stockage S3). Le Dashboard est construit avec VITE_API_BASE_URL=/api et son nginx relaie les requêtes /api vers le service api.

Exemple - Fichier compose.yml
services:
  api:
    image: ghcr.io/comptasse/api
    ports:
      - "3000:3000"
    environment:
      ENV: production
      VERBOSE: "false"
      PORT: "3000"
      CORS_ORIGIN: http://localhost:5173
      COOKIES_DOMAIN: localhost
      COOKIES_KEY: UNE_CLE_SIGNATURE_32_CARACTERES
      API_BASE_URL: http://localhost:3000
      WEBSITE_BASE_URL: https://comptasse.com
      DASHBOARD_BASE_URL: http://localhost:5173
      SQL_DATABASE_URL: postgres://postgres:password@postgres:5432/comptasse
      STORAGE_ENDPOINT: http://rustfs:9000
      STORAGE_BUCKET_NAME: comptasse-files
      STORAGE_ACCESS_KEY: admin
      STORAGE_SECRET_KEY: admin
    depends_on:
      postgres:
        condition: service_healthy
      rustfs:
        condition: service_started
    restart: unless-stopped

  dashboard:
    image: ghcr.io/comptasse/dashboard
    ports:
      - "5173:80"
    depends_on:
      - api
    restart: unless-stopped

  postgres:
    image: postgres:18.1
    volumes:
      - postgres-data:/var/lib/postgresql
    environment:
      POSTGRES_USER: postgres
      POSTGRES_PASSWORD: password
      POSTGRES_DB: comptasse
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U postgres -d comptasse"]
      interval: 5s
      timeout: 5s
      retries: 5
    restart: unless-stopped

  rustfs:
    image: rustfs/rustfs:latest
    volumes:
      - rustfs-data:/data
    environment:
      RUSTFS_CONSOLE_ENABLE: "false"
      RUSTFS_ACCESS_KEY: admin
      RUSTFS_SECRET_KEY: admin
      RUSTFS_VOLUMES: /data
    restart: unless-stopped

volumes:
  postgres-data:
  rustfs-data:
Exemple - Démarrage
# Sauvegardez le fichier ci-dessus dans compose.yml
docker compose up -d

# Vérifiez que les services sont démarrés
docker compose ps
Attention
Ce mode est destiné au développement et aux tests. Pour la production, utilisez vos propres services PostgreSQL et S3 avec des identifiants sécurisés.

Premiers pas après installation

  • Ouvrez http://localhost:5173 dans votre navigateur
  • Créez un compte utilisateur
  • Créez votre première organisation
  • Ajoutez un exercice comptable
  • Commencez à saisir des écritures
Information
Pour un guide détaillé de l'interface, consultez la page Démarrer avec Comptasse.

Installation du CLI

Le CLI est un client HTTP autonome qui communique avec l'API. Il est distribué via les GitHub Releases et s'installe sur votre machine hôte.

Exemple - Sur votre machine hôte
curl -fsSL https://comptasse.com/cli/install.sh | sh

# Vérifiez l'installation
comptasse --version

# Connectez-vous à votre instance
comptasse login --api-key VOTRE_CLE_API --url http://localhost:3000