Aller au contenu principal

Installation rapide

L'installation rapide réunit Augias, PHP et un serveur web dans un seul téléchargement autonome. C'est le moyen le plus rapide d'obtenir une instance prête pour la production, et la méthode conseillée pour la plupart des utilisateurs.

Configuration requise​

  • Linux 64 bits (x86_64 ou arm64) ou macOS (Intel ou Apple Silicon).
  • Une base de données : SQLite fonctionne d'emblée ; MySQL, MariaDB et PostgreSQL sont aussi pris en charge.

Vous n'avez pas besoin de PHP, de Composer, de Nginx, d'Apache ni d'une tâche cron : le serveur web et le worker intégrés s'en chargent.

Windows

Il n'existe pas de version Windows native. Utilisez le binaire Linux dans WSL2.

Télécharger et lancer​

En une ligne : télécharge le binaire et l'installe dans /usr/local/bin :

curl -fsSL https://raw.githubusercontent.com/herc-si/Augias/main/packaging/install.sh | sh
augias run

Pour installer aussi un service systemd qui démarre Augias au lancement de la machine :

curl -fsSL https://raw.githubusercontent.com/herc-si/Augias/main/packaging/install.sh | INSTALL_SERVICE=1 sh

Téléchargement manuel : récupérez le binaire de votre architecture sur la page des versions, rendez-le exécutable et lancez-le :

chmod +x augias
./augias run

L'application démarre sur https://localhost:8765 avec un certificat auto-signé. Ouvrez l'adresse dans votre navigateur et poursuivez avec l'assistant de premier démarrage.

info

Les tâches récurrentes (comme les factures récurrentes) et le travail en arrière-plan (envoi des e-mails) tournent seuls : pas de tâche cron ni de consommateur de messages à mettre en place.

SSL​

L'application s'appuie sur Caddy : le HTTPS est activé par défaut.

Auto-signé (par défaut)​

./augias run

Pratique pour des essais en local. Les navigateurs affichent un avertissement à accepter une fois.

Let's Encrypt (conseillé en production)​

./augias run --domain=factures.example.com --lets-encrypt

Obtient et renouvelle automatiquement un certificat gratuit de Let's Encrypt. Conditions :

  • l'enregistrement DNS A/AAAA du domaine doit pointer vers l'adresse IP publique du serveur ;
  • les ports 80 et 443 doivent être joignables depuis internet (Let's Encrypt y vérifie la propriété du domaine).

Certificat personnel​

./augias run \
--domain=factures.example.com \
--ssl-cert=/etc/ssl/augias.pem \
--ssl-key=/etc/ssl/augias.key

Si vous avez déjà un certificat (wildcard, EV, ou délivré par l'autorité de votre entreprise).

Derrière un proxy inverse​

./augias run --disable-https

Quand un proxy en amont (Cloudflare, Nginx, un contrôleur d'entrée) gère le TLS. Augias écoute en HTTP simple et fait confiance aux en-têtes X-Forwarded-* du proxy.

Options disponibles​

Toutes ces options s'appliquent à la commande run.

OptionDéfautDescription
--domain <nom>(aucun)Le nom d'hôte public. Obligatoire avec --lets-encrypt et --ssl-cert.
--port <port>8765Le port d'écoute.
--server-ip <ip>(détectée)Écouter sur une adresse IP locale précise. Par défaut, le serveur écoute sur toutes les interfaces.
--lets-encryptfalseObtenir et renouveler un certificat Let's Encrypt. Demande --domain.
--ssl-cert <chemin>(aucun)Le chemin d'un certificat personnel (PEM). Demande --ssl-key et --domain.
--ssl-key <chemin>(aucun)Le chemin de la clé privée du certificat. Demande --ssl-cert et --domain.
--disable-httpsfalseServir en HTTP simple. Derrière un proxy inverse.
--worker-modefalseActiver le mode worker de FrankenPHP pour plus de débit (PHP reste chargé entre les requêtes).
--worker-threads <n>2Le nombre de threads worker FrankenPHP quand --worker-mode est activé.
--messenger-workers <n>1Le nombre de workers d'arrière-plan. 0 pour n'en lancer aucun dans ce processus.
--log-format <format>consoleconsole pour une sortie lisible, json pour des journaux structurés.
--enable-metricsfalsePublier des métriques Prometheus sur /metrics, sur un port dédié.
--metrics-port <port>9090Le port des métriques.
--skip-introfalseMasquer la bannière de démarrage.

Autres commandes​

./augias console <commande> # lancer une commande console Symfony (par exemple cache:clear)
./augias worker --workers=2 # processus worker dédié (par exemple pour Kubernetes)
./augias version # afficher la version
./augias build-info # afficher le détail de la compilation

Vérifier l'état​

curl http://localhost:8765/health

Renvoie OK (HTTP 200) quand l'application tourne.

Mettre à jour​

Remplacez le binaire par la dernière version et relancez-le. Vos données sont rangées à part du binaire : une mise à jour ne touche ni vos factures, ni vos clients, ni vos réglages.

SystèmeConfiguration et base SQLiteJustificatifs
Linux~/.config/Augias/env~/.config/Augias/attachments
macOS~/Library/Application Support/Augias/env~/Library/Application Support/Augias/attachments
Windows%AppData%\Augias\env%AppData%\Augias\attachments

Ce sont les dossiers à sauvegarder. Réglez AUGIAS_CONFIG_DIR et AUGIAS_ATTACHMENTS_DIR pour les placer ailleurs. ~/.Augias/ ne contient que l'application décompressée par le binaire, une copie par version.

Depuis la 4.0.0

Le binaire 4.0.0 gardait vos données dans l'application décompressée, sous ~/.SolidInvoice/, dans un dossier qui change à chaque version. Le premier lancement d'un binaire plus récent les copie dans les dossiers ci-dessus et le signale. L'ancienne copie reste en place ; supprimez ~/.SolidInvoice/ après avoir vérifié que tout y est.

Mode worker (fort trafic)​

Pour une instance au trafic soutenu, activez le mode worker :

./augias run --worker-mode --worker-threads=4 --messenger-workers=5

Le mode worker garde les processus PHP en vie entre les requêtes, ce qui réduit nettement la latence au prix d'une consommation de mémoire plus élevée.