README

Welcome to the official documentation for XWMS — a modern, secure, and scalable platform for managing users, partners, authentication, API clients, and more.

This repository contains clear, structured documentation for:

👤 End-users — Logging in, registering, managing accounts
🤝 Partners — Developers/businesses integrating via OAuth & API
🛠️ Bonus — Advanced server setup & deployment docs

📘 Main Documentation Sections

1️⃣ Getting Started with XWMS

A simplified guide to help end-users log in, register, and manage their account securely.

🔗 Page: https://docs.xwms.nl/getting-started/user
✅ Includes:

Email/password login, OAuth (Google, Microsoft), 2FA setup
Secure registration with email verification & anti-spam
Managing account settings, sessions, devices, preferences

👉 Go to Guide »

2️⃣ Getting Started with Authentication & Partner Setup

Everything partners need to integrate with XWMS using OAuth and APIs.

🔗 Page: https://docs.xwms.nl/getting-started/client
✅ Includes:

Auth flow overview (OAuth, 2FA, suspicious login detection)
Creating OAuth apps & API clients
Managing scopes, secrets, domains, and more

👉 Go to Guide »

🔐 End-User Documentation

📄 Guide	📝 Description
Login Guide	Secure login using 2FA, OAuth, and account recovery
Register Guide	Secure registration with email confirmation and name validation
Account Settings	Manage devices, addresses, sessions, notifications, etc.

🤝 Partner & Developer Docs

⚙️ Feature	📝 Description
Partner Dashboard	Create/manage OAuth clients and integration settings
OAuth Integration Guide	How to integrate XWMS OAuth with Laravel, JS, PHP, etc.

⚙️ Server & Deployment Docs (Bonus)

For developers and DevOps engineers deploying XWMS or building custom infrastructure.

📁 Topic	🔍 Details
Server Setup	Harden & configure Linux servers (UFW, SSH, fail2ban, PHP, MySQL)
Using GitHub on Server	Clone repos, configure SSH for `/var/www` deployment
MySQL via SSH Tunnel	Secure access to remote MySQL databases
File Permissions	Proper Laravel/Apache setup with users, groups, permissions
Domain Management	Apache virtual hosts, HTTPS with Certbot, site configuration

🧠 Quick Summary

🧩 Area	🧭 Topics Covered
End-Users	Login, register, sessions, settings, recovery
Partners	OAuth clients, scopes, secrets, domains
Developers	Laravel/JS integration with XWMS
Server Admins	Ubuntu setup, Apache, MySQL, SSH, GitHub, Certbot, permissions

🧭 Navigation Icons

Each section of the docs is labeled with intuitive icons:

🖼️ Icon	🔎 Meaning
`i-lucide-rocket`	Getting Started
`i-lucide-shield-check`	Authentication & Security
`i-lucide-server-cog`	Server Setup
`i-lucide-github`	GitHub & Deployment
`i-lucide-key`	SSH & MySQL Access
`i-lucide-file`	File Permissions
`i-lucide-cable`	Domain & Apache Management

📞 Support

Need help?

📚 Browse the documentation via the links above
🔐 For login/account issues: start at Login
🤝 For API/OAuth help: see the Partner Dashboard
🆘 Still stuck? Visit the Support Page

📌 About XWMS

XWMS (Extended Web Management System) is built to simplify:

Secure user authentication
Partner integrations via OAuth
API client management
Scalable and secure server deployment

This documentation is here to help you succeed — whether you’re a user, a partner, or a developer building with XWMS.

xwms / package

Maintainers

Details