docs: add initial Mediary user guide

This commit is contained in:
2026-08-01 10:10:28 +02:00
commit a915c44d49
20 changed files with 511 additions and 0 deletions
+5
View File
@@ -0,0 +1,5 @@
node_modules/
dist/
.astro/
.env
.DS_Store
+13
View File
@@ -0,0 +1,13 @@
FROM node:24-alpine AS build
WORKDIR /app
COPY package.json ./
RUN npm install --no-audit --no-fund
COPY . .
RUN npm run build
FROM nginx:1.29-alpine
COPY nginx.conf /etc/nginx/conf.d/default.conf
COPY --from=build /app/dist /usr/share/nginx/html
EXPOSE 80
HEALTHCHECK --interval=30s --timeout=5s --start-period=10s --retries=3 \
CMD wget -qO- http://127.0.0.1/ >/dev/null || exit 1
+34
View File
@@ -0,0 +1,34 @@
# Mediary User Guide
Publieke gebruikershandleiding voor Mediary, bedoeld voor publicatie op `https://docs.mediary.nl`.
Deze repository bevat uitsluitend eindgebruikersdocumentatie. Installatie- en beheerhandleidingen horen niet op de publieke documentatiesite.
## Lokaal ontwikkelen
Vereisten:
- Node.js 22 of nieuwer
- npm
```bash
npm install
npm run dev
```
## Controleren en bouwen
```bash
npm run check
npm run build
```
De statische website wordt naar `dist/` gebouwd.
## Inhoud
Documentatiepagina's staan in `src/content/docs/` en worden geschreven in Markdown of MDX.
## Publicatie
De productiebuild is een statische website. Serveer de inhoud van `dist/` via de webserver achter `docs.mediary.nl`.
+53
View File
@@ -0,0 +1,53 @@
import { defineConfig } from 'astro/config';
import starlight from '@astrojs/starlight';
export default defineConfig({
site: 'https://docs.mediary.nl',
integrations: [
starlight({
title: 'Mediary Handleiding',
description: 'Gebruikershandleiding voor Mediary',
favicon: '/favicon.svg',
customCss: ['./src/styles/custom.css'],
lastUpdated: true,
editLink: {
baseUrl: 'https://git.webjunkie.nl/webjunkie/mediary-user-guide/_edit/main/',
},
sidebar: [
{
label: 'Aan de slag',
items: [
{ label: 'Welkom', slug: 'index' },
{ label: 'Eerste stappen', slug: 'aan-de-slag/eerste-stappen' },
{ label: 'Hoe Mediary werkt', slug: 'aan-de-slag/hoe-mediary-werkt' },
],
},
{
label: 'Mediaservers',
items: [
{ label: 'Emby verbinden', slug: 'gebruik/emby-verbinden' },
],
},
{
label: 'Gegevens importeren',
items: [
{ label: 'Yamtrack importeren', slug: 'importeren/yamtrack' },
],
},
{
label: 'Mediary gebruiken',
items: [
{ label: 'Bibliotheek en lijsten', slug: 'gebruik/bibliotheek-en-lijsten' },
{ label: 'Kijkgeschiedenis', slug: 'gebruik/kijkgeschiedenis' },
],
},
{
label: 'Hulp',
items: [
{ label: 'Veelgestelde vragen', slug: 'hulp/veelgestelde-vragen' },
],
},
],
}),
],
});
+7
View File
@@ -0,0 +1,7 @@
services:
docs:
build: .
container_name: mediary-user-guide
restart: unless-stopped
ports:
- "4322:80"
+16
View File
@@ -0,0 +1,16 @@
server {
listen 80;
server_name _;
root /usr/share/nginx/html;
index index.html;
location / {
try_files $uri $uri/ $uri.html =404;
}
location ~* \.(?:css|js|svg|png|jpg|jpeg|webp|ico|woff2?)$ {
expires 7d;
add_header Cache-Control "public, immutable";
try_files $uri =404;
}
}
+23
View File
@@ -0,0 +1,23 @@
{
"name": "mediary-user-guide",
"version": "0.1.0",
"private": true,
"type": "module",
"scripts": {
"dev": "astro dev",
"build": "astro check && astro build",
"preview": "astro preview",
"check": "astro check"
},
"dependencies": {
"@astrojs/starlight": "^0.41.4",
"astro": "^7.1.4"
},
"devDependencies": {
"@astrojs/check": "^0.9.4",
"typescript": "^5.9.2"
},
"engines": {
"node": ">=22"
}
}
+4
View File
@@ -0,0 +1,4 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 64">
<rect width="64" height="64" rx="14" fill="#7c3aed"/>
<path d="M15 45V19h8l9 14 9-14h8v26h-8V31L32 44 23 31v14z" fill="white"/>
</svg>

