Accueil/Article
Esadax JournalApps

Aperçu général

Qu'est-ce que Outline? Outline est une plateforme de documentation et de base de connaissances moderne et collaborative conçue pour aider les équipes à créer, organiser et partager des informations

Aperçu général logo

Qu'est-ce que Outline?

Outline est une plateforme de documentation et de base de connaissances moderne et collaborative conçue pour aider les équipes à créer, organiser et partager des informations dans un espace de travail centralisé.

Il fournit un environnement de document structuré où les utilisateurs peuvent rédiger de la documentation technique, des manuels internes, des guides d'intégration, des procédures opérationnelles standard, des notes de projet et des connaissances organisationnelles.

Outline combine un éditeur de texte riche avec prise en charge de Markdown, des documents imbriqués, des collections, une recherche en texte intégral et une édition collaborative en temps réel.

Son interface permet aux équipes de gérer facilement la documentation partagée tout en contrôlant qui peut accéder aux documents et collections individuels, les modifier et les gérer.

La plateforme fournit également des intégrations, des API et des options d'authentification qui permettent aux organisations de connecter leur base de connaissances à l'infrastructure existante.

Outline est particulièrement adapté aux équipes de développement, aux entreprises, aux services informatiques et aux organisations qui ont besoin d'un emplacement centralisé pour maintenir la documentation interne.

Histoire de Outline

Outline a été créé pour fournir aux équipes une alternative moderne aux plateformes wiki et de documentation traditionnelles.

Le projet vise à rendre la documentation accessible, collaborative et facile à maintenir grâce à une interface propre et à une organisation structurée des documents.

Construit principalement avec TypeScript, React et Node.js, Outline combine une application Web avec une architecture backend conçue pour prendre en charge l'édition collaborative et les déploiements évolutifs.

Le projet a évolué pour inclure les collections de documents, la collaboration en temps réel, les autorisations, les intégrations, la recherche et la fonctionnalité API.

Outline est disponible sous forme de service hébergé et de déploiement auto-hébergé.

Remarque sur les licences: Le référentiel source actuel utilise la licence Business Source License 1.1 (BSL 1.1), qui est disponible en source plutôt qu'une licence open-source approuvée par l'OSI. La licence inclut des restrictions d'utilisation supplémentaires, en particulier concernant les services de documents tiers. Consultez les conditions de licence avant d'utiliser Outline en tant que service hébergé commercial.

Principales caractéristiques de Outline

Outline fournit un ensemble complet d'outils pour créer et gérer la documentation organisationnelle.

  • Éditeur de documents collaboratif: Créez et modifiez des documents à l'aide d'un éditeur de texte enrichi moderne.
  • Collaboration en temps réel: Permettre à plusieurs utilisateurs de travailler sur des documents simultanément.
  • Collections de documents: Organisez la documentation en collections structurées.
  • Documents imbriqués: Créez des structures de documents hiérarchiques pour des sujets complexes.
  • Prise en charge de Markdown: Écrire et formater la documentation en utilisant Markdown.
  • Recherche en texte intégral : Localisez rapidement des informations dans des documents et des collections.
  • Autorisations de document: Contrôlez qui peut voir et modifier la documentation.
  • Gestion des utilisateurs: Organisez les membres de l'espace de travail et gérez les accès.
  • Commentaires et mentions: Discuter de la documentation et aviser les membres de l'équipe.
  • Historique du document: Examinez les révisions et les modifications précédentes du document lorsque l'édition le permet.
  • Modèles: Créez des structures de documents réutilisables.
  • Pièces jointes: Télécharger des images et d'autres fichiers à la documentation.
  • Importer et exporter: Déplacez la documentation dans et hors de la plate-forme en utilisant les formats pris en charge.
  • Accès API: Intégrez Outline avec des applications externes et des flux de travail automatisés.
  • Authentification externe: Prend en charge l'authentification via des fournisseurs tels que Google, Microsoft, Slack et des fournisseurs d'identité compatibles.
  • Intégrations: Connectez les workflows de documentation avec des services externes.
  • Espace de travail personnalisable: Configurez les paramètres de l'espace de travail et l'organisation de la documentation.
  • Déploiement Docker: Hébergez l'application en utilisant Docker et Docker Compose.

Cas d'utilisation

