BookStack - An open-source wiki based on the âbookshelfâ concept đ
"BookStack istis einea moderne,modern, openâopen-source Wikiâ/Dokumentationsplattform,wiki/documentation dieplatform Wissenthat bewusstdeliberately organizes knowledge nichtnot alsas losea Seitensammlungloose organisiert,collection sondernof inpages, einerbut sehrusing intuitivena Metapher:very intuitive metaphor: Regale (Shelves)Shelves, BĂŒcher (Books)Books, KapitelChapters, (Chapters) undand Seiten (Pages)Pages. GenauThis diesestructure Strukturis machtexactly what makes BookStack fĂŒr viele Teams so attraktivappealing âto besondersmany dann,teamsâespecially wennwhen Inhaltecontent needs to remain verstĂ€ndlichclearly gegliedertorganized undand leichteasy auffindbarto find bleiben sollen..
Technisch basiertTechnically, BookStack aufis dembuilt on the PHPâFrameworkLaravel LaravelPHP framework undand wirdis unterreleased derunder the MITâLizenzMIT License. veröffentlicht.It Esruns lĂ€uft plattformunabhĂ€ngigplatform-independently (typisch:typically: LinuxâServer,Linux VMserver, oderVM, Container)or undcontainer) istand can be used mehrsprachigmultilingually nutzbar..
WarumWhy BookStack? âš
VieleMany Wikiswikis sindare extremextremely flexibelflexibleâbut âthat aberfreedom geradeoften dieseleads Freiheitto fĂŒhrt oft zu Wildwuchs.sprawl. BookStack verfolgttakes einena etwasslightly anderendifferent Ansatz:approach:
KlareClearInformationsarchitekturinformation architecturestattinsteadendloserofKategorienendlessundcategoriesNamenskonventionenand naming conventionsSchnellerQuickEinstiegonboardingfĂŒrforNichtâTechniker:innennon-technical users (the UIundandBedienlogikinteractionsindlogicâselbsterklĂ€rendâare âself-explanatoryâ)TeamâtauglichTeam-readydurchthroughRollen,roles,Rechtepermissions,undandnachvollziehbaretraceableĂnderungenchanges
Kurz:In short: BookStack istis besondersespecially stark,strong wennwhen ihryou einwant to cleanly structure an internesinternal Nachschlagewerk, eine TeamâDokumentationreference, ProzesshandbĂŒcherteam documentation oder, Projektwissenprocess manuals, sauberor strukturierenproject wollt.knowledge.
EinordnungContext & GeschichteHistory đ°ïž
BookStack wurdewas started in 2015 vonby Dan Brown gestartet(not the novelist, but an English web developer). Early on, the project briefly had a different name (nicht der Romanautor, sondern ein englischer Webentwickler). In der FrĂŒhphase trug das Projekt kurzzeitig einen anderen Namen (âOxbowââOxbowâ), wurdebut aberit schnellwas inquickly renamed to BookStack. umbenannt.Over Ăberthe dieyears Jahreit reiftematured escontinuouslyâincluding kontinuierlichmajor âUI inklusive gröĂerer UIâVerbesserungenimprovements (u.âŻa.among fĂŒrother things for mobile Nutzung)use)âand âafter unda verlieĂlong nachdevelopment lĂ€ngererperiod Entwicklungit schlieĂlicheventually dieleft BetaâPhase.the beta phase.
Heute giltToday, BookStack alsis einesconsidered derone bekanntestenof the best-known PHPâbasiertenPHP-based WikiâProjektewiki projects imin OpenâSourceâUmfeld,the mitopen-source aktiverspace, Communitywith undan regelmĂ€Ăigemactive ReleaseâZyklus.community and a regular release cycle.
Kernkonzept:Core InhalteConcept: Content in vierFour EbenenLevels đ§±
DieThe Strukturstructure istis bewusstintentionally begrenztlimitedâand âthatâs unda das ist eine StĂ€rke:strength:
Regale (Shelves)ShelvesdienenservealsasĂŒbergeordneteaSammlunghigher-level collection (z.âŻB. âITâe.g.,âHRâ,âIT,ââProduktionââHR,â âProductionâ)
BĂŒcher (Books)BooksthematischethematicEinheitenunits (z.âŻB. âOnboardingâe.g.,âRunbooksâ,âOnboarding,ââSicherheitsrichtlinienââRunbooks,â âSecurity Policiesâ)
Kapitel (Chapters)Chapters (optional)zusÀtzlicheadditionalGliederungstructureinnerhalbwithineinesaBuchesbook
Seiten (Pages)PagesdertheeigentlicheactualContent:content:Anleitungen,guides,Standards,standards, FAQs,Checklistenchecklists,usw.etc.
PraktischAlso ist auch:practical: BĂŒcherBooks könnencan inbe mehrerenplaced Regalenon liegenmultiple shelvesâhelpful âwhen hilfreich,content wennshould Inhaltebe mehrerenassigned Bereichento zugeordnetmultiple werdenareas sollen,without ohneduplicating sie zu duplizieren.it.
Bearbeiten:Editing: WYSIWYG undand Markdown âïž
BookStack bietettypically typischerweiseoffers zweitwo Arbeitsweisen:ways of working:
WYSIWYGâEditorWYSIWYG editorfĂŒrforschnelle,quick,visuellevisualBearbeitungediting (idealfĂŒrforvielemanyTeams)teams)MarkdownâEditorMarkdown editorinklusiveincludingLiveâVorschaulivefĂŒrpreviewMenschen,fordiepeoplelieberwhoâtextbasiertâpreferschreibenwriting âtext-basedâ
DazuOn kommentop Funktionen,of diethat, imthere Alltagare vielfeatures Zeitthat sparen:save a lot of time in day-to-day work:
Versions-/RevisionshistorieVersion/revision history (ĂnderungentracknachvollziehenchangesundandbeirollBedarfbackzurĂŒckrollen)if needed)Medien-/BildverwaltungMedia/image managementDirektlinksDirect linkszutokonkretenspecificAbsĂ€tzenparagraphs (praktischusefulfĂŒrforSupportsupportundandDiskussionen)discussions)VolltextsucheFull-text searchĂŒberacrossBĂŒcher,books,Kapitelchapters,undandSeitenpages
OrganisationOrganization & Rechte:Permissions: gemachtBuilt fĂŒrfor Teams đ„đ
EinA groĂermajor Pluspunktadvantage istis dasthe Rollen-roles undand Berechtigungssystempermissions system. DamitIt lĂ€sstallows sich sehrvery granular steuern,control werover waswho darfcan âdo zumwhatâfor Beispiel:example:
Inhalte nur lesenread-only vs.bearbeiteneditbestimmterestrictBĂŒcher/Regalecertainnurbooks/shelvesfĂŒrtoeinzelnespecificGruppengroupsAktionenlimitwieactionsLöschen,suchExportierenasoderdeleting,Rechteverwaltungexporting,einschrĂ€nkenor managing permissions
DasThis machtmakes BookStack sowohlinteresting fĂŒrfor both kleinesmall Teamsteams als auch fĂŒrand gröĂerelarger Organisationenorganizations interessant,that diewant âeinâa Wikiwiki fĂŒrfor alleâeveryoneâ wollen,without ohnelosing dabei die Kontrolle zu verlieren.control.
AuthentifizierungAuthentication & SSOâAnbindungSSO Integration đ
NebenIn klassischemaddition Loginto perclassic login via EâMail/Passwortemail/password kann, BookStack can (jedepending nachon Setup)the auchsetup) inbe bestehendeintegrated Unternehmensumgebungeninto integriertexisting werden,corporate z.âŻB.environments, ĂŒber:e.g., via:
- LDAP/
DirectoryâAnbindungdirectory integration SSOânaheSSO-likeVerfahrenmethodsbzw.orexterneexternalProviderproviders (typisch:typically: OAuth/OIDCâbasierteOIDC-basedLogins,logins,jedependingnachonKonfiguration)configuration)
DamitThis lĂ€sstoften sichlets BookStack hĂ€ufigfit gutwell ininto vorhandeneexisting IdentitĂ€tslandschaftenidentity einpassenlandscapesâan âimportant eincriterion wichtigesfor Kriteriuman fĂŒrâenterprise âEnterpriseâFeelingâfeelâ ohnewithout EnterpriseâLizenzkosten.enterprise license costs.
Installation: klassischTraditional oderor pervia Docker đł
FĂŒrTo denrun Betriebit, werdenyou ĂŒblicherweisetypically benötigt:need:
- PHP (
LaravelâStack)Laravel stack) - MySQL/MariaDB
WebserverWeb server (z.âŻB.e.g., Nginx/Apache)- optional Git (
Updates)updates)undand Composer
VieleMany installierenpeople install BookStack heutetoday direktdirectly alsas a DockerâContainerDocker container, weilbecause dasit Setupmakes damitthe reproduzierbarsetup undreproducible Updatesand oftupdates einfacherare sindoften â besonderseasierâespecially in Homelabs,homelabs, KMUâSetupsSMB odersetups, beior SelfâHostingâFans.among self-hosting enthusiasts.
Erweiterbarkeit:Extensibility: ohneNo PluginâPlugin Chaos, aberStill trotzdem flexibelFlexible đ§©
BookStack hatdoes keinnot klassischeshave âPluginâĂkosystemâa wieclassic mancheâplugin andereecosystemâ Systeme.like Stattdessensome setztother essystems. aufInstead, kontrollierteit Erweiterungsmöglichkeiten,relies u.âŻa.:on controlled extension options, including:
RESTâREST APIfĂŒrforAutomatisierungautomationundandIntegrationenintegrations (CRUDaufonKernobjekte)core objects)ThemeâSystemeTheme systems (visuellvisualundandlogisch),logical)umtoOberflĂ€checustomizeundtheVerhalteninterfaceanzupassenand behaviorMöglichkeiten,Options to embedCustomcustomCode/code/HTMLeinzubettenandundinfluenceEditorâVerhalteneditorzu beeinflussenbehavior
DasAt wirktfirst zunĂ€chstthis wenigermay âAppâStoreâartigâ,seem istless aberâapp-store-like,â fĂŒrbut vielemany Adminsadmins angenehm:appreciate it: wenigerless Wildwuchssprawl, wenigerfewer InkompatibilitĂ€ten,incompatibilities, dafĂŒrand klarereclearer UpgradeâPfade.upgrade paths.
TypischeTypical EinsatzszenarienUse Cases â
BookStack funktioniertworks besondersparticularly gutwell fĂŒr:for:
InterneInternalWissensdatenbankenknowledge bases (ITâHowtos,IT how-tos, SOPs,Troubleshooting)troubleshooting)OnboardingâDokumentationOnboarding documentation (âSoâHowarbeitenwewirworkhierâhereâ)ProjektâProjectundandProduktdokumentationproduct documentationQualitĂ€tsmanagementQuality management /Prozessdokusprocess documentationTeamâHandbĂŒcherTeam handbooksmitwithsauberer,awiederverwendbarerclean,Strukturreusable structure
FazitConclusion đŻ
BookStack istis eina sehrvery zugĂ€ngliches,accessible, strukturiertesstructured Wiki,wiki dasthat auffocuses on Ordnung,order, Bedienbarkeitusability, undand TeamâFunktionalitĂ€tteam functionality. setzt.If Weryouâre einlooking Systemfor sucht,a dassystem nichtthat erstdoesnât durchbecome jahrelangeusable Konventionenonly undafter AufrĂ€umprojekteyears nutzbarof wird,conventions findetand hiercleanup oftprojects, eineyouâll ĂŒberzeugendeoften Lösung:find a compelling solution here: klarclearly gegliedertstructured, guthighly durchsuchbarsearchable, rechtefĂ€higpermission-capable, SelfâHostingâfreundlichself-hosting-friendlyâand âpleasantly und dabei angenehm âunaufgeregtââno-dramaâ in dereveryday tĂ€glichen Nutzung.use."