After

Width:  |  Height:  |  Size: 200 B

+15
View File
@@ -0,0 +1,15 @@
# Geplande screenshots
Voeg later actuele schermafbeeldingen toe van:
1. Instellingen → Integraties
2. Emby-verbinding toevoegen
3. Integratie testen en synchroniseren
4. Instellingen → Imports
5. Yamtrack-upload
6. Importreview en handmatig matchen
7. Bibliotheek
8. Media-detailpagina
9. Watchlist en overige persoonlijke lijsten
Gebruik geen echte wachtwoorden, tokens, interne serveradressen of persoonsgegevens in screenshots.
+10
View File
@@ -0,0 +1,10 @@
import { defineCollection } from 'astro:content';
import { docsLoader } from '@astrojs/starlight/loaders';
import { docsSchema } from '@astrojs/starlight/schema';
export const collections = {
docs: defineCollection({
loader: docsLoader(),
schema: docsSchema(),
}),
};
@@ -0,0 +1,35 @@
---
title: Eerste stappen
description: Richt je Mediary-account in en vul het met je eigen gegevens.
---
Na je eerste aanmelding is je account nog grotendeels leeg. Doorloop deze stappen om Mediary in gebruik te nemen.
## 1. Verbind je mediaserver
Open **Instellingen → Integraties** en verbind je Emby-server. Na de eerste synchronisatie verschijnt de beschikbare inhoud onder **Bibliotheek**.
[Lees hoe je Emby verbindt](/gebruik/emby-verbinden/)
## 2. Importeer bestaande gegevens
Gebruik je Yamtrack al langer, dan kun je je exportbestand via **Instellingen → Imports** toevoegen. Mediary verwerkt onder andere media, kijkmomenten, rewatches, beoordelingen en voortgang.
[Lees hoe je Yamtrack importeert](/importeren/yamtrack/)
## 3. Controleer je bibliotheek
De **Bibliotheek** toont wat momenteel beschikbaar is op je gekoppelde mediaservers. Een titel in de bibliotheek staat niet automatisch op je watchlist.
## 4. Maak Mediary persoonlijk
Open een film of serie om deze:
- op je watchlist te zetten;
- als favoriet te markeren;
- persoonlijk te beoordelen;
- samen met je kijkgeschiedenis en beschikbaarheid te bekijken.
## 5. Gebruik de persoonlijke lijsten
Onder **Lijsten** vind je verschillende overzichten, zoals je watchlist, favorieten, bekeken titels en media die je nog kunt beoordelen.
@@ -0,0 +1,37 @@
---
title: Hoe Mediary werkt
description: Begrijp het verschil tussen media, serverbeschikbaarheid en persoonlijke gegevens.
---
Mediary is geen mediaserver. Het is een centraal overzicht dat gegevens uit verschillende bronnen samenbrengt.
## Drie soorten informatie
### Media-informatie
Een film of serie bestaat één keer in Mediary. Daarbij horen algemene gegevens zoals titel, jaar, poster en externe identificatienummers.
### Beschikbaarheid
Een gekoppelde mediaserver geeft door welke titels daar beschikbaar zijn en welke afspeelstatus bekend is. Deze informatie vormt je **Bibliotheek**.
### Persoonlijke gegevens
Je watchlist, favorieten, beoordelingen en kijkgeschiedenis zijn van jou. Ze blijven losstaan van de beschikbaarheid op een specifieke server.
## Bibliotheek is geen watchlist
Dit onderscheid is belangrijk:
- **Bibliotheek:** titels die beschikbaar zijn op een gekoppelde mediaserver.
- **Watchlist:** titels die je zelf bewust wilt bewaren om later te bekijken.
Een synchronisatie met Emby zet daarom niet automatisch alle servertitels op je watchlist.
## Eén geschiedenis, meerdere bronnen
Mediary kan historische gegevens importeren en actuele afspeelgegevens van mediaservers verwerken. Daardoor blijft je kijkgeschiedenis bruikbaar wanneer je later een andere mediaserver gebruikt.
## Huidige en toekomstige koppelingen
Op dit moment ondersteunt de gebruikersflow Emby als mediaserver en Yamtrack als databron voor historische import. Ondersteuning voor andere mediaservers, streamingdiensten en importbronnen is gepland.
@@ -0,0 +1,46 @@
---
title: Bibliotheek en lijsten
description: Vind servermedia en beheer je persoonlijke watchlist, favorieten en beoordelingen.
---
Mediary maakt onderscheid tussen wat beschikbaar is en wat jij persoonlijk hebt gekozen.
## Bibliotheek
De **Bibliotheek** toont films en series die op een actieve gekoppelde mediaserver beschikbaar zijn. Je kunt de lijst doorzoeken en filteren, en vanuit een titel de detailpagina openen.
Een titel kan in de bibliotheek staan zonder persoonlijke status. Dat betekent alleen dat de titel beschikbaar is.
## Watchlist
De **Watchlist** bevat titels die je bewust hebt opgeslagen om later te bekijken. Je kunt een titel toevoegen vanuit de detailpagina of vanuit een zoekresultaat.
Wanneer een titel op je watchlist later op een gekoppelde server beschikbaar komt, kan Mediary daar een melding voor tonen.
## Favorieten
Markeer een titel als favoriet om deze terug te vinden onder **Favorieten**. Favoriet maken zet de titel niet automatisch op je watchlist.
## Doorgaan met kijken
Onder **Doorgaan met kijken** staan titels waarvoor actuele voortgang bekend is en die nog niet zijn afgerond.
## Eerder bekeken
**Eerder bekeken** combineert bekende kijkgeschiedenis uit imports met ondersteunde afspeelgegevens van gekoppelde mediaservers.
## Nog beoordelen
Onder **Nog beoordelen** vind je bekeken titels waarvoor nog geen persoonlijke beoordeling is opgeslagen.
## Detailpagina
Op de detailpagina zie je, afhankelijk van de beschikbare gegevens:
- algemene media-informatie;
- beschikbaarheid per mediaserver;
- afspeelvoortgang;
- kijkgeschiedenis en aantal kijkmomenten;
- je watchliststatus;
- je favorietstatus;
- je persoonlijke beoordeling.
@@ -0,0 +1,43 @@
---
title: Emby verbinden
description: Koppel je Emby-account en synchroniseer je serverbibliotheek met Mediary.
---
Door Emby te verbinden kan Mediary zien welke films en series op je server beschikbaar zijn. Mediary kan daarnaast afspeelgegevens gebruiken voor voortgang en kijkstatus.
## Verbinding toevoegen
1. Meld je aan bij Mediary.
2. Open **Instellingen → Integraties**.
3. Kies de optie om een Emby-verbinding toe te voegen.
4. Geef de verbinding een herkenbare naam.
5. Vul het webadres van je Emby-server in.
6. Meld je aan met de gevraagde Emby-gegevens.
7. Sla de verbinding op.
:::tip
Gebruik een serveradres dat vanuit de Mediary-server bereikbaar is. Dit kan een intern adres of een beveiligde externe URL zijn, afhankelijk van de installatie.
:::
## Verbinding testen
Gebruik na het opslaan de testfunctie. Mediary toont of de server bereikbaar is en met welke Emby-gebruiker de verbinding is gemaakt.
## Eerste synchronisatie
Start daarna een synchronisatie. Mediary:
- koppelt Emby-titels aan bestaande media of maakt algemene mediarecords aan;
- slaat op welke titels op deze server beschikbaar zijn;
- werkt relevante afspeelstatus en voortgang bij;
- laat je persoonlijke watchlist ongemoeid.
Na een geslaagde synchronisatie vind je de beschikbare media onder **Bibliotheek**.
## Opnieuw synchroniseren
Je kunt de synchronisatie later opnieuw starten om nieuwe, gewijzigde of verwijderde servertitels te verwerken. Bestaande persoonlijke gegevens worden niet overschreven door de server.
## Meerdere mediaservers
Ondersteuning voor andere mediaservers, waaronder Jellyfin en Plex, is gepland. Ook koppelingen met streamingdiensten kunnen later worden toegevoegd. De exacte beschikbaarheid hangt af van toekomstige Mediary-versies.
@@ -0,0 +1,22 @@
---
title: Kijkgeschiedenis
description: Bekijk kijkmomenten, rewatches en voortgang uit meerdere bronnen.
---
Mediary bewaart kijkgeschiedenis onafhankelijk van de mediaserver waarop je een titel hebt afgespeeld.
## Historische imports
Een import, zoals een Yamtrack-import, kan bestaande kijkmomenten, rewatches en voortgang naar Mediary overbrengen. De bron van ieder toegepast gegeven blijft vastgelegd zodat dezelfde import veilig opnieuw kan worden herkend.
## Actuele mediaservergegevens
Een mediaserverkoppeling kan actuele afspeelstatus en voortgang doorgeven. Deze gegevens helpen onder andere bij **Doorgaan met kijken** en de detailweergave van een titel.
## Films en series
Bij films kan Mediary afzonderlijke kijkmomenten en rewatches tonen. Bij series kunnen gegevens betrekking hebben op de serie als geheel, seizoenen of afzonderlijke afleveringen, afhankelijk van wat de bron beschikbaar stelt.
## Onvolledige gegevens
Niet iedere bron bevat exacte datums of alle afleveringsdetails. Mediary bewaart bekende informatie zonder ontbrekende gegevens te verzinnen. Daardoor kan een overzicht bijvoorbeeld een minimumaantal kijkmomenten tonen.
@@ -0,0 +1,36 @@
---
title: Veelgestelde vragen
description: Antwoorden op veelvoorkomende vragen over Mediary.
---
## Waarom staat bijna alles in Bibliotheek, maar niet in Watchlist?
De Bibliotheek toont wat op je mediaserver beschikbaar is. De Watchlist bevat alleen titels die je zelf bewust hebt toegevoegd of die via een persoonlijke data-import als watchlistitem zijn vastgelegd.
## Zet een Emby-synchronisatie mijn hele server op de watchlist?
Nee. Emby levert beschikbaarheidsinformatie. De synchronisatie verandert niet automatisch al je servertitels in persoonlijke watchlistitems.
## Waarom duurt een grote Yamtrack-import meerdere rondes?
Mediary beperkt externe metadata-aanvragen en verwerkt grote imports in meerdere workerpasses. Gebruik **Resterende matches hervatten** wanneer nog automatische matches openstaan.
## Waarom moet ik sommige titels handmatig koppelen?
Brongegevens kunnen onvolledig of dubbelzinnig zijn. Wanneer Mediary niet voldoende zekerheid heeft, moet je het juiste resultaat selecteren of de bronregel overslaan.
## Kan ik Jellyfin of Plex verbinden?
Nog niet via de huidige gebruikersflow. Ondersteuning voor andere mediaservers volgt in toekomstige versies.
## Kan Mediary streamingdiensten koppelen?
Streamingdienstintegraties zijn een toekomstige uitbreiding. De handleiding wordt bijgewerkt zodra deze koppelingen beschikbaar zijn.
## Kan ik andere exports dan Yamtrack importeren?
De importarchitectuur ondersteunt toekomstige datafeeds, maar de huidige handleiding beschrijft alleen de beschikbare Yamtrack-import.
## Is dit ook een installatiehandleiding?
Nee. Deze documentatie is uitsluitend bedoeld voor eindgebruikers van een bestaande Mediary-installatie.
+56
View File
@@ -0,0 +1,56 @@
---
title: Yamtrack importeren
description: Neem je films, series, kijkmomenten, beoordelingen en voortgang mee uit Yamtrack.
---
Met een Yamtrack-export kun je bestaande persoonlijke gegevens naar Mediary overzetten.
## Voorbereiding
Maak in Yamtrack een CSV-export van je gegevens en bewaar het bestand op je computer. Bewerk het CSV-bestand bij voorkeur niet voordat je het importeert.
## Import starten
1. Open **Instellingen → Imports**.
2. Start een nieuwe import.
3. Kies **Yamtrack** als bron.
4. Selecteer je CSV-bestand.
5. Upload het bestand.
Mediary zet de bronregels eerst klaar in een beveiligde stagingomgeving. Je gegevens worden dus niet direct definitief toegepast.
## Automatisch matchen
Mediary probeert films en series aan de juiste media te koppelen. Een grote import kan in meerdere workerpasses worden verwerkt. Gebruik zo nodig **Resterende matches hervatten** om verder te gaan.
De import kan onder andere verwerken:
- films en series;
- seizoenen en afleveringen;
- kijkmomenten en rewatches;
- persoonlijke beoordelingen;
- voortgangssnapshots;
- bekende begin- en einddatums.
## Resultaten controleren
Controleer de reviewpagina voordat je de import definitief maakt. Items die niet betrouwbaar automatisch konden worden gekoppeld, vragen om een handmatige keuze.
Bij handmatige controle kun je:
- een passend zoekresultaat selecteren;
- gericht via TMDb zoeken;
- een regel overslaan wanneer deze niet thuishoort in Mediary;
- mogelijke dubbele kijkmomenten beoordelen.
## Definitief importeren
Start de finalisatie pas wanneer de review klopt. Mediary past de gekozen wijzigingen idempotent toe: dezelfde bronregel hoort niet bij iedere herhaling opnieuw een extra kijkmoment te maken.
:::caution
Controleer conflicten en handmatige matches zorgvuldig. Een voltooide import kan niet automatisch volledig worden teruggedraaid.
:::
## Andere importbronnen
De importarchitectuur is voorbereid op aanvullende databronnen. Ondersteuning voor andere exports en datafeeds volgt in toekomstige versies.
+36
View File
@@ -0,0 +1,36 @@
---
title: Welkom bij Mediary
description: Houd je bibliotheek, kijkgeschiedenis en persoonlijke lijsten op één plek bij.
template: splash
hero:
tagline: Mediary brengt de beschikbaarheid van je mediaservers, je kijkgeschiedenis en je persoonlijke keuzes samen in één overzicht.
actions:
- text: Begin met Mediary
link: /aan-de-slag/eerste-stappen/
icon: right-arrow
variant: primary
- text: Hoe werkt het?
link: /aan-de-slag/hoe-mediary-werkt/
icon: open-book
---
import { Card, CardGrid } from '@astrojs/starlight/components';
<CardGrid>
<Card title="Verbind je mediaserver" icon="seti:video">
Koppel Emby om te zien welke films en series beschikbaar zijn en om afspeelgegevens te synchroniseren.
</Card>
<Card title="Importeer je geschiedenis" icon="document">
Neem je bestaande Yamtrack-gegevens mee, inclusief kijkmomenten, rewatches, beoordelingen en voortgang.
</Card>
<Card title="Beheer persoonlijke lijsten" icon="star">
Houd een eigen watchlist, favorieten en beoordelingen bij zonder dat je serverbibliotheek deze automatisch vult.
</Card>
<Card title="Eén centraal overzicht" icon="screen">
Bekijk beschikbaarheid, voortgang en kijkgeschiedenis onafhankelijk van de mediaserver waarop je afspeelt.
</Card>
</CardGrid>
:::note[Gebruikershandleiding]
Deze website legt uit hoe je Mediary gebruikt. Installatie en serverbeheer vallen buiten deze handleiding.
:::
+17
View File
@@ -0,0 +1,17 @@
:root {
--sl-color-accent-low: #2e1065;
--sl-color-accent: #8b5cf6;
--sl-color-accent-high: #ddd6fe;
--sl-color-white: #f8fafc;
--sl-color-gray-1: #e4e4e7;
--sl-color-gray-2: #a1a1aa;
--sl-color-gray-3: #71717a;
--sl-color-gray-4: #3f3f46;
--sl-color-gray-5: #27272a;
--sl-color-gray-6: #18181b;
--sl-color-black: #09090b;
}
.hero .tagline {
max-width: 48rem;
}
+3
View File
@@ -0,0 +1,3 @@
{
"extends": "astro/tsconfigs/strict"
}