Outline convient aux organisations et aux équipes qui ont besoin d'une plate-forme de gestion des connaissances centralisée.

Les cas d'utilisation courants incluent:

  • Documentation interne: Maintenir les politiques de l'entreprise, les procédures et la documentation opérationnelle.
  • Documentation technique: Documenter l'infrastructure, les API, l'architecture logicielle et les processus de développement.
  • Base de connaissances informatiques: Organiser les configurations de serveur, la documentation réseau, les procédures de dépannage et les guides opérationnels.
  • Intégration des employés: Créez des documents d'intégration, des manuels pour les employés et de la documentation de formation.
  • Équipes de développement: Maintenir les normes de codage, les instructions de déploiement et les lignes directrices de développement.
  • Documentation du projet: Organiser les exigences du projet, les spécifications techniques et les notes de mise en œuvre.
  • Soutien à la clientèle: Maintenir les guides de soutien interne et la documentation de dépannage.
  • Procédures opérationnelles normalisées: Documenter les processus opérationnels récurrents et les flux de travail opérationnels.
  • Collaboration d'équipe: Partagez les connaissances entre les départements et les unités organisationnelles.
  • Administration du système: Maintenir les inventaires d'infrastructure, les références de configuration et les procédures d'incident.

Avantages de Outline

  • Gestion centralisée des connaissances pour les équipes
  • Interface de documentation moderne et intuitive
  • Édition collaborative en temps réel
  • Collections structurées et documents imbriqués
  • Recherche puissante en plein texte
  • Documentation compatible avec Markdown
  • Autorisations d'accès configurables
  • Intégrations d'authentification externe
  • Accès API pour l'automatisation et les intégrations
  • Pièces jointes et contenu intégré
  • Déploiement autohébergé basé sur Docker
  • Meilleur contrôle de la documentation et de l’infrastructure

Comment installer Outline

Pour installer Outline via Esadax, suivez ces étapes:

  1. Achetez l'application via Esadax.
  2. Après l'achat, vous serez invité à fournir les paramètres de configuration requis.
  3. Entrez l'URL de l'application publique et les détails de connexion à la base de données.
  4. Configurez Redis pour la mise en cache et les services d'application.
  5. Configurez les secrets de sécurité requis.
  6. Sélectionnez un stockage local ou compatible S3 pour les pièces jointes.
  7. Configurez un fournisseur d’authentification, tel que OIDC, Google, Microsoft ou une autre option prise en charge.
  8. Cliquez sur Déployer pour lancer l'application.
  9. Accédez à Outline via son URL d'application attribuée.
  10. Terminez l'authentification initiale et la configuration de l'espace de travail.
  11. Créez votre première collection de documents.
  12. Invitez les membres de l'équipe et configurez les autorisations d'accès.
  13. Commencez à créer et à organiser votre documentation.

Une fois configuré, Outline fournit un environnement centralisé pour gérer et partager les connaissances organisationnelles.

Gestion des documents

Les documents sont les blocs de construction primaires de Outline.

Les utilisateurs peuvent créer des pages contenant du texte formaté, des en-têtes, des listes, des tableaux, des images, des liens, des blocs de code et d'autres contenus pris en charge.

Les documents peuvent être organisés en collections et hiérarchies imbriquées.

Par exemple, un service informatique peut organiser sa base de connaissances comme suit :

  • Infrastructure
    • Proxmox
    • Mise en réseau
    • Stockage
    • Procédures de sauvegarde
  • Développement
    • Documentation de l'API
    • Normes de codage
    • Guides de déploiement
  • Sécurité
    • Gestion des accès
    • Réponse aux incidents
    • Politiques de sécurité
  • Opérations
    • Surveillance
    • Maintenance
    • Troubleshooting

Cette structure facilite la tenue à jour de la documentation et la localisation des informations à mesure que la base de connaissances se développe.

Les documents peuvent être mis à jour en continu à mesure que les systèmes, les processus et les exigences organisationnelles changent.

Collections et organisation

Outline utilise des collections pour organiser les documents associés en groupes logiques.

Une collection peut représenter un département, un projet, un sujet technique ou toute autre catégorie de documentation.

Les administrateurs et les utilisateurs autorisés peuvent créer des collections et configurer leurs autorisations d'accès.

