1429 lines
32 KiB
HTML
1429 lines
32 KiB
HTML
|
||
<!doctype html>
|
||
<html lang="en" class="no-js">
|
||
<head>
|
||
|
||
<meta charset="utf-8">
|
||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||
|
||
|
||
|
||
|
||
<link rel="prev" href="../architecture/">
|
||
|
||
|
||
<link rel="next" href="../frontend/">
|
||
|
||
|
||
|
||
|
||
|
||
<link rel="icon" href="../assets/images/favicon.png">
|
||
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.0">
|
||
|
||
|
||
|
||
<title>Backend & API - Stackpulse Dokumentation</title>
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="../assets/stylesheets/main.618322db.min.css">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
|
||
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
|
||
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
|
||
|
||
|
||
|
||
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
|
||
|
||
|
||
|
||
|
||
|
||
</head>
|
||
|
||
|
||
<body dir="ltr">
|
||
|
||
|
||
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
|
||
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
|
||
<label class="md-overlay" for="__drawer"></label>
|
||
<div data-md-component="skip">
|
||
|
||
|
||
<a href="#backend-api" class="md-skip">
|
||
Skip to content
|
||
</a>
|
||
|
||
</div>
|
||
<div data-md-component="announce">
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<header class="md-header md-header--shadow" data-md-component="header">
|
||
<nav class="md-header__inner md-grid" aria-label="Header">
|
||
<a href=".." title="Stackpulse Dokumentation" class="md-header__button md-logo" aria-label="Stackpulse Dokumentation" data-md-component="logo">
|
||
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
|
||
|
||
</a>
|
||
<label class="md-header__button md-icon" for="__drawer">
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
|
||
</label>
|
||
<div class="md-header__title" data-md-component="header-title">
|
||
<div class="md-header__ellipsis">
|
||
<div class="md-header__topic">
|
||
<span class="md-ellipsis">
|
||
Stackpulse Dokumentation
|
||
</span>
|
||
</div>
|
||
<div class="md-header__topic" data-md-component="header-topic">
|
||
<span class="md-ellipsis">
|
||
|
||
Backend & API
|
||
|
||
</span>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
|
||
|
||
|
||
|
||
|
||
|
||
<label class="md-header__button md-icon" for="__search">
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
|
||
</label>
|
||
<div class="md-search" data-md-component="search" role="dialog">
|
||
<label class="md-search__overlay" for="__search"></label>
|
||
<div class="md-search__inner" role="search">
|
||
<form class="md-search__form" name="search">
|
||
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
|
||
<label class="md-search__icon md-icon" for="__search">
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
|
||
</label>
|
||
<nav class="md-search__options" aria-label="Search">
|
||
|
||
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
|
||
</button>
|
||
</nav>
|
||
|
||
</form>
|
||
<div class="md-search__output">
|
||
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
|
||
<div class="md-search-result" data-md-component="search-result">
|
||
<div class="md-search-result__meta">
|
||
Initializing search
|
||
</div>
|
||
<ol class="md-search-result__list" role="presentation"></ol>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
</nav>
|
||
|
||
</header>
|
||
|
||
<div class="md-container" data-md-component="container">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<main class="md-main" data-md-component="main">
|
||
<div class="md-main__inner md-grid">
|
||
|
||
|
||
|
||
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
|
||
<div class="md-sidebar__scrollwrap">
|
||
<div class="md-sidebar__inner">
|
||
|
||
|
||
|
||
|
||
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
|
||
<label class="md-nav__title" for="__drawer">
|
||
<a href=".." title="Stackpulse Dokumentation" class="md-nav__button md-logo" aria-label="Stackpulse Dokumentation" data-md-component="logo">
|
||
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
|
||
|
||
</a>
|
||
Stackpulse Dokumentation
|
||
</label>
|
||
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href=".." class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Start
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--nested">
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
|
||
|
||
|
||
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Benutzerhandbuch
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
|
||
<label class="md-nav__title" for="__nav_2">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
|
||
|
||
Benutzerhandbuch
|
||
|
||
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../user-guide/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Überblick
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../user-guide/setup/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Setup
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../user-guide/stacks/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Stacks
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../user-guide/logs/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Logs
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../user-guide/maintenance/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Wartung
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../user-guide/users/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Benutzer
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../user-guide/groups/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Benutzergruppen & Rechte
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
|
||
|
||
|
||
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Technik
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
|
||
<label class="md-nav__title" for="__nav_3">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
|
||
|
||
Technik
|
||
|
||
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../getting-started/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Getting Started
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../architecture/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Architektur
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--active">
|
||
|
||
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
|
||
|
||
|
||
|
||
|
||
|
||
<label class="md-nav__link md-nav__link--active" for="__toc">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Backend & API
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
<a href="./" class="md-nav__link md-nav__link--active">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Backend & API
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
|
||
|
||
|
||
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<label class="md-nav__title" for="__toc">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
Table of contents
|
||
</label>
|
||
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#laufzeit-einstiegspunkte" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Laufzeit & Einstiegspunkte
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#module" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Module
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#api-uberblick-auszug" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
API-Überblick (Auszug)
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label="API-Überblick (Auszug)">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#setup-server" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Setup & Server
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#authentifizierung" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Authentifizierung
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#benutzer-gruppen" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Benutzer & Gruppen
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#stacks-redeploy" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Stacks & Redeploy
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#logging-wartung" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Logging & Wartung
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#datenbank-schema" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Datenbank & Schema
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#berechtigungssystem" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Berechtigungssystem
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#redeploy-workflow" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Redeploy-Workflow
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#wartungs-und-updatepfad" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Wartungs- und Updatepfad
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#erweiterungstipps" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Erweiterungstipps
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../frontend/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Frontend
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../operations/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Operations & Wartung
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
|
||
<div class="md-sidebar__scrollwrap">
|
||
<div class="md-sidebar__inner">
|
||
|
||
|
||
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<label class="md-nav__title" for="__toc">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
Table of contents
|
||
</label>
|
||
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#laufzeit-einstiegspunkte" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Laufzeit & Einstiegspunkte
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#module" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Module
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#api-uberblick-auszug" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
API-Überblick (Auszug)
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label="API-Überblick (Auszug)">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#setup-server" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Setup & Server
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#authentifizierung" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Authentifizierung
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#benutzer-gruppen" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Benutzer & Gruppen
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#stacks-redeploy" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Stacks & Redeploy
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#logging-wartung" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Logging & Wartung
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#datenbank-schema" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Datenbank & Schema
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#berechtigungssystem" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Berechtigungssystem
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#redeploy-workflow" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Redeploy-Workflow
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#wartungs-und-updatepfad" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Wartungs- und Updatepfad
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#erweiterungstipps" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Erweiterungstipps
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
</nav>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="md-content" data-md-component="content">
|
||
|
||
<article class="md-content__inner md-typeset">
|
||
|
||
|
||
|
||
|
||
|
||
<h1 id="backend-api">Backend & API</h1>
|
||
<p>Das Backend implementiert alle Anwendungsfälle über Express-Routen, Socket.IO für Echtzeit-Events und eine SQLite-Datenbank als Persistenzschicht. Dieser Abschnitt fasst die wichtigsten Module, Entitäten und Endpunkte zusammen.</p>
|
||
<h2 id="laufzeit-einstiegspunkte">Laufzeit & Einstiegspunkte</h2>
|
||
<ul>
|
||
<li><code>backend/index.js</code> initialisiert Express, Socket.IO, lädt <code>.env</code>, sorgt für Schema-Validierung (<code>ensureDatabaseSchema</code>) und Default-Daten (<code>ensureSuperuserFromEnv</code>, <code>ensureDefaultsFromEnv</code>).</li>
|
||
<li>Start via <code>npm start</code> (siehe <code>package.json</code>); Migrationen über <code>npm run migrate</code>.</li>
|
||
<li>Datenbankdatei: <code>backend/data/stackpulse.db</code>, WAL-Modus aktiv.</li>
|
||
</ul>
|
||
<h2 id="module">Module</h2>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Modul</th>
|
||
<th>Pfad</th>
|
||
<th>Aufgabe</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>Auth/Superuser</td>
|
||
<td><code>auth/superuser.js</code></td>
|
||
<td>Registrieren/Verifizieren von Superusern, Login, Passwortvalidierung, Sicherheitsphrasen.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Users & Groups</td>
|
||
<td><code>users/*</code>, <code>groups/*</code>, <code>permissions/*</code></td>
|
||
<td>CRUD für Benutzer, Gruppen, Rechtezuweisung, Ableitung effektiver Berechtigungen.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Setup</td>
|
||
<td><code>setup/index.js</code></td>
|
||
<td>Verwaltung registrierter Portainer-Server, sichere Ablage der API-Keys, Setup-Status.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Logging</td>
|
||
<td><code>logging/eventLogs.js</code></td>
|
||
<td>Einheitliches Ereignislogging (Insert, Filter, Delete, Export).</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Maintenance</td>
|
||
<td><code>maintenance/state.js</code> + helper in <code>index.js</code></td>
|
||
<td>Wartungsmodus, SSH-Konfiguration, Update-Skripte und Ausführung.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Portainer Proxy</td>
|
||
<td>Funktionen in <code>index.js</code></td>
|
||
<td>Kommunikation mit Portainer (<code>axiosInstance</code> + dynamische <code>baseURL</code>), Environment-Erkennung und Redeploy-Strecke.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h2 id="api-uberblick-auszug">API-Überblick (Auszug)</h2>
|
||
<h3 id="setup-server">Setup & Server</h3>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Methode</th>
|
||
<th>Route</th>
|
||
<th>Beschreibung</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>GET</td>
|
||
<td><code>/api/setup/status</code></td>
|
||
<td>Gibt zurück, ob Server/API-Key/Superuser vorhanden sind.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>POST</td>
|
||
<td><code>/api/setup/test-portainer</code></td>
|
||
<td>Verifiziert URL + API-Key gegen Portainer.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>POST</td>
|
||
<td><code>/api/setup/portainer-stacks</code></td>
|
||
<td>Listet Stacks (für Preview im Wizard).</td>
|
||
</tr>
|
||
<tr>
|
||
<td>POST</td>
|
||
<td><code>/api/setup/complete</code></td>
|
||
<td>Markiert Setup als abgeschlossen und hinterlegt Server/API-Key.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>DELETE</td>
|
||
<td><code>/api/setup/servers/:id</code></td>
|
||
<td>Entfernt einen registrierten Portainer-Server.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>PUT</td>
|
||
<td><code>/api/setup/servers/:id/api-key</code></td>
|
||
<td>Überschreibt API-Key.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>PUT</td>
|
||
<td><code>/api/setup/self-stack</code></td>
|
||
<td>Speichert die ID des StackPulse-Stacks, damit dieser nicht redeployed wird.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="authentifizierung">Authentifizierung</h3>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Methode</th>
|
||
<th>Route</th>
|
||
<th>Beschreibung</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>POST</td>
|
||
<td><code>/api/auth/login</code></td>
|
||
<td>Username/Passwort-Login, setzt HTTP-only Cookie.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>POST</td>
|
||
<td><code>/api/auth/logout</code></td>
|
||
<td>Session beenden & Cookie löschen.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GET</td>
|
||
<td><code>/api/auth/session</code></td>
|
||
<td>Liefert eingeloggten Benutzer + Permissions.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>POST</td>
|
||
<td><code>/api/auth/recover/verify</code> & <code>/reset</code></td>
|
||
<td>Passwortreset über Sicherheitsphrase.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GET/POST/DELETE</td>
|
||
<td><code>/api/auth/superuser/*</code></td>
|
||
<td>Abfrage, Registrierung oder Entfernen des Superusers.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="benutzer-gruppen">Benutzer & Gruppen</h3>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Methode</th>
|
||
<th>Route</th>
|
||
<th>Beschreibung</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>GET/POST</td>
|
||
<td><code>/api/users</code></td>
|
||
<td>Liste anlegen, neue Benutzer erstellen.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GET/PUT/DELETE</td>
|
||
<td><code>/api/users/:id</code></td>
|
||
<td>Details lesen, bearbeiten oder löschen.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>PUT</td>
|
||
<td><code>/api/users/:id/groups</code></td>
|
||
<td>Gruppenmitgliedschaften aktualisieren.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>PUT</td>
|
||
<td><code>/api/users/:id/active</code></td>
|
||
<td>Benutzer aktivieren/deaktivieren.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GET/POST</td>
|
||
<td><code>/api/users/:id/security-phrase</code>, <code>/renew</code></td>
|
||
<td>Sicherheitsphrase anzeigen bzw. neu generieren.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GET/POST</td>
|
||
<td><code>/api/groups</code></td>
|
||
<td>Gruppen auflisten oder neu anlegen.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>PUT/DELETE</td>
|
||
<td><code>/api/groups/:id</code></td>
|
||
<td>Gruppe editieren oder entfernen.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GET/PUT</td>
|
||
<td><code>/api/groups/:id/permissions</code></td>
|
||
<td>Berechtigungen lesen/setzen.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="stacks-redeploy">Stacks & Redeploy</h3>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Methode</th>
|
||
<th>Route</th>
|
||
<th>Beschreibung</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>GET</td>
|
||
<td><code>/api/stacks</code></td>
|
||
<td>Aggregierte Liste inkl. Filter, Self-Stack-Blockade und Redeploy-Status.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>PUT</td>
|
||
<td><code>/api/stacks/:id/redeploy</code></td>
|
||
<td>Redeploy eines einzelnen Stacks.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>PUT</td>
|
||
<td><code>/api/stacks/redeploy-selection</code></td>
|
||
<td>Redeploy einer Liste übermittelter <code>stackIds</code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>PUT</td>
|
||
<td><code>/api/stacks/redeploy-all</code></td>
|
||
<td>Redeploy aller Stacks (Permission <code>stacks-redeploy-all</code>).</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>Das Backend veröffentlicht den Redeploy-Fortschritt parallel über Socket.IO (<code>redeployStatus</code> Event) und unterscheidet die Phasen <code>queued</code>, <code>started</code>, <code>success</code>, <code>error</code>, <code>info</code>.</p>
|
||
<h3 id="logging-wartung">Logging & Wartung</h3>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Methode</th>
|
||
<th>Route</th>
|
||
<th>Beschreibung</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>GET</td>
|
||
<td><code>/api/logs</code></td>
|
||
<td>Filterbare/Paginierbare Event-Logs.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>DELETE</td>
|
||
<td><code>/api/logs/:id</code> oder <code>/api/logs</code></td>
|
||
<td>Einzelne oder gefilterte Logs löschen.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GET</td>
|
||
<td><code>/api/logs/export</code></td>
|
||
<td>CSV-Export anhand der Query-Filter.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GET/POST</td>
|
||
<td><code>/api/maintenance/mode</code></td>
|
||
<td>Status abfragen oder toggeln.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GET</td>
|
||
<td><code>/api/maintenance/config</code></td>
|
||
<td>Liefert Maintenance-Status, Update-Skript & SSH-Config.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>PUT/DELETE</td>
|
||
<td><code>/api/maintenance/ssh-config</code></td>
|
||
<td>SSH-Credentials speichern/entfernen.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>POST</td>
|
||
<td><code>/api/maintenance/test-ssh</code></td>
|
||
<td>Verbindungstest mit optionalem Override.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>PUT/DELETE</td>
|
||
<td><code>/api/maintenance/update-script</code></td>
|
||
<td>Custom Update-Skript pflegen.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>POST</td>
|
||
<td><code>/api/maintenance/portainer-update</code></td>
|
||
<td>Update-Kommando per SSH ausführen (mit Custom/Default-Skript).</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h2 id="datenbank-schema">Datenbank & Schema</h2>
|
||
<ul>
|
||
<li><code>ensureDatabaseSchema()</code> erzeugt Tabellen bei jedem Start, inklusive Default-Gruppen, Permissions, Settings, Server-Einträge und Trigger.</li>
|
||
<li>Permissions werden anhand der Blueprint-Datei <code>backend/db/dbs</code> eingelesen. Jede Permission definiert Key, Label, Level (<code>full</code>, <code>read</code>, <code>none</code>) und Abhängigkeiten.</li>
|
||
<li>Events werden in <code>event_logs</code> gespeichert. Relevante Felder:</li>
|
||
<li><code>category</code>, <code>event_type</code>, <code>action</code>, <code>status</code>, <code>severity</code></li>
|
||
<li><code>entity_type</code>, <code>entity_id</code>, <code>entity_name</code></li>
|
||
<li><code>actor_type</code>, <code>actor_id</code>, <code>actor_name</code></li>
|
||
<li><code>context_type</code>, <code>context_id</code>, <code>context_label</code></li>
|
||
<li><code>message</code>, <code>metadata (JSON)</code></li>
|
||
<li>Filter-Parameter (<code>ids</code>, <code>categories</code>, <code>eventTypes</code>, <code>status</code>, <code>stackIds</code>, Zeitfenster) werden in <code>buildEventLogFilter</code> zentral verarbeitet.</li>
|
||
</ul>
|
||
<h2 id="berechtigungssystem">Berechtigungssystem</h2>
|
||
<ul>
|
||
<li>Jeder Benutzer gehört zu beliebig vielen Gruppen; die effektiven Rechte ergeben sich aus der höchsten Ausprägung pro Permission.</li>
|
||
<li>Superuser erhalten alle Berechtigungen und können nicht über das UI entzogen werden.</li>
|
||
<li><code>PermissionGate</code> im Frontend spiegelt die gleichen Keys. Wichtigste Bereiche:</li>
|
||
<li><code>stacks-*</code> (Redeploy)</li>
|
||
<li><code>logs-*</code></li>
|
||
<li><code>users-*</code> & <code>user-groups-*</code></li>
|
||
<li><code>maintenance-*</code> (inkl. Unterrechte <code>maintenance-server-*</code>, <code>maintenance-ssh-update</code>, <code>maintenance-update</code>)</li>
|
||
</ul>
|
||
<h2 id="redeploy-workflow">Redeploy-Workflow</h2>
|
||
<ol>
|
||
<li>Eingehender Request wird mit <code>maintenanceGuard</code> geprüft (Maintenance-Modus blockiert optional Redeploys).</li>
|
||
<li>Das Backend ermittelt den zugehörigen Portainer-Endpoint (<code>resolvePortainerEnvironmentId</code>).</li>
|
||
<li>Der Redeploy wird über Portainer ausgeführt (<code>/api/stacks/:id/redeploy</code>), Log-Einträge werden erstellt.</li>
|
||
<li><code>broadcastRedeployStatus()</code> aktualisiert das In-Memory-Tracking (<code>redeployingStacks</code>) und sendet Socket.IO Events.</li>
|
||
<li>Fehler führen zu <code>event_logs</code>-Einträgen mit <code>severity=error</code>, UI zeigt Toasts via <code>ToastProvider</code>.</li>
|
||
</ol>
|
||
<h2 id="wartungs-und-updatepfad">Wartungs- und Updatepfad</h2>
|
||
<ul>
|
||
<li><code>maintenance/state.js</code> persistiert Aktivierung & Nachricht im Setting <code>maintenance_mode</code>.</li>
|
||
<li>SSH-Konfigurationen (Host, Port, User, Passwort, extra args) werden verschlüsselt gespeichert (<code>getPortainerSshConfig</code>).</li>
|
||
<li>Update-Skripte lassen sich überschreiben, Standard-Skript liegt in <code>DEFAULT_PORTAINER_UPDATE_SCRIPT</code> (Bash-Befehle).</li>
|
||
<li>Update-Status hält Laufzeiten, letzte Ergebnisse und Logauszüge in-memory & Settings bereit.</li>
|
||
</ul>
|
||
<h2 id="erweiterungstipps">Erweiterungstipps</h2>
|
||
<ul>
|
||
<li>Neue API-Routen sollten <code>requirePermission(..)</code> nutzen, Logging via <code>logEvent()</code> hinzufügen und – falls Portainer-Aufrufe stattfinden – das <code>axiosInstance</code> verwenden.</li>
|
||
<li>Einstellungen stets über <code>db/settings.js</code> verwalten, damit UI & CLI konsistent bleiben.</li>
|
||
<li>Für breaking DB-Änderungen existiert kein Migrations-Framework – erweitere <code>ensureDatabaseSchema</code> inkl. Versionsflag, um Idempotenz sicherzustellen.</li>
|
||
</ul>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</article>
|
||
</div>
|
||
|
||
|
||
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
|
||
</div>
|
||
|
||
</main>
|
||
|
||
<footer class="md-footer">
|
||
|
||
<div class="md-footer-meta md-typeset">
|
||
<div class="md-footer-meta__inner md-grid">
|
||
<div class="md-copyright">
|
||
|
||
|
||
Made with
|
||
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
|
||
Material for MkDocs
|
||
</a>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</footer>
|
||
|
||
</div>
|
||
<div class="md-dialog" data-md-component="dialog">
|
||
<div class="md-dialog__inner md-typeset"></div>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
<script id="__config" type="application/json">{"annotate": null, "base": "..", "features": [], "search": "../assets/javascripts/workers/search.7a47a382.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
|
||
|
||
|
||
<script src="../assets/javascripts/bundle.e71a0d61.min.js"></script>
|
||
|
||
|
||
</body>
|
||
</html> |