octopus -Download - octopus -Quellcode -Download

octopus

Anderer Quellcode

1.0.0

Herunterladen

Oktopus

Octopus ist eine serverlose, einfach zu setzende interne Wiki-Seite mit integrierten Software-Diagrammen. Es verwendet Markdown zum Schreiben von Inhalten und verbessert es mit GraphViz und Flowchart.js -Diagrammen für einfache Softwaredokumentation.

Hier ist eine Standard -Wiki -Seite:

Technologie

Octopus ist eine Jamstack -App, die Google Firebase als Backend verwendet. Sie benötigen keinen Webserver (z. B. Apache) oder eine Datenbank (wie MySQL), um sie zum Einsatz zu bringen. Sie können die App mit Netlify kostenlos für CDN für kostenlos bereitstellen.

Mit Oktopus können Sie:

verlangen, dass Benutzer angemeldet werden, um das Wiki zu lesen oder zu bearbeiten (unterstützte Anbieter: Google, Github, E -Mail/Passwort, Twitter und Telefon),
Erstellen Sie Zugriffsregeln für das Lesen und Bearbeiten (beschränken Sie bestimmte Benutzer oder Auth -Domänen).
Host Wiki -Seite unter einer benutzerdefinierten Domain.

Merkmale

Erstellen Sie neue Wiki -Seiten mit Markdown -Sprache.
Menü bearbeiten (mit Markdown), um einfach mit Wiki -Seiten zu verknüpfen.
Geben Sie Graphviz und Flowdiagramm.js -Diagramme in Ihren Markdown -Inhalt ein.
Sehen Sie, wer gerade Ihre Wiki -Artikel liest,
Passen Sie Ihr Wiki-Front-End mit React (erstellen reag-app) ein.

Beispielsystemdiagramm

Seitenbearbeitung mit Markdown

Installation

Klonen Sie dieses Repository auf Ihren Computer.
Kopieren Sie die Konfigurationsvorlagendatei ( src/config/config.template.js ) in src/config/config.js .

cp src/config/config.template.js src/config/config.js

Hinweis: Sie können src/config/config.js -Datei sicher an einem Repository eingehen. Diese Datei speichert keine sensiblen Anmeldeinformationen - alle Konfigurationsvariablen sind ohnehin in der .js -Datei öffentlich verfügbar.

Erstellen Sie hier ein neues Firebase -Projekt: https://firebase.google.com/
Wählen Sie "Firebase in Ihre Web -App hinzufügen" und kopieren Sie die Konfiguration in src/config/config.js die in Schritt 2 erstellt wurden.

Gehen Sie in Firebase Console zur Authentifizierung > Anmeldemethode , wählen Sie einen Anbieter aus und aktivieren Sie ihn. Octopus wurde mit Google und Github -Anbietern getestet.

Fügen Sie im Abschnitt Authentifizierung > Anmeldemethode die Domäne hinzu, die Ihre App in der Liste der autorisierten Domänen hostet.

Erstellen Sie die App:

npm install
npm run build

Stellen Sie das build/ Verzeichnis in Ihrem Webserver bereit.

Serverlose Bereitstellung

Sie können das Hosting der App auf Ihrem Webserver überspringen (Schritt 8 aus dem Installationshandbuch oben). Alles, was Sie brauchen, ist, die App für einen Cloud-basierten CDN-Anbieter bereitzustellen.

Wir empfehlen die Verwendung von Netlify.

Nach jedem Commit werden Ihr Forked Octopus Github Repo automatisch für die Produktion bereitgestellt. Es wird auch eine nutzende URL vorbereiten, auf die alle Benutzer sofort zugreifen können. Später können Sie eine benutzerdefinierte Domain einrichten, damit sie professioneller aussieht.

Hinweis: Wenn Sie Octopus über Netlify bereitstellen, geben Sie die folgenden Details im Setup -Assistenten ein:

Befehl erstellen: npm run build
Veröffentlichung Verzeichnis: build

Sicherheit

Standardmäßig kann jeder Benutzer Ihre Wiki -Seite anzeigen und bearbeiten. Wahrscheinlich ist das nicht das, was Sie erwarten!

Um Ihren Inhalt nur für Ihr Unternehmen zugänglich zu machen, gehen Sie zu Firebase Console > Datenbank > Regeln und beschränken Sie, wer Ihre Wiki -Seite lesen und bearbeiten kann.

Hier ist eine Beispielregel, wenn Sie Google Sign-In-Anbieter verwenden und Ihre Unternehmens-E-Mail-Adresse endet mit @livechatinc.com :

{
  "rules": {
    ".read": "auth.token.email.endsWith('@livechatinc.com')",
    ".write": "auth.token.email.endsWith('@livechatinc.com')"
  }
}

Sie können mehr über mögliche Sicherheitsregeln in der Dokumentation von Echtzeitdatenbankregeln lesen.

Mit Oktopus

Octopus ist so konzipiert, dass es sehr einfach zu bedienen ist.

Um eine neue https://<your-octopus-domain>/test/new-page zu erstellen, geben Sie einfach die URL ein, die Sie erstellen möchten. Wenn eine solche Seite noch nicht erstellt wurde, sehen Sie den folgenden Bildschirm:

Wenn Sie auf "Auf dieser Seite erstellen" klicken, wird eine neue Seite erstellt und mit Standardinhalt ausgefüllt, und bereit zu bearbeiten:

Sobald die Seite fertig ist, können Sie sie problemlos in das Menü aufnehmen:

Das war's. Senden Sie alle Ihre Teamkollegen an Octopus und sie sind bereit, einen Beitrag zu leisten!

Projekthintergrund

Warum haben wir Tintenfische gebaut?

Wir hatten Probleme, eine benutzerfreundliche Software für die Dokumentation interner Systeme bei Livechat zu finden.

Wir wollten, dass es einfach für nicht-technische Menschen beitragen und leicht bearbeitbare Software-Diagramme einbeziehen. Wir konnten kein zufriedenstellendes Produkt finden, also haben wir eines gebaut.