Les structures de collecte typiques comprennent:

  • Documentation de l'entreprise
  • Ingénierie
  • Infrastructure
  • Ressources humaines
  • Soutien à la clientèle
  • Documentation du produit
  • Procédures internes
  • Connaissance du projet

Les collections permettent de séparer différents domaines de connaissances organisationnelles tout en gardant tout accessible via un espace de travail.

Les documents peuvent également être imbriqués dans d'autres documents pour créer des hiérarchies d'informations plus détaillées.

Éditeur de documents collaboratif

Outline comprend un éditeur de texte riche conçu pour la création et la maintenance de la documentation.

Les utilisateurs peuvent écrire du contenu sans formater manuellement le HTML ni gérer les fichiers de documents.

L'éditeur prend en charge:

  • Titres et paragraphes
  • Mise en forme Markdown
  • Listes à puces et numérotées
  • Tableaux
  • Blocs de code
  • Images et pièces jointes
  • Liens et contenus intégrés
  • Citations et légendes
  • Listes de contrôle
  • Mise en forme du texte et éléments en ligne

L'éditeur prend également en charge la collaboration en temps réel, permettant à plusieurs membres de l'équipe de travailler sur le même document.

Les modifications sont synchronisées entre les utilisateurs connectés, facilitant la collaboration sur les guides techniques, les procédures et la documentation partagée.

Ceci est particulièrement utile pour la maintenance de la documentation qui nécessite l'apport de plusieurs départements ou contributeurs.

Recherche et découverte de connaissances

Outline fournit une fonctionnalité de recherche en texte intégral pour localiser des informations dans la base de connaissances.

Au lieu de naviguer manuellement dans les collections et les pages imbriquées, les utilisateurs peuvent rechercher des mots-clés et de la documentation pertinente.

La recherche est utile pour trouver:

  • Procédures techniques
  • Configurations de l'infrastructure
  • Instructions de dépannage
  • Politiques internes
  • Documentation du projet
  • Références des API
  • Matériels d'intégration des employés

Une base de connaissances bien organisée combinée à une recherche efficace réduit le temps nécessaire pour trouver des informations.

Les équipes peuvent utiliser Outline comme système de référence centralisé pour les connaissances opérationnelles et techniques.

Gestion des utilisateurs et autorisations

Outline fournit des fonctionnalités de gestion des utilisateurs et des accès pour contrôler la participation à un espace de travail.

Les administrateurs de l’espace de travail peuvent gérer les membres et attribuer les rôles appropriés.

Selon l'édition et les autorisations configurées, l'accès peut être contrôlé par:

  • Adhésion à un espace de travail
  • Rôles des utilisateurs
  • Permissions de collection
  • Paramètres d'accès aux documents
  • Accès des invités
  • Privilèges administratifs

Cela permet aux organisations de maintenir différents niveaux d'accès pour les employés, les gestionnaires, les administrateurs et les collaborateurs externes.

Par exemple, la documentation technique peut être partagée avec les équipes d’ingénierie tandis que la documentation RH reste accessible uniquement au personnel autorisé.

Outline prend également en charge l'authentification via des fournisseurs d'identité externes plutôt que de maintenir son propre système d'authentification par e-mail et mot de passe traditionnel.

Authentification et authentification unique

Outline prend en charge plusieurs méthodes d'authentification pour connecter les utilisateurs à un fournisseur d'identité existant.

Les options d'authentification prises en charge comprennent:

  • Authentification par Google
  • Authentification Microsoft
  • Authentification de Slack
  • Connexion par e-mail à l'aide de liens ou de codes de vérification
  • Connexion OpenID (OIDC)
  • Authentification SAML dans les éditions sous licence

La disponibilité des méthodes d'authentification individuelles dépend de l'édition sélectionnée.

Pour les installations auto-hébergées, un fournisseur d'authentification doit être configuré avant que les utilisateurs puissent se connecter.

Outline ne stocke pas les mots de passe utilisateur classiques. L'authentification est gérée par le biais de fournisseurs connectés, de clés d'accès lorsque cela est pris en charge ou de liens de connexion et de codes de vérification envoyés par e-mail.

L'intégration à un système de gestion des identités existant est donc particulièrement utile pour les organisations qui utilisent déjà une authentification centralisée.

Intégrations et API

