Oqtane User Manuals
Welcome to the Oqtane User Manuals — your centralized hub for managing and customizing your Oqtane platform.
Whether you're a new user exploring the basics or an experienced administrator managing complex deployments, this guide will walk you through essential features using clear, structured instructions.
🧭 How to Navigate
This documentation is organized with your productivity in mind:
- Left Sidebar: Use the navigation tree to browse topics by category (e.g., Content Management, Site Administration).
- Top Navbar: Quickly jump to other key areas:
- Guides – for step-by-step tutorials and practical examples.
- User Manuals – where you are now, focused on platform features.
- Develop – for developers building modules, themes, and integrations.
- API Documentation – for low-level backend integrations and custom API work.
- Right Panel: View page-specific anchors for fast jumping within each document.
🔍 What You'll Find in the User Manuals
Here are just a few of the powerful features you can learn about:
🔧 Installation
- Installation Wizard: Set up your first Oqtane instance with ease.
- Configuration Tips: Troubleshoot database connections, file permissions, and environment variables.
🖼️ Content Management
- Control Panel: Access site-wide tools from any page.
- Page & Module Management: Create, edit, and organize your site's content structure.
- Content Editor: Inline editing tools to modify layout and styling on the fly.
🛠 Site Administration (Admin)
- Site Settings: Manage site-specific configuration including logos, component settings, smtp settings, cookie consent and more.
- User and Role Management: Create users, assign permissions, and manage profiles.
- File & Folder Management: Upload, organize, and serve files across the site.
- Visitor Logs & Recycle Bin: Maintain site hygiene and recover deleted items.
🧑💼 System Administration (Host)
- Event Log: View and diagnose system-wide events.
- System Info: Access diagnostics, environment data, and runtime options like logging and Swagger.
- System Update: Update the platform via direct download or NuGet upload.
- Scheduled Jobs: Automate and monitor background tasks.
- SQL Management: Run direct SQL queries securely from the browser.
✅ Getting Started Checklist
To get up and running quickly:
- Install Oqtane using the setup wizard.
- Log in as host or admin to unlock management tools.
- Use the Control Panel to navigate content and settings.
- Customize your site layout with the Content Editor.
- Explore advanced system and developer tools in the System section.
📚 Need More?
- Visit the Guides section for in-depth tutorials.
- Join our community via GitHub Discussions.
Tip: Bookmark this page or your favorite section for quick access during development or administration tasks.