Outline fournit des fonctionnalités d'intégration qui permettent à la base de connaissances de fonctionner avec d'autres outils d'affaires et de développement.

Son API REST permet aux applications externes d'interagir avec des documents, des collections, des utilisateurs et d'autres ressources prises en charge.

Les scénarios d'intégration courants incluent:

  • Création automatique de la documentation.
  • Récupération de documents pour des applications externes.
  • Synchronisation des informations entre les systèmes.
  • Intégrer des outils de développement internes.
  • Création d'interfaces de documentation personnalisées.
  • Automatiser les tâches de gestion des connaissances.
  • Connexion des workflows de documentation aux services externes.

Outline fournit également des intégrations avec des plateformes telles que Slack, permettant aux équipes d’accéder à la documentation et de recevoir des notifications pertinentes via leurs outils de communication existants.

L'authentification API utilise les informations d'identification API configurées et les autorisations d'accès appropriées.

Pièces jointes et stockage

Outline prend en charge le téléchargement de fichiers et l'intégration d'images et d'autres pièces jointes dans les documents.

Les fichiers peuvent être stockés localement sur le serveur d'applications ou via un service de stockage d'objets compatible S3.

Les configurations de stockage prises en charge incluent:

  • Stockage du système de fichiers local
  • Avis sur Amazon S3
  • MinIO
  • Autres services de stockage d'objets compatibles pris en charge par l'API S3 configurée

Le stockage local convient aux déploiements simples dans lesquels les fichiers sont conservés parallèlement à l'infrastructure de l'application.

Le stockage compatible S3 est utile pour les installations plus importantes, les environnements distribués et les déploiements nécessitant un stockage d'objets indépendant.

Pour un fonctionnement fiable:

  • Configurez le stockage persistant pour les pièces jointes locales.
  • Utilisez un compartiment de stockage d'objets approprié lorsque vous utilisez S3.
  • Configurez les limites de taille de téléchargement.
  • Protégez les identifiants de stockage.
  • Inclure les pièces jointes dans les procédures de sauvegarde.
  • Vérifiez les autorisations de stockage et les stratégies d'accès.

Recherche, commentaires et notifications

Outline fournit des fonctionnalités de collaboration au-delà de l'édition de documents.

Les commentaires permettent aux membres de l’équipe de discuter du contenu du document et de fournir des commentaires.

Les mentions peuvent avertir des utilisateurs spécifiques lorsque leur attention est requise.

Ces capacités sont utiles pour :

  • Examen de la documentation technique
  • Demande de mise à jour des procédures
  • Discuter des détails de mise en œuvre
  • Coordination des modifications de la documentation
  • Révision des matériaux d'intégration
  • Partage des connaissances entre les départements

La livraison des notifications dépend des intégrations d'application et des paramètres de messagerie configurés.

Sécurité / Administration / Configuration

Étant donné que Outline stocke de la documentation interne et des informations organisationnelles potentiellement sensibles, il doit être déployé avec des contrôles de sécurité appropriés.

Les pratiques de sécurité importantes comprennent:

  • Utilisez des secrets d'application forts et générés aléatoirement.
  • Activez HTTPS pour tous les accès externes.
  • Configurez un fournisseur d'authentification approuvé.
  • Restreindre l'accès aux membres autorisés de l'espace de travail.
  • Configurez soigneusement les autorisations de collecte.
  • Protégez les services PostgreSQL et Redis.
  • Restreindre les ports de base de données à l'infrastructure de confiance.
  • Protégez les identifiants API.
  • Configurez un stockage de fichiers persistant et sécurisé.
  • Gardez les images et les dépendances de l'application à jour.
  • Sauvegardez régulièrement la base de données et les pièces jointes téléchargées.
  • Examinez périodiquement l'accès administratif.
  • Évitez d'exposer la documentation interne par le biais de collections accessibles au public.

Outline prend également en charge les secrets basés sur des fichiers pour les déploiements Docker. Les variables d'environnement sensibles peuvent être fournies via les secrets Docker en utilisant la variable de configuration _FILE correspondante.

Pour les déploiements de production, conservez des copies sécurisées de tous les secrets de chiffrement et d'application. La perte de ces valeurs peut affecter la capacité à déchiffrer des informations précédemment protégées.

Meilleures pratiques pour Outline

  • Organisez les documents en collections significatives.
  • Utilisez des titres de documents descriptifs.
  • Établir des normes de documentation cohérentes.
  • Créez des modèles de documents réutilisables.
  • Attribuez des autorisations de collecte en fonction des responsabilités de l'équipe.
  • Examiner et mettre à jour la documentation régulièrement.
  • Utilisez les commentaires et les mentions pour coordonner les modifications.
  • Gardez la documentation technique alignée sur l'infrastructure réelle.
  • Intégrez l'authentification à un fournisseur d'identité existant.
  • Configurez HTTPS pour l'accès externe.
  • Utilisez le stockage persistant pour les pièces jointes.
  • Sauvegardez PostgreSQL et les fichiers téléchargés.
  • Protégez les secrets d'application et les informations d'identification API.
  • Épinglez les versions d'application plutôt que de vous fier aux dernières balises non qualifiées.
  • Testez les mises à jour des applications avant de les déployer en production.

Paramètres de configuration

Après avoir acheté cette application sur Esadax, vous serez invité à fournir les paramètres de configuration requis par le déploiement.

Esadax ajoute les variables fournies au déploiement afin que l'application puisse être lancée avec la configuration requise.

Outline prend en charge la configuration via des variables d'environnement ou un fichier d'environnement Docker.

Les variables suivantes sont considérées comme la configuration minimale pour une installation standard auto-hébergée:

Paramètre Description :
URL URL publique entièrement qualifiée utilisée pour accéder à l'installation Outline.
DATABASE_URL URL de connexion PostgreSQL, incluant le nom d'hôte, le nom de la base de données, le nom d'utilisateur et le mot de passe.
REDIS_URL URL de connexion Redis utilisée pour la mise en cache et les services d'application.
SECRET_KEY Secret généré aléatoirement utilisé pour la sécurité des applications et les fonctionnalités liées au chiffrement.
UTILS_SECRET Secret aléatoire supplémentaire utilisé par les fonctions d'utilité et de sécurité de Outline.
PORT Port d'application interne. La valeur par défaut est 3000.
NODE_ENV Environnement de l'application, généralement défini sur production.
DEFAULT_LANGUAGE Langue d'interface par défaut.

Paramètres d'authentification

Au moins un fournisseur d’authentification doit être configuré avant que les utilisateurs puissent se connecter.

Selon le fournisseur choisi, des variables supplémentaires peuvent inclure:

Paramètre Description :
GOOGLE_CLIENT_ID ID client de l'application Google OAuth.
GOOGLE_CLIENT_SECRET Google OAuth application secrète.
SLACK_CLIENT_ID ID client de l'application Slack.
SLACK_CLIENT_SECRET Slack application secret.
OIDC_CLIENT_ID Identifiant client OpenID Connect.
OIDC_CLIENT_SECRET OpenID Connect client secret.
OIDC_AUTH_URI Point de terminaison d'autorisation OpenID Connect.
OIDC_TOKEN_URI Point de terminaison de jeton OpenID Connect.
OIDC_USERINFO_URI Point de terminaison d'informations utilisateur OpenID Connect.
SMTP_HOST Nom d'hôte du serveur SMTP pour l'authentification par e-mail.
SMTP_PORT Port du serveur SMTP.
SMTP_USERNAME Nom d'utilisateur d'authentification SMTP.
SMTP_PASSWORD Mot de passe d'authentification SMTP.

Paramètres de stockage de fichiers

Outline prend en charge le stockage de système de fichiers local et le stockage d'objets compatible S3.

Les options de configuration courantes incluent:

Paramètre Description :
FILE_STORAGE Moteur de stockage, soit local ou s3.
FILE_STORAGE_LOCAL_ROOT_DIR Répertoire utilisé pour le stockage local des fichiers. La valeur par défaut est /var/lib/outline/data.
FILE_STORAGE_UPLOAD_MAX_SIZE Taille maximale autorisée des pièces jointes en octets.
AWS_REGION Région de stockage d'objets AWS ou compatible.
AWS_ACCESS_KEY_ID Clé d'accès au stockage d'objets.
AWS_SECRET_ACCESS_KEY Clé secrète de stockage d'objets.
AWS_S3_UPLOAD_BUCKET_NAME Bucket utilisé pour les fichiers téléchargés.
AWS_S3_UPLOAD_BUCKET_URL URL publique ou CDN associée au compartiment.
AWS_S3_FORCE_PATH_STYLE Contrôle l'adressage de type chemin d'accès pour les fournisseurs de stockage compatibles.

Une configuration supplémentaire peut être requise en fonction du fournisseur d'authentification, du service SMTP et du moteur de stockage sélectionné.

Les paramètres de configuration exacts dépendent du package de déploiement Esadax. Utilisez les valeurs présentées lors du processus d'achat et de déploiement.

Important: Générez des valeurs aléatoires uniques pour SECRET_KEY et UTILS_SECRET. Gardez-les stables après le déploiement et stockez des sauvegardes sécurisées. Leur modification peut invalider les sessions ou affecter l'accès aux données d'application chiffrées.

Une fois les valeurs requises configurées, cliquez sur Déployer pour lancer Outline.

Exigences en matière de base de données et d'infrastructure

Outline utilise PostgreSQL comme base de données principale et Redis pour la mise en cache et la prise en charge des services d'application.

Un déploiement auto-hébergé standard comprend généralement:

  • Outline Application: Exécute l'interface Web, l'API, la gestion des documents et les services d'application.
  • PostgreSQL: Stocke les utilisateurs, les documents, les collections, les permissions et les métadonnées d'application.
  • Redis: Fournit des services de mise en cache et de soutien.
  • Stockage de fichiers: Stocke les pièces jointes et les médias téléchargés.
  • Proxy inverse: Fournit la terminaison HTTPS et l'accès externe.

Le déploiement Docker officiel expose l'application Outline en interne sur le port 3000.

Le stockage persistant doit être configuré pour les téléchargements de fichiers locaux en utilisant:

/var/lib/outline/data

Pour les installations plus importantes, un stockage d'objets externe compatible S3 peut être utilisé à la place.

Outline est conçu pour prendre en charge l'évolutivité horizontale, mais les déploiements de production nécessitent une configuration minutieuse de la base de données, de Redis, du stockage et des services de collaboration.

Collaboration et évolutivité en temps réel

L'une des caractéristiques distinctives de Outline est l'édition collaborative de documents en temps réel.

Plusieurs utilisateurs peuvent travailler sur le même document pendant que les modifications sont synchronisées via le service de collaboration.

Pour les déploiements standard, le service de collaboration fonctionne dans le cadre du processus d'application.

Pour les installations plus importantes avec plusieurs instances d'applications, Outline prend en charge la synchronisation basée sur Redis via la variable de configuration REDIS_COLLABORATION_URL.

Cela permet de coordonner les événements de collaboration entre plusieurs processus.

L'API, le Web et les processus de travail peuvent également être mis à l'échelle indépendamment si nécessaire.

L'architecture appropriée dépend des utilisateurs simultanés, de l'activité des documents, du volume des pièces jointes et des ressources d'infrastructure.

Licences et éditions

Outline fournit différentes options de licence pour les déploiements hébergés et auto-hébergés.

Le dépôt source actuel utilise la licence Business Source License 1.1.

La licence autorise des utilisations spécifiques, y compris l'utilisation interne de l'organisation, mais restreint l'offre de Outline en tant que service de documents commerciaux à des tiers sans un accord de licence approprié.

Outline propose également des éditions commerciales Business et Enterprise avec des fonctionnalités, des intégrations et un support supplémentaires.

Avant d'utiliser Outline dans un environnement d'hébergement commercial ou de l'offrir à des clients externes, consultez les exigences actuelles en matière de licence et d'édition.

IV. CONCLUSION

Outline est une base de connaissances collaborative moderne conçue pour aider les équipes à créer, organiser et gérer la documentation dans un environnement centralisé.

Avec des collections structurées, des documents imbriqués, une édition en temps réel, une recherche en texte intégral, des contrôles d'accès, des intégrations d'authentification et une prise en charge des API, il fournit une plate-forme complète pour la gestion des connaissances organisationnelles.

Son modèle de déploiement auto-hébergé permet aux organisations d'exploiter leur propre infrastructure de documentation tout en conservant le contrôle des données d'application et des fichiers téléchargés.

Outline est une solution adaptée pour les équipes de développement, les services informatiques, les entreprises et les organisations à la recherche d'une alternative structurée et collaborative aux plateformes wiki traditionnelles.

S’abonner