diff --git a/src/pages/manuals/admin/admin-management/page-management.md b/src/pages/manuals/admin/admin-management/page-management.md index 3f48aff1..08c351bc 100644 --- a/src/pages/manuals/admin/admin-management/page-management.md +++ b/src/pages/manuals/admin/admin-management/page-management.md @@ -1,42 +1,131 @@ # Page Management -![page-management](./assets/page-management.png) +![Page Management](./assets/page-management.png) + +## Overview Pretty much every website starts out as one thing first and foremost: a collection of pages that constitute a web presence. Each page will have a purpose (we hope) and serve it well. As you have seen after the default installation of Oqtane, you are even given a home page to work with on the first load of your new site. Your next step might be to create additional pages, such as About Us, Contact Us, and more. + As your site continues to become successful and grows to meet the needs of your customers and other visitors, you will undoubtedly begin to have more and more pages on your site. You'll have so many that at some point you will need to manage them from a centralized location. In other cases, you might have pages that are hidden from the menu and are not easily accessible. This is where the Page Management feature comes in to allow for a larger overview of the pages on your website, with all pages on your website viewable in a list format. These pages can be manipulated in the page manager by being able to add, edit, and delete pages. -### Add +## Control Panel Walk-through + +### Accessing the Page Management Feature + +1. Click the control panel icon to access additional settings. + + ![Control Panel Icon](assets/control-panel-button.png) + +2. In the control panel, select the button to open the admin dashboard. + + ![Open Admin Dashboard](assets/control-panel-admin-dashboard-button.png) + +3. In the admin dashboard, click on the **Page Management** icon to configure your pages. + + ![Admin Dashboard Page Management](assets/admin-dashboard-page-management.png) + +--- + +## Adding a Page + +The add page feature adds a new page to your website and brings up the page management window, which allows you to specify the settings, appearance, and permissions for the page you are adding. + +Page management has an "Add Page" button, and when clicked, you get the following: + +![Add Page Settings](./assets/page-management-add-page-button.png) + +A window will appear with two tabs: **Settings** and **Permissions**. + +### Settings Tab +- **Name:** Enter a page name. +- **Parent:** Select the parent for the page in the site hierarchy (setting this to admin will create an admin dashboard page). +- **Insert:** Select the location where you would like the page to be inserted in relation to other pages (While in edit, this is changed to Move: Select the location where you would like the page to be moved in relation to other pages, so be sure to update this when talking about editing a page). +- **Navigation:** Select whether the page is part of the site navigation or hidden. +- **Clickable?:** Select whether the link in the site navigation is enabled or disabled. +- **URL Path:** Optionally enter a URL path for this page (i.e., home). If you do not provide a URL path, the page name will be used. If the page is intended to be the root path, specify '/'. +- **Redirect:** Optionally enter a URL which this page should redirect to when a user navigates to it. +- **Icon:** Optionally provide an icon class name for this page which will be displayed in the site navigation. +- **Effective Date:** The date that this page is active. +- **Expiry Date:** The date that this page expires. +- **Personalizable?:** Select whether you would like users to be able to personalize this page with their own content. + +![Add Page Settings](./assets/page-management-add-page-settings.png) + +**Appearance** +- **Title:** Optionally enter the page title. If you do not provide a page title, the page name will be used. +- **Theme:** Select the theme for this page. +- **Default Container:** Select the default container for the page. + +![Add Page Setttings Appearance](./assets/page-management-add-page-settings-appearance.png) + +**Page Content** +- **Head Content:** Optionally enter content to be included in the page head (i.e., meta, link, or script tags). +- **Body Content:** Optionally enter content to be included in the page body (i.e., script tags). + +![Add Page Settings Page Content](./assets/page-management-add-page-settings-page-content.png) + +### Permissions Tab + +The permissions tab has the following: +- A list of roles with "View Page" and "Edit Page" checkbox permissions to the right. +- Below that is a way to search for a user's name via text input and click the "Add" button. +- When users are added, below the "Role" list section will be an added "User" list that displays users with the permissions they have been granted. + +![Add Page Permissions](./assets/page-management-add-page-permissions.png) + +Use the **Save** button to save the page or **Cancel** button or use the **X** to close the window to escape it. + +## Search Pages + +Below the "Add Page" button on the main form: +- **Search by Name** input field to search for pages with a "Search" button to click to perform the search and a "Reset" button to reset the form. + +![Page Search](./assets/page-management-search.png) + +After this, there is a paginated list of pages with 3 buttons: Edit, Delete, and Browse. + +## Edit Page + +The edit page feature shares all of the same features as the add feature, allowing you to change the settings, appearances, and permissions of any page, with the insert feature being replaced by the move feature. The edit feature also shows you when a page was created and when the page was last edited at the bottom of the page management window. + +**Edit** button will pop up a window to edit the page features (tabs discussed while adding it). + +![Edit Page Button](./assets/page-management-edit-page-button.png) + +Editing page settings is as discussed in adding it with the exception of "Insert" option is now a"Move" option. + +![Edit Page Settings](./assets/page-management-edit-page-settings.png) + +Edit Page Appearance and Page Content options are the same as add page as shown below: + +![Edit Page Settings Page Appearance](./assets/page-management-edit-page-settings-appearance.png) + +![Edit Page Settings Page Content](./assets/page-management-edit-page-settings-page-content.png) + +In addition to these tabs are two more tabs: + +- **Modules:** Lists all the modules you can then "Edit" the modules on the page with an edit button to access that module's settings, or "Delete" to delete the module from the page. + + ![Edit Page Modules](./assets/page-management-edit-page-modules.png) + +- **Theme Settings:** Includes the following settings you can set that are all dropdown selections. + - **Settings Scope:** Specify if the settings are applicable to this page or the entire site. + - **Show Login:** Specify if a Login option should be displayed. Note that this option does not prevent the login page from being accessible via a direct URL. + - **Show Register:** Specify if a Register option should be displayed. Note that this option is also dependent on the Allow Registration option in Site Settings. + - **Display Fixed Footer?:** Specify if a Footer pane should always be displayed in a fixed location at the bottom of the page. -The add feature adds a new page to your website and brings up the page management window, which allows you to specify the settings, appearance, and permissions for the page you are adding. -The fields which exist in the page management window are the: + ![Edit Page Theme Settings](./assets/page-management-edit-page-theme-settings.png) ->#### Settings ->Name: Which specifies the name that will be displayed in the navigation bar. ->Parent: Which will specify the page that this page will be underneath, meaning that the added page will be put to the right of the page specified in the navigation bar at the top. ->Insert: Specify where the name for the page will appear in the navigation bar, by saying where the page should appear among all of the children of the parent that has been selected. ->Navigation: Say whether you want the page to be displayed to users that fit within the permissions, or if you want the page to be hidden to everyone but administrators which can be useful while editing a page. ->URL Path: The url is what is put in the web page's address, for example if the url path is set to page1 then the address might be www.website/page1.com. If no URL path is specified then the URL will by default be set to be the same as the name field above. ->Redirect: Input a URL that is the same as the URL path of another page in the site that user will be sent to, remember that if no URL path is specified for another page then the name will be used. If this feature is implemented then you will not be able stay on the page to use the control panel's page manager, so you will need to edit or delete page's with this feature. -![add-page](./assets/add-page.png) +## Delete Page ->#### Appearance ->Title: The name that is displayed on the web page's tab. ->Theme: The theme that the web page will take on. In the admin dashboard's theme management feature you can see more information on these theme and import new themes to be used. ->Default Container: Choose the layout of modules for the page, like hw the titles typically displayed above the modules will be. ->Icon: Input a favicon address or other icon address to include an icon beside the name of your page. ->Personalizable: This feature gives a page that is unique to every individual and allows them to add modules and edit the content of the page, so only the individual can see what they put onto the page. -![page-appearance](./assets/page-appearance.png) +You can **Delete** a page in the list of pages with a confirmation window popping up. The delete feature will delete the page that you are currently on and you can recover the page or fully delete the page in the admin dashboard's [Recycle Bin](recycle-bin.md). ->#### Permissions ->View: This is what allows different users to see certain pages and any users that are within certain roles, that can be specified in the admin dashboard's role management feature will be able to see or not see the page depending on what you have checked the box for the role they fit into. ->Edit: This allows users that fit into the specified roles to be able to edit pages using the content editor. ->Specific Users: The permissions tab also has the ability for you to enter a specific username and allow for you to set custom permissions for any specific users that you want. -![permissions](./assets/permissions.png) +## Browse Page -### Edit +A **Browse** button allows you to navigate to that page to view it on the site. -The edit feature shares all of the same features as the add feature, allowing you to change the settings, appearances, and permissions of any page, with the insert feature being replaced by the move feature. The edit feature also shows you when a page was created and when the page was last edited at the bottom of the page management window. +![Edit Page Theme Settings](./assets/page-management-browse-page-button.png) -### Delete +## Conclusion -The delete feature will delete the page that you are currently on and you can recover the page or fully delete the page in the admin dashboard's [recycle bin](recycle-bin.md). +Page Management provides a robust interface to control your website's pages effectively. With options to add, edit, delete, and manage permissions, you can ensure that your site grows and evolves as needed while maintaining a user-friendly experience. diff --git a/src/pages/manuals/admin/admin-management/profile-management.md b/src/pages/manuals/admin/admin-management/profile-management.md index ba44a459..fbf669ef 100644 --- a/src/pages/manuals/admin/admin-management/profile-management.md +++ b/src/pages/manuals/admin/admin-management/profile-management.md @@ -2,21 +2,80 @@ ![profile-management](./assets/profile-management.png) -The profile manager exposes one of the more powerful and under-appreciated features that Oqtane has to offer. The profile manager expose to you a few features, but the primary feature is the profile editor, which allows you to customize completely the profile fields that a user account has in nearly every way possible. This is the backbone of all of the user profile features in Oqtane. -The Oqtane profile manager allows for a user to specify more things about themselves than the typical information from a basic user account. Fields from the profile can be made to be required upon making an account such as making a name or address a required field. - -The profile page has an add profile button at the top of its page which includes: -* Name: The name of the profile item as it would be accessible in the [database](../host-administration/sql-management.md). -* Title: The title of the field displayed to the user. -* Description: Enter a description for the profile that will be what shows up for the help icon for the field. -* Category: The name for a grouping of fields such as the name or address headings that are by default included in the profile tab above their respective groupings of fields. -* Order: Choose the spot where in the list of profile fields that this one will appear with 0 being the first position. -* Lenth: The maximum length that can be input into this field, with a 0 for unlimited length. -* Default Value: The value that will be put into this field if the user doesn't enter anything into it. -* Options: Has the ability to create a list of items that can be selected and is enter by a list with commas in between the items (a,b,c). -* Required?: Specify whether or not the field is required upon the creation of a new account. -* Private: Specify whether it should be seen by regular user or should just been seen by administrators. -![add-profile](./assets/add-profile.png) - -There is also the option to edit or delete any of the fields that have already been created with edit and delete buttons on each item in the list of profile fields. -![edit-profile](./assets/edit-profile.png) +# Overview + +Profile Management in Oqtane provides a flexible and powerful way to customize user profiles. This feature is often underappreciated but is essential for creating tailored user experiences. The Profile Manager enables you to customize the fields of user accounts, from the name and address to custom fields with specific validation, required settings, and more. + +In Oqtane, the Profile Manager is primarily used to define profile fields, set field properties, and organize them into categories. Administrators can configure profile fields that users will interact with during account creation or editing. + +## Control Panel Walk-through + +### Accessing the Profile Management Feature + +1. Click the control panel icon to access additional settings. + + ![Control Panel Icon](assets/control-panel-button.png) + +2. In the control panel, select the button to open the admin dashboard. + + ![Open Admin Dashboard](assets/control-panel-admin-dashboard-button.png) + +3. In the admin dashboard, click on the **Profile Management** icon to configure visitor tracking. + + ![Admin Dashboard Profile Management](assets/admin-dashboard-profile-management.png) + +--- + +## Adding a Profile Item + +At the top of the Profile Management page, you will see an **Add Profile** button. Clicking this button brings up the settings for adding a new profile item. + +![profile-management-add-button](./assets/profile-management-add-button.png) + +### Profile Item Settings + +When adding a profile, the following settings are available: + +1. **Name**: The internal name of the profile item, used for database access. +2. **Title**: The label displayed to users for this profile item (e.g., "Full Name"). +3. **Description**: Help text displayed next to the field for user guidance. +4. **Category**: The grouping name for the profile item (e.g., "Personal Information"). +5. **Order**: The index position where this item will appear in the profile form. `0` is the first position. +6. **Length**: The maximum number of characters allowed for this profile field. Set to `0` for unlimited length. +7. **Rows**: The number of rows for text input. If set to more than one row, the input changes from a single-line text field to a multi-line text area. +8. **Default Value**: The pre-filled value for the profile item if the user does not provide one. +9. **Options**: A comma-separated list of selectable options (e.g., "Male,Female,Other"). +10. **Required?**: Whether this field is required for the user to complete when creating their account. +11. **Validation**: Optionally, provide a regular expression (RegEx) for validating the entered value (e.g., for email addresses). +12. **Autocomplete**: The HTML `autocomplete` attribute for browser assistance with autofilling the field. Options include blank (default), 'on', 'off', or any value from the standardized taxonomy. +13. **Private?**: Whether this profile field is visible to all users or only administrators. + +Once these settings are configured, click **Save** to create the profile item. You can also cancel the action or close the window by clicking the **X** in the top-right corner. + +![Profile Management Add Settings Window](./assets/profile-management-add-settings-window.png) + +## Searching Profiles + +Below the **Add Profile** button, there is a **Search** input field. This allows you to search for profile items based on their **Title** or **Category**. You can enter a search term and click **Search** to filter the list of profile items. To reset the search results, click the **Reset** button. + +![profile-management-search](./assets/profile-management-search.png) + +## Profile List + +Below the search field, a list of existing profile items is displayed. For each profile item, the following properties are shown: + +- **Name**: The internal name. +- **Title**: The displayed label for the profile item. +- **Category**: The group/category the profile item belongs to. +- **Order**: The position of the profile item in the list. + +Each profile item has two buttons: + +- **Edit**: Clicking this button opens the profile settings in an editable form where you can change any of the properties. After editing, click **Save** to apply changes, or **Cancel** to discard them. You can also close the settings window by clicking the **X** at the top-right. +- **Delete**: Clicking the delete button opens a confirmation window asking you to confirm the deletion of the profile item. Once confirmed, the profile item is permanently deleted. + +![Profile Management Edit Settings Window](./assets/profile-management-edit-settings-window.png) + +## Conclusion + +The Profile Management feature in Oqtane provides administrators with powerful tools to customize and manage user profiles. Whether you're creating new profile fields or setting validation rules, this feature is essential for tailoring the user experience on your site. Be sure to explore all options to make the most of your site’s profile management capabilities. diff --git a/src/pages/manuals/admin/admin-management/recycle-bin.md b/src/pages/manuals/admin/admin-management/recycle-bin.md index a0487012..5ef17ff6 100644 --- a/src/pages/manuals/admin/admin-management/recycle-bin.md +++ b/src/pages/manuals/admin/admin-management/recycle-bin.md @@ -2,6 +2,78 @@ ![recycle-bin](./assets/recycle-bin.png) -The Recycle Bin is a very useful and often overlooked feature of Oqtane, especially for new users. Oftentimes, a newly designated administrator for a site will simply assume that when something is deleted, it is gone. The next logical step would probably be to re-create the content that was just deleted. This could lead to frustrations with Oqtane. The Recycle Bin allows you to restore the content in most cases, which can save you time and frustration. -The Recycle Bin has two types of objects that can be restored, Pages and Modules. When you delete a page or a module, it will show up in the respective list. You can switch which list you're looking at by clicking the tabs at the top of the page. Clicking retore on one of the pages or modules will allow you to restore the selected item to their original place in your site. -The recycle bin feature has two options, restore and delete. With the restore button, the page or module is restored to its original location. The delete button permanently deletes the page from your website and you will cause it be removed permanently. \ No newline at end of file + +## Overview + +The Recycle Bin is a valuable feature of Oqtane, especially for new users and administrators who might assume that deleted content is permanently gone. Instead of recreating deleted items, the Recycle Bin allows you to restore content, saving time and reducing frustration. + +The Recycle Bin manages two types of objects that can be restored: **Pages** and **Modules**. When you delete a page or a module, it appears in the corresponding list. You can switch between these lists by clicking the tabs at the top of the page. + +## Control Panel Walk-through + +### Accessing the Recycle Bin Feature + +1. Click the control panel icon to access additional settings. + + ![Control Panel Icon](assets/control-panel-button.png) + +2. In the control panel, select the button to open the admin dashboard. + + ![Open Admin Dashboard](assets/control-panel-admin-dashboard-button.png) + +3. In the admin dashboard, click on the **Recycle Bin** icon to configure visitor tracking. + + ![Admin Dashboard Recycle Bin](assets/admin-dashboard-recycle-bin.png) + +--- + +## Features + +- **Restore**: Clicking the restore button for a selected page or module will return it to its original location on your site. +- **Delete**: The delete button permanently removes the selected page or module from your website, ensuring it cannot be restored. + +## Tabs + +The Recycle Bin includes two tabs: + +### Pages Tab + +In the Pages tab, you can view a list of deleted pages with the following information: + +- **Name**: The title of the deleted page. +- **Deleted By**: The user who deleted the page. +- **Deleted On**: The date and time when the page was deleted. + +Each entry includes two buttons: + +- **Restore**: Restores the selected page to its original location. +- **Delete**: Permanently deletes the page from the Recycle Bin. + +![pages-tab](./assets/recycle-bin.png) + +### Modules Tab + +Similar to the Pages tab, the Modules tab displays a list of deleted modules with the same information as above. It also includes the same restore and delete functionality. + +![modules-tab](./assets/recycle-bin-modules.png) + +## Manage Deleted Items + +At the bottom of each tab, there are additional buttons: + +- **Remove All Deleted Pages**: This button allows you to permanently delete all pages listed in the Recycle Bin. A confirmation window will appear before finalizing this action. + +![remove-all-deleted-pages](./assets/recycle-bin-pages-remove-all-deleted-pages-button.png) + +![remove-all-deleted-pages](./assets/recycle-bin-pages-remove-all-deleted-pages-confirmation.png) + +- **Delete All Deleted Modules**: This button serves the same purpose for modules, allowing you to permanently delete all modules from the Recycle Bin, accompanied by a confirmation window. + +![remove-all-deleted-modules](./assets/recycle-bin-pages-remove-all-deleted-modules-button.png) + +![remove-all-deleted-modules-confirmation](./assets/recycle-bin-pages-remove-all-deleted-modules-confirmation.png) + + +## Conclusion + +The Recycle Bin in Oqtane is an essential feature for content management, providing an easy way to recover deleted pages and modules. By using the restore functionality, administrators can efficiently manage their site's content without the hassle of recreating items. Familiarize yourself with this feature to maximize the efficiency and usability of your Oqtane site. diff --git a/src/pages/manuals/admin/admin-management/role-management.md b/src/pages/manuals/admin/admin-management/role-management.md index 7a468693..feffbbe2 100644 --- a/src/pages/manuals/admin/admin-management/role-management.md +++ b/src/pages/manuals/admin/admin-management/role-management.md @@ -2,9 +2,107 @@ ![Role Management](./assets/role-management.png) -Security Roles in Oqtane are nothing more than a grouping of one or more users for a purpose. That purpose is up to you. The purpose could be to see exclusive content in a specific area of the site or on specific pages in the site. It could also be to have the ability to edit content on one or more pages or to create content in a specific module, like a blog. We could go on and on. Just remember that Security Roles can be used for content targeting, editing, and hiding sections of your site. -Security Roles work the same as most permissions-based systems, such as Windows. You first create a Security Role if it doesn't already exist to create a grouping of users. Then, you add one or more people to that group. Once you do that minimal setup, you can apply that group to various capabilities, permissions, and features. -Permissions are set when creating or editing pages and modules by selecting which roles can edit or view them. -![permissions](./assets/permissions.png) -At the top of the page is the add role button that allows for the addition of a new group you want to make, with a name, description, and saying if it should be automatically assigned to users. You can edit, delete, and manage users in each role except for the default administrator and registered users roles which you cannot edit or delete, you can only manage their users. -When adding a user into a role, there are fields for effective date and expiry date, which determines when a user will be added to a roles and how long they will be inside of a role. +## Overview + +The **Role Management** feature in Oqtane allows you to create and manage security roles, which are groupings of users assigned specific permissions or access. Roles can be used for content targeting, granting editing rights, or restricting access to certain areas of your site. + +Security roles operate similarly to permission-based systems: first, you create a role to group users, then add users to the group, and finally, assign the group permissions on pages or modules. + +--- + +## Control Panel Walk-through + +### Accessing the Role Management Feature + +1. Click the **Control Panel** icon to access additional settings. + + ![Control Panel Icon](assets/control-panel-button.png) + +2. In the control panel, select the button to open the **Admin Dashboard**. + + ![Open Admin Dashboard](assets/control-panel-admin-dashboard-button.png) + +3. In the admin dashboard, click on the **Role Management** icon to manage user roles. + + ![Admin Dashboard Role Management](assets/admin-dashboard-role-management.png) + +--- + +## Role Management Features + +### 1. **Add Role** + +The **Add Role** feature enables you to create a new user role with specific settings. + +![Add Role Button](./assets/role-management-add-role-button.png) + +#### **Add Role Settings** +When you click **Add Role**, a window opens with the following fields: + +- **Name:** The name of the role, as it will appear in the role list. +- **Description:** A brief description explaining the role's purpose. +- **Auto Assigned?**: Select **Yes** or **No** to determine whether new users are automatically assigned to this role. + +After filling out the settings, use the **Save** button to create the role, or **Cancel** to discard changes. You can also use the **X** button in the top-right corner to close the window without saving. + +![Add/Edit Role Window](./assets/role-management-add-edit-window.png) + +--- + +### 2. **Search Roles** + +The **Search Roles** function allows you to quickly find roles by name. Enter the name in the **Search** field and click **Search** to filter results, or **Reset** to clear the search. + +![Search Roles](./assets/role-management-search.png) + +--- + +### 3. **Role List** + +The **Role List** displays all existing roles, including default roles such as **Administrators** and **Registered Users**. For each role, you can perform the following actions: + +| **Action** | **Description** | +|------------|---------------------------------------------------------------------------------------------------------| +| **Edit** | Modify the role's name, description, and auto-assign settings (disabled for Administrators and Registered Users). | +| **Delete** | Permanently removes the role from the system (disabled for Administrators and Registered Users). | +| **Users** | Manage users within the role, including adding or removing users. | + +--- + +### 4. **Edit Role** + +Clicking the **Edit** button for a role opens the same window as the **Add Role** feature, where you can modify the role's **Name**, **Description**, and **Auto Assigned** settings. + +![Edit Role Button](./assets/role-management-edit-button.png) + +Note: The **Edit** button is disabled for system roles like **Administrators** and **Registered Users**. + +--- + +### 5. **Delete Role** + +Clicking the **Delete** button will delete a role. Deleting a role removes its permissions and cannot be undone. System roles like **Administrators** and **Registered Users** cannot be deleted. + +--- + +### 6. **Manage Users in a Role** + +The **Users** button allows you to add or remove users from a specific role. Clicking **Users** for a role opens a window where you can: + +- **User:** Enter the user’s name to add them to the role. +- **Effective Date:** Set the date when the role assignment starts. +- **Expiry Date:** Set the date when the role assignment ends (optional). + +At the bottom of this window, you can view a list of all users currently assigned to the role. + +![Manage Users in Role](./assets/role-management-users-window.png) + +Use **Save** to apply changes, **Cancel** to discard changes, or **X** to close the window. + +--- + +## Summary + +The **Role Management** feature in Oqtane allows you to organize users by roles, granting or restricting access based on the assigned role. With options to add, edit, delete, and manage users in roles, you have flexibility in setting up and controlling permissions for your site. + + diff --git a/src/pages/manuals/admin/admin-management/site-settings.md b/src/pages/manuals/admin/admin-management/site-settings.md index 30e2125c..c8bedd58 100644 --- a/src/pages/manuals/admin/admin-management/site-settings.md +++ b/src/pages/manuals/admin/admin-management/site-settings.md @@ -1,33 +1,101 @@ # Site Settings -![smtp-settings](./assets/site-settings.png) - -The Site Settings feature contains a large number of settings that you can use to perform high-level administrative configuration for your site. The Settings mostly contains set-it-and-forget it options that should be managed once when you build your site. Some of these settings include the default look and feel for new pages created on your site, your site logo, and default metadata for pages. The main parts of the settings are basic settings, SMTP configuration, and progressive web app configuration. - -### Basic Settings -Basic Settings mostly contains set-it-and-forget it options that should be managed once when you build your site. -* Name: What you want to call the website. -* Tenant: The name of the database you wan the site to use. -* Aliases: The name that will appear for the sites URL. -* Logo: The logo that will appear in the navigation bar. -* Favicon: Enter a favicon address or another icon address to have a default icon to appear beside each page in the navigation bar. -* Default Theme: Choose a default theme tht will give a different color scheme and structure. -* Default Layout: Choose how many columns a page has by default. -* Default Container: Choose if you want titles to appear about each module by default. -* Allow User Registration: Should users be able to create their own accounts or should only administrators be able to create accounts. -* Is Deleted: Select whether you want to delete this site. - -### SMTP Server (Secure Mail Transfer Protocol) -The Oqtane instance sends outbound email for a variety of reasons, from the host or site admin or in the form of password reminders, event notifications, newsletters, or other business-specific use cases. A valid SMTP server is required for this to work; you should consult your network administrator for the appropriate credentials to use in a production configuration. Most non-Exchange Server SMTP hosts will require “Basic” authentication and a valid username/password combination. Some will also require that SSL be enabled. -* Host: Enter the host name for the server. -* Port: Enter the port number that the server is on. -* SSL Enabled: Specify yes or no if the SMTP server has an SSL certificate. -* Username: Enter the username for the SMTP server you are accessing. -* Password: Enter the password for the SMTP server you are accessing. +![site-settings](./assets/site-settings.png) + + +## Overview + +The Site Settings feature allows you to perform high-level administrative configurations for your site. This includes basic settings, SMTP configuration, and progressive web app (PWA) settings. Most options are set-it-and-forget-it and should be configured once when building your site. + +## Control Panel Walk-through + +### Accessing the Site Settings Feature + +1. Click the control panel icon to access additional settings. + + ![Control Panel Icon](assets/control-panel-button.png) + +2. In the control panel, select the button to open the admin dashboard. + + ![Open Admin Dashboard](assets/control-panel-admin-dashboard-button.png) + +3. In the admin dashboard, click on the **Site Settings** icon to configure visitor tracking. + + ![Admin Dashboard Search Settings](assets/admin-dashboard-site-settings.png) + +--- + +## Site Settings + +The **Site Settings** management feature includes foundational settings for your site. + +- **Name**: Enter the site name. +- **Home Page**: Select the home page for the site (to be used if there is no page with a path of '/'). +- **Deleted?**: Indicates whether the site is deleted. +- **Site Map**: The site map URL for this site, which can be submitted to search engines for indexing. +- **ID**: The unique identifier for the site. +- **Version**: Site version for content migrations. + +### Appearance + +The Appearance section includes options related to the visual representation of your site. + +- **Logo**: Specify a site logo using the file manager for easy selection, upload, and deletion. +- **Favicon**: Specify a favicon with the same file manager options as the logo. +- **Default Theme**: Select the site’s default theme. +- **Default Container**: Choose the default container for the site. +- **Default Admin Container**: Select the default admin container for the site. + +![appearance-settings](./assets/site-settings-appearance.png) + +### Functionality + +The Functionality section allows you to configure essential site functionalities. + +- **Text Editor**: Select the text editor for the site (default is the QuillJS editor). For more information, see the [HTML Text Editor Documentation](../content-management/html-text-editor.md). +- **Image Extensions**: Enter a comma-separated list of allowed image extensions. +- **Uploadable File Extensions**: Enter a comma-separated list of allowed uploadable file extensions. + +![functionality-settings](./assets/site-settings-functionality.png) + +### Page Content + +The Page Content section lets you define additional content that can be included in your pages. + +- **Head Content**: Optionally enter content to be included in the page head (e.g., meta, link, or script tags). +- **Body Content**: Optionally enter content to be included in the page body (e.g., script tags). + +![page-content-settings](./assets/site-settings-page-content.png) + +### SMTP Settings + +**Please Note That SMTP Requires The Notification Job To Be Enabled In Scheduled Jobs** + +- **Host**: Enter the hostname of the SMTP server. +- **Port**: Enter the port number for the SMTP server. This field is required if you provide a host name. +- **SSL Enabled**: Specify yes or no. +- **Username**: Enter the SMTP server username. +- **Password**: Enter the SMTP server password. +- **Email Sender**: Enter the email address from which emails will be sent. This email address may need to be authorized with the SMTP server. +- **Relay Configured?**: Only specify this option if you have properly configured an SMTP Relay Service to route your outgoing mail. This will send notifications from the user's email rather than from the Email Sender specified above. +- **Enabled?**: Specify yes or no to enable SMTP. +- **Retention (Days)**: Enter the number of days to retain notifications. +- **Test SMTP Configuration**: Button to test the SMTP configuration. + ![smtp-settings](./assets/site-settings-smtp-settings.png) -### Progressive Web Application Settings -* Is Enabled: Choose whether or not you want the site to be set up as a progressive web application. -* App Icon: Select a PNG image that is 192 X 192 pixels which will be the app icon for your application. -* Splash Icon: Select a PNG image that is 512 X 512 pixels which will appear on the screen while the application is loading. +![smtp-settings](./assets/site-settings-smtp-settings-test-smtp-configuration-button.png) + +### PWA Settings + +The PWA Settings section allows you to configure the Progressive Web Application capabilities of your site. + +- **Is Enabled?**: Choose whether the site will be available as a Progressive Web Application (PWA). +- **App Icon**: Upload an application icon for your PWA (PNG, 192 x 192 pixels). +- **Splash Icon**: Upload a splash icon for your PWA (PNG, 512 x 512 pixels). + ![pwa-settings](./assets/site-settings-pwa-settings.png) + +## Conclusion + +Configuring the Site Settings correctly is crucial for the proper functioning and appearance of your site. Ensure all options are set according to your site's requirements, especially the SMTP settings for email functionality and PWA settings if you wish to enable a progressive web application experience. For further assistance, refer to other sections of the Oqtane documentation. diff --git a/src/pages/manuals/admin/admin-management/url-mappings.md b/src/pages/manuals/admin/admin-management/url-mappings.md index 680d37bb..42e6d89e 100644 --- a/src/pages/manuals/admin/admin-management/url-mappings.md +++ b/src/pages/manuals/admin/admin-management/url-mappings.md @@ -16,15 +16,15 @@ The **URL Mappings** feature allows administrators to define mappings from one U 1. Click the control panel icon to access additional settings. - ![Control Panel Icon](assets/control-panel-button.jpg) + ![Control Panel Icon](assets/control-panel-button.png) 1. In the control panel, select the button to open the admin dashboard. - ![Open Admin Dashboard](assets/control-panel-admin-dashboard-button.jpg) + ![Open Admin Dashboard](assets/control-panel-admin-dashboard-button.png) 1. In the admin dashboard, click on the URL Mappings icon to configure your URL mappings. - ![Admin Dashboard URL Mappings](assets/admin-dashboard-url-mappings.jpg) + ![Admin Dashboard URL Mappings](assets/admin-dashboard-url-mappings.png) --- diff --git a/src/pages/manuals/admin/content-management/assets/content-edit-module-options-caret-bottom-button.png b/src/pages/manuals/admin/content-management/assets/content-editor-module-options-caret-bottom-button.png similarity index 100% rename from src/pages/manuals/admin/content-management/assets/content-edit-module-options-caret-bottom-button.png rename to src/pages/manuals/admin/content-management/assets/content-editor-module-options-caret-bottom-button.png diff --git a/src/pages/manuals/admin/content-management/html-text-editor.md b/src/pages/manuals/admin/content-management/html-text-editor.md index 5d4a5d20..b1d0e85c 100644 --- a/src/pages/manuals/admin/content-management/html-text-editor.md +++ b/src/pages/manuals/admin/content-management/html-text-editor.md @@ -52,7 +52,7 @@ Each editor (Rich Text and HTML) includes an **"Insert Image"** button that open - **Select Folder** – Choose the folder where images are stored. - **Select File** – Pick an image file from the selected folder. - ![HTML/Text Editor Select Folder/File](./assets/html-text-editor-select-folder-file.png) + ![HTML/Text Editor Select Folder/File](./assets/html-text-editor-insert-image-select-file.png) Once an image file is selected, click the **Insert Image** button. @@ -62,7 +62,7 @@ Once an image file is selected, click the **Insert Image** button. ![HTML/Text Editor Upload File Button](./assets/html-text-editor-upload-file-button.png) -If you encounter issues with uploading files, see the [Troubleshooting File Manager](../../guides/troubleshooting/troubleshooting-file-manager.md) guide. +If you encounter issues with uploading files, see the [Troubleshooting File Manager](../../../guides/troubleshooting/troubleshooting-file-manager.md) guide. After uploading the image to the selected folder, click the **Insert Image** button. @@ -107,4 +107,4 @@ Each version offers the following actions: After clicking **Delete**, you will be prompted to confirm. To proceed, click the **Delete** button in the confirmation window. - ![HTML/Text Editor Versions Confirm Delete Button](./assets/html-text-editor-versions-confirm-delete-button.png) + ![HTML/Text Editor Versions Confirm Delete Button](./assets/html-text-editor-versions-confirm-delete-button.png) diff --git a/src/pages/manuals/admin/content-management/image.png b/src/pages/manuals/admin/content-management/image.png deleted file mode 100644 index 7d02f9e1..00000000 Binary files a/src/pages/manuals/admin/content-management/image.png and /dev/null differ diff --git a/src/pages/manuals/admin/content-management/module-management.md b/src/pages/manuals/admin/content-management/module-management.md index c3580276..6ca57bb1 100644 --- a/src/pages/manuals/admin/content-management/module-management.md +++ b/src/pages/manuals/admin/content-management/module-management.md @@ -1,6 +1,6 @@ # Module Management -Modules are a key feature of Oqtane, allowing you to insert a diverse array of components into your web pages. With a variety of modules available, you can customize your site extensively. Administrators have the ability to download new modules or upload custom modules to the marketplace, which can be accessed via the admin dashboard's [Module Management feature](../modules/index.md). +Modules are a key feature of Oqtane, allowing you to insert a diverse array of components into your web pages. With a variety of modules available, you can customize your site extensively. Administrators have the ability to download new modules or upload custom modules to the marketplace, which can be accessed via the `Host` user **Admin Dashboard's** [Module Management feature](../../admin/host-management/module-management.md). ## Accessing Module Management diff --git a/src/pages/manuals/admin/content-management/page-management.md b/src/pages/manuals/admin/content-management/page-management.md index b87a06a1..869bcfc5 100644 --- a/src/pages/manuals/admin/content-management/page-management.md +++ b/src/pages/manuals/admin/content-management/page-management.md @@ -18,11 +18,11 @@ ___ - **Insert**: Specifies the position of the page among its siblings under the selected parent. - **Navigation**: Determines if the page should be visible to users with appropriate permissions or hidden from everyone but administrators. - **URL Path**: Sets the URL for the page. If no path is specified, it defaults to the name. -- **Redirect**: URL to redirect users if this page is accessed. If set, you will need to use the admin dashboard’s [page management feature](./admin-management/page-management.md) to manage this page further. +- **Redirect**: URL to redirect users if this page is accessed. If set, you will need to use the admin dashboard’s [page management feature](../admin-management/page-management.md) to manage this page further. #### Appearance - **Title**: Name displayed on the web browser tab. -- **Theme**: Select a theme from those available in the [theme manager](../host-administration/theme-management.md). +- **Theme**: Select a theme from those available in the [theme management](../host-management/theme-management.md). - **Layout**: Number of content panes (columns) available on the page. - **Default Container**: Layout style for module titles above the content. - **Icon**: URL for a favicon or other icon associated with the page. diff --git a/src/pages/manuals/admin/host-management/assets/language-management-add-language-button.png b/src/pages/manuals/admin/host-management/assets/language-management-add-language-button.png new file mode 100644 index 00000000..af9507c4 Binary files /dev/null and b/src/pages/manuals/admin/host-management/assets/language-management-add-language-button.png differ diff --git a/src/pages/manuals/admin/host-management/assets/language-management-upload.png b/src/pages/manuals/admin/host-management/assets/language-management-upload-window.png similarity index 100% rename from src/pages/manuals/admin/host-management/assets/language-management-upload.png rename to src/pages/manuals/admin/host-management/assets/language-management-upload-window.png diff --git a/src/pages/manuals/admin/host-management/assets/language-management.png b/src/pages/manuals/admin/host-management/assets/language-management.png new file mode 100644 index 00000000..8d0f798e Binary files /dev/null and b/src/pages/manuals/admin/host-management/assets/language-management.png differ diff --git a/src/pages/manuals/admin/host-management/assets/module-management-create-module-created-success-notification.png b/src/pages/manuals/admin/host-management/assets/module-management-create-module-created-success-notification.png new file mode 100644 index 00000000..e0d20f74 Binary files /dev/null and b/src/pages/manuals/admin/host-management/assets/module-management-create-module-created-success-notification.png differ diff --git a/src/pages/manuals/admin/host-management/assets/module-management-create-module-production-notification.png b/src/pages/manuals/admin/host-management/assets/module-management-create-module-production-notification.png new file mode 100644 index 00000000..c869ab9f Binary files /dev/null and b/src/pages/manuals/admin/host-management/assets/module-management-create-module-production-notification.png differ diff --git a/src/pages/manuals/admin/host-management/assets/module-management-create-module-settings-description.png b/src/pages/manuals/admin/host-management/assets/module-management-create-module-settings-description.png new file mode 100644 index 00000000..56c17a6d Binary files /dev/null and b/src/pages/manuals/admin/host-management/assets/module-management-create-module-settings-description.png differ diff --git a/src/pages/manuals/admin/host-management/assets/module-management-create-module-settings-location.png b/src/pages/manuals/admin/host-management/assets/module-management-create-module-settings-location.png new file mode 100644 index 00000000..a08edb03 Binary files /dev/null and b/src/pages/manuals/admin/host-management/assets/module-management-create-module-settings-location.png differ diff --git a/src/pages/manuals/admin/host-management/assets/module-management-create-module-settings-module-name.png b/src/pages/manuals/admin/host-management/assets/module-management-create-module-settings-module-name.png new file mode 100644 index 00000000..4f885107 Binary files /dev/null and b/src/pages/manuals/admin/host-management/assets/module-management-create-module-settings-module-name.png differ diff --git a/src/pages/manuals/admin/host-management/assets/module-management-create-module-settings-owner-name.png b/src/pages/manuals/admin/host-management/assets/module-management-create-module-settings-owner-name.png new file mode 100644 index 00000000..6237e5ef Binary files /dev/null and b/src/pages/manuals/admin/host-management/assets/module-management-create-module-settings-owner-name.png differ diff --git a/src/pages/manuals/admin/host-management/assets/module-management-create-module-settings-template.png b/src/pages/manuals/admin/host-management/assets/module-management-create-module-settings-template.png new file mode 100644 index 00000000..20e2da80 Binary files /dev/null and b/src/pages/manuals/admin/host-management/assets/module-management-create-module-settings-template.png differ diff --git a/src/pages/manuals/admin/host-management/assets/module-management-create-module-settings-window-buttons.png b/src/pages/manuals/admin/host-management/assets/module-management-create-module-settings-window-buttons.png new file mode 100644 index 00000000..317d7b6c Binary files /dev/null and b/src/pages/manuals/admin/host-management/assets/module-management-create-module-settings-window-buttons.png differ diff --git a/src/pages/manuals/admin/host-management/assets/module-management-create-module-settings-window.png b/src/pages/manuals/admin/host-management/assets/module-management-create-module-settings-window.png new file mode 100644 index 00000000..d3456edb Binary files /dev/null and b/src/pages/manuals/admin/host-management/assets/module-management-create-module-settings-window.png differ diff --git a/src/pages/manuals/admin/host-management/assets/site-settings-database.png b/src/pages/manuals/admin/host-management/assets/site-settings-database.png index adff795e..728944df 100644 Binary files a/src/pages/manuals/admin/host-management/assets/site-settings-database.png and b/src/pages/manuals/admin/host-management/assets/site-settings-database.png differ diff --git a/src/pages/manuals/admin/host-management/assets/site-settings-site-urls-add-button.png b/src/pages/manuals/admin/host-management/assets/site-settings-site-urls-add-button.png new file mode 100644 index 00000000..6c3bc44d Binary files /dev/null and b/src/pages/manuals/admin/host-management/assets/site-settings-site-urls-add-button.png differ diff --git a/src/pages/manuals/admin/host-management/assets/site-settings-site-urls-add-window.png b/src/pages/manuals/admin/host-management/assets/site-settings-site-urls-add-window.png new file mode 100644 index 00000000..27b32168 Binary files /dev/null and b/src/pages/manuals/admin/host-management/assets/site-settings-site-urls-add-window.png differ diff --git a/src/pages/manuals/admin/host-management/assets/site-settings-site-urls-delete-button.png b/src/pages/manuals/admin/host-management/assets/site-settings-site-urls-delete-button.png new file mode 100644 index 00000000..dfc1b79a Binary files /dev/null and b/src/pages/manuals/admin/host-management/assets/site-settings-site-urls-delete-button.png differ diff --git a/src/pages/manuals/admin/host-management/assets/site-settings-site-urls-delete-confirmation-window.png b/src/pages/manuals/admin/host-management/assets/site-settings-site-urls-delete-confirmation-window.png new file mode 100644 index 00000000..2208d513 Binary files /dev/null and b/src/pages/manuals/admin/host-management/assets/site-settings-site-urls-delete-confirmation-window.png differ diff --git a/src/pages/manuals/admin/host-management/assets/site-settings-site-urls-edit-button.png b/src/pages/manuals/admin/host-management/assets/site-settings-site-urls-edit-button.png new file mode 100644 index 00000000..d97f0497 Binary files /dev/null and b/src/pages/manuals/admin/host-management/assets/site-settings-site-urls-edit-button.png differ diff --git a/src/pages/manuals/admin/host-management/assets/site-settings-site-urls-edit-window.png b/src/pages/manuals/admin/host-management/assets/site-settings-site-urls-edit-window.png new file mode 100644 index 00000000..9492647f Binary files /dev/null and b/src/pages/manuals/admin/host-management/assets/site-settings-site-urls-edit-window.png differ diff --git a/src/pages/manuals/admin/host-management/assets/site-settings-ui-component-settings-hybrid.png b/src/pages/manuals/admin/host-management/assets/site-settings-ui-component-settings-hybrid.png new file mode 100644 index 00000000..ce9bd95b Binary files /dev/null and b/src/pages/manuals/admin/host-management/assets/site-settings-ui-component-settings-hybrid.png differ diff --git a/src/pages/manuals/admin/host-management/assets/site-settings-ui-component-settings-prerender.png b/src/pages/manuals/admin/host-management/assets/site-settings-ui-component-settings-prerender.png new file mode 100644 index 00000000..d01f9b5d Binary files /dev/null and b/src/pages/manuals/admin/host-management/assets/site-settings-ui-component-settings-prerender.png differ diff --git a/src/pages/manuals/admin/host-management/assets/site-settings-ui-component-settings.png b/src/pages/manuals/admin/host-management/assets/site-settings-ui-component-settings.png index 36dc9263..f06679ca 100644 Binary files a/src/pages/manuals/admin/host-management/assets/site-settings-ui-component-settings.png and b/src/pages/manuals/admin/host-management/assets/site-settings-ui-component-settings.png differ diff --git a/src/pages/manuals/admin/host-management/assets/theme-management-create-theme-created-success-notification.png b/src/pages/manuals/admin/host-management/assets/theme-management-create-theme-created-success-notification.png new file mode 100644 index 00000000..27234340 Binary files /dev/null and b/src/pages/manuals/admin/host-management/assets/theme-management-create-theme-created-success-notification.png differ diff --git a/src/pages/manuals/admin/host-management/assets/theme-management-create-theme-production-notification.png b/src/pages/manuals/admin/host-management/assets/theme-management-create-theme-production-notification.png new file mode 100644 index 00000000..a6c2c041 Binary files /dev/null and b/src/pages/manuals/admin/host-management/assets/theme-management-create-theme-production-notification.png differ diff --git a/src/pages/manuals/admin/host-management/assets/theme-management-create-theme-settings-framework-reference.png b/src/pages/manuals/admin/host-management/assets/theme-management-create-theme-settings-framework-reference.png new file mode 100644 index 00000000..f715d5ff Binary files /dev/null and b/src/pages/manuals/admin/host-management/assets/theme-management-create-theme-settings-framework-reference.png differ diff --git a/src/pages/manuals/admin/host-management/assets/theme-management-create-theme-settings-location.png b/src/pages/manuals/admin/host-management/assets/theme-management-create-theme-settings-location.png new file mode 100644 index 00000000..b5635b5a Binary files /dev/null and b/src/pages/manuals/admin/host-management/assets/theme-management-create-theme-settings-location.png differ diff --git a/src/pages/manuals/admin/host-management/assets/theme-management-create-theme-settings-template.png b/src/pages/manuals/admin/host-management/assets/theme-management-create-theme-settings-template.png new file mode 100644 index 00000000..9cf26dd4 Binary files /dev/null and b/src/pages/manuals/admin/host-management/assets/theme-management-create-theme-settings-template.png differ diff --git a/src/pages/manuals/admin/host-management/event-log.md b/src/pages/manuals/admin/host-management/event-log.md index f5c5d94a..6ad84d3b 100644 --- a/src/pages/manuals/admin/host-management/event-log.md +++ b/src/pages/manuals/admin/host-management/event-log.md @@ -1,32 +1,103 @@ # Event Log -The Event log allows you to know what's happening on your website at all times. On the surface, the Event log may seem very simple and it is. You have a listing of the most recent events immediately visible on page load. This list is going to be any number of pages with 10 events by default on each page of results and the option to see more rows at a time. - -A paging feature at the bottom of the list allows you to move from page to page. -If you want to filter the events to see more or fewer events, you have three controls at the top of the listing to help you. You can filter by the type of event that you want to see with the event Level and Function: - -* Level: The level specifies the severity of the event and includes options for: - * Trace - * Debug - * Information - * Warning - * Error - * Critical - -![event-level](./assets/event-level.png) - -* Function: The function is what type of feature is being used and is color-coated for easier viewing. It includes options for: - * Create - * Read - * Update - * Delete - * Security - * Other - -![event-function](./assets/event-function.png) - -* Rows: Choose how many rows you would like to have displayed on page. -The feature and date are also shown in the event list but aren't sortable fields, with the feature showing what part of the Oqtane framework is being used. -For example, you might be interested only in seeing instances of site users attempting to log in. To see this, simply change the Function drop-down list to Security, and only security events like the login event will be shown to you. -In other cases, you might want to see a larger list of events. There are many reasons for this. One reason might be searching for something specific using built-in features of your web browser, such as using Ctrl+F to “find” something in the page. As an example, you could switch the event log to show 100 events by changing the rows. -For each event that is displayed you can select the detail button to show more information on where the event happened and a more in-depth description on what the event is. +![Event Log](./assets/event-log.png) + +## Overview + +The Event Log provides a centralized record of events occurring on your website, allowing you to monitor site activity and troubleshoot as needed. It is designed to be both simple and effective for viewing and managing events. + +## Control Panel Walk-through + +### Accessing the Event Log Feature + +1. **Open the Control Panel**: Click the **control panel icon** to access additional settings. + + ![Control Panel Icon](./assets/control-panel-button.png) + +2. **Open the Admin Dashboard**: In the control panel, select the **Admin Dashboard** button. + + ![Open Admin Dashboard](./assets/control-panel-admin-dashboard-button.png) + +3. **Select the Event Log**: In the Admin Dashboard, click on the **Event Log** icon to view and configure event logging. + + ![Admin Dashboard Event Log](./assets/admin-dashboard-event-log.png) + +--- + +## Event Log Features + +Upon opening the Event Log, you’ll see a list of recent events by default, displayed in pages with 10 entries per page. You can adjust the page size to view more events at a time. + +### Filtering Events + +At the top of the Event Log, three main filters help refine the log view: + +![Event Log Options](./assets/event-log-options.png) + +* **Level**: Filter events by severity level, including: + * **Trace** + * **Debug** + * **Information** + * **Warning** + * **Error** + * **Critical** + +* **Function**: Filter events by action type, which is color-coded for easier tracking: + * **Create** + * **Read** + * **Update** + * **Delete** + * **Security** + * **Other** + +* **Maximum Items**: Choose how many rows you would like displayed per page. + +For example, to view login attempts only, set **Function** to **Security**. For broader viewing, increase **Maximum Items** to display up to 100 events on a single page. + +### Event Log Pagination + +Use the paging feature at the bottom of the list to navigate between pages if there are more events than can fit in one view. + +### Viewing Event Details + +For a closer look at any event, click the **Details** button next to it. + +![Event Log Details Button](./assets/event-log-details-button.png) + +This opens a detailed view of the event, including where it occurred and a description of the action. + +![Event Log Details Window](./assets/event-log-details.png) + +To exit, click the **Cancel** button or the **X** in the top right corner. + +--- + +## Event Log Settings + +The Event Log has configurable settings to manage data retention. + +### Settings + +- **Retention (days)**: Specify how many days events should be stored. + +![Event Log Settings](./assets/event-log-settings.png) + +After configuring, click **Save** to apply your settings. + +### Clearing The Event Log + +To clear all events from the log: + +1. Click the **Clear Events** button in the settings. + + ![Clear Events Button](./assets/event-log-settings-clear-events-button.png) + +2. Confirm by selecting **Clear Events** in the confirmation window. + + ![Clear Events Confirmation Window](./assets/event-log-settings-clear-events-confirmation.png) + +--- + +## Summary + +The Event Log feature enables efficient monitoring of your site’s events. Utilize filters, pagination, and detail views to gain insights, troubleshoot issues, and keep your site secure. Configure settings as needed for optimal event data retention and manage the log by clearing old events when necessary. diff --git a/src/pages/manuals/admin/host-management/index.md b/src/pages/manuals/admin/host-management/index.md index d2ef8dc5..0adb9384 100644 --- a/src/pages/manuals/admin/host-management/index.md +++ b/src/pages/manuals/admin/host-management/index.md @@ -1,18 +1,68 @@ -# Host Management Introduction +# Host Management -The host user has the highest possible level of permissions in a Oqtane instance and can manage any individual site, set defaults for the creation of new sites, and manage additional configurations that support all sites. +## Introduction -An Oqtane site administrator is primarily concerned with the look, feel, functionality, and content of a site. A host is more concerned with the configuration, performance, monitoring, and support of the entire Oqtane instance. As the Oqtane host (or any user with superuser permissions), you need to have a working grasp of all the features and configuration options available to you. +The **Host Dashboard** in Oqtane provides hosts with an extensive set of tools to oversee, configure, and support the entire Oqtane instance. Host users possess the highest level of permissions, allowing them to manage global settings, monitor system performance, and maintain the instance across all sites. -A host logs into a Oqtane site just like any other user, just using the host account that is created when the Oqtane application is first launched. +Hosts log in just as other users do, using the designated host account created during the initial launch of Oqtane. However, hosts have access to exclusive features within the **Admin Dashboard** that provide additional control over Oqtane’s configuration and functionality. -In addition to the site options discussed in the site administration [control panel](../control-panel/index.md) and [admin dashboard](../admin-dashboard/index.md), the host account has more options than an administrator account in the admin dashboard, which includes: +## Control Panel **Admin Dashboard** Feature Walk-through -* Event Log: Which contain information on various events that have occurred on the site like errors or anything that has been created, updated, or deleted with more info on [event log](event-log.md). -* Site Management: Which allows for the addition and modification for all of the different sites you have with more info on [site management](site-management.md). -* Module Management: Which allows you to install new modules and edit existing modules with more info on [module management](module-management.md). -* Theme Management: Which allows you to install new themes to change the look of you webpages with more info on [theme management](theme-management.md). -* Scheduled Jobs: Which allows for the creation of jobs that will do something every time a specified amount of time passes with more info on [scheduled jobs](scheduled-jobs.md). -* SQL Management: Which lets you run SQL queries in your databases with more info on [sql management](sql-management.md). -* System Info: Which gives information on your version of the Oqtane framework and allows you to see information and methods in Oqtane's api with more info on [system info](system-info.md). -* System Update: Which allows you to keep the Oqtane framework up to date and allow you to use Nuget packages with more info on [system update](system-update.md). +The Control Panel offers streamlined access to host settings and features: + +1. **Open the Control Panel**: Click the **gear icon** in the top-right corner of the page. + + ![Control Panel Icon](./assets/control-panel-button.png) + +2. **Open Admin Dashboard**: Select the **Admin Dashboard** button to access host tools. + + ![Admin Dashboard Button](./assets/control-panel-admin-dashboard-button.png) + +3. **Navigate to Desired Feature**: Within the **Admin Dashboard**, you’ll find icons for each available feature. Click on the desired feature to begin management. + + ![Host Management](./assets/admin-dashboard.png) + +--- + +## Host-Exclusive **Admin Dashboard** Features + +The following tools are available only to host users and provide advanced control and oversight of the Oqtane instance. Each link below directs to detailed documentation for that feature. + +### Host Dashboard Features + +- **[Event Log](event-log.md)**: Review records of all events within the Oqtane instance, including errors, updates, and deletions, aiding in troubleshooting and system monitoring. +- **[Site Management](site-management.md)**: Create and manage multiple sites within the Oqtane instance, setting defaults for new site creation. +- **[Module Management](module-management.md)**: Install, edit, and manage modules across all sites, ensuring modular control of site functionality. +- **[Theme Management](theme-management.md)**: Install and manage themes to maintain a consistent visual style across sites. +- **[Scheduled Jobs](scheduled-jobs.md)**: Configure jobs to run at specified intervals, automating recurring tasks and maintenance actions. +- **[SQL Management](sql-management.md)**: Execute SQL queries directly in the Oqtane database for advanced data manipulation and reporting. +- **[System Info](system-info.md)**: Access detailed information on the Oqtane instance, including framework versions, environment details, and API methods. +- **[System Update](system-update.md)**: Update the Oqtane framework to the latest version, integrating new features and security patches from NuGet packages. + +--- + +## Extending Host Capabilities + +The Host Dashboard is customizable, allowing hosts to add new tools or features to support site-wide administration. To add custom pages for host use: + +1. **Access the Control Panel**: Log in as the host, click the **gear icon**, and navigate to **Page Management**. +2. **Create a New Host Page**: + - Click **Add** in the Page Management section. + - Set the **Parent Page** to **Admin** to make the new page accessible in the Host Dashboard. + - Configure other page settings, such as title and permissions, to tailor the page to host needs. + +3. **Save and Confirm**: Once saved, the new page will be available in the Host Dashboard. + +For more details on page configuration, see the [Content Management - Page Management](../content-management/page-management.md) documentation. + +--- + +## Additional Resources + +- **[Installation Guides](../../../guides/installation/index.md)**: Step-by-step instructions for initial Oqtane setup, including configuration specifics. +- **[Troubleshooting Issues](../../../guides/troubleshooting/index.md)**: Solutions for common issues encountered during setup and maintenance. + +For community discussions, support, and feature requests, visit: + +- **[GitHub Discussions](https://github.com/oqtane/oqtane.framework/discussions)** +- **[GitHub Issues](https://github.com/oqtane/oqtane.framework/issues)** diff --git a/src/pages/manuals/admin/host-management/language-management.md b/src/pages/manuals/admin/host-management/language-management.md new file mode 100644 index 00000000..5b6f7d37 --- /dev/null +++ b/src/pages/manuals/admin/host-management/language-management.md @@ -0,0 +1,71 @@ +# Language Management (Host Management) + +![Language Management Feature](./assets/language-management.png) + +This document describes the **Language Management** module, including settings and configurations, allowing administrators and host users to manage language resources effectively across their Oqtane site. + +## Overview + +The **Language Management** feature enables administrators to manage translations and make site content available in multiple languages, enhancing accessibility and user experience. + +--- + +## Control Panel Walkthrough + +### Accessing the Language Management Feature + +1. Click the **Control Panel** icon to access additional settings. + + ![Control Panel Icon](./assets/control-panel-button.png) + +2. In the control panel, select the button to open the **Admin Dashboard**. + + ![Open Admin Dashboard](./assets/control-panel-admin-dashboard-button.png) + +3. In the **Admin Dashboard**, click on the **Language Management** icon to configure language resources. + + ![Admin Dashboard Language Management](./assets/admin-dashboard-language-management.png) + +--- + +## Configuring Language Management + +For most **Language Management** features, refer to the [Admin Management Language Management](../admin-management/language-management.md) documentation. Here’s an overview of the key areas covered there: + +- **Main Index Page**: Lists all installed languages, allowing users to edit or delete (except for the default English language). +- **Adding a Language**: Provides a modal to add a new language by name and set it as the default. +- **Searching Languages**: Filters the list of installed languages for easy management. +- **Editing and Deleting Languages**: Enables users to modify or remove languages as needed. + +For further details on these features, see the [Admin Management Language Management](../admin-management/language-management.md) page. + +--- + +## Host-Specific Language Management Feature: Uploading Languages + +In addition to the standard features available to admins, Host users can upload new translation packages to the application, adding multiple languages efficiently. + +### Uploading a Language + +When you click the **Add Language** button, a new **Upload** tab is available specifically for Host users, providing a file upload feature. + +![Add Language Button](./assets/language-management-add-language-button.png) + +#### Upload Tab + +1. Navigate to the **Upload** tab to access the upload feature. + + ![Upload Button Options](./assets/language-management-upload-buttons.png) + +2. Use the **Upload** feature to add one or more translation packages. This allows you to quickly expand language options by uploading pre-configured translation files. + +3. If you decide not to proceed, select the **Cancel** button at the bottom left or the **X** icon at the top right of the window to exit the upload window without making changes. + + ![Upload Window](./assets/language-management-upload-window.png) + +--- + +## Conclusion + +The **Language Management** module in Oqtane offers an accessible interface for managing language resources and translations. Host users benefit from additional features, such as uploading translation packages, which allows for efficient multilingual site configurations. For a detailed breakdown of the **Admin Management** settings, visit the [Admin Management Language Management](../admin-management/language-management.md) documentation. + diff --git a/src/pages/manuals/admin/host-management/module-management.md b/src/pages/manuals/admin/host-management/module-management.md index 8997a501..7d227319 100644 --- a/src/pages/manuals/admin/host-management/module-management.md +++ b/src/pages/manuals/admin/host-management/module-management.md @@ -1,9 +1,161 @@ # Module Management -The module manager provides a list of all of the modules that are currently installed in your version of the Oqtane framework. Modules are a key feature of Oqtane and allow for a variety of features to be placed on your pages. +![Module Management](./assets/module-management.png) -At the top of the module manager page there is a install button to install a module from the list provided or by using the upload tab, you can use a Nuget package of a module, so that it will be included as one of the possible modules to use on the site. +## Overview -Inside the list of modules there is also the options to edit modules which will show an overview of the module with a description and an option to delete any module that is not a default Oqtane module. +The Module Management feature lists all the modules currently installed in your Oqtane framework. Modules provide essential functionality and allow various features to be added to your pages. -![module-management](./assets/module-management.png) +At the top of the Module Management page, there is an **Install** button that lets you add new modules. Modules can be installed either from a pre-configured list or by uploading a NuGet package, allowing it to be included among the available modules for your site. + +Within the list of modules, you’ll find options to **Edit** modules, which displays module details and provides options to delete non-default Oqtane modules. + +--- + +## Accessing the Module Management Feature + +1. **Open the Control Panel**: Click the **control panel icon** to access additional settings. + + ![Control Panel Icon](./assets/control-panel-button.png) + +2. **Open the Admin Dashboard**: In the control panel, select the **Admin Dashboard** button. + + ![Open Admin Dashboard](./assets/control-panel-admin-dashboard-button.png) + +3. **Select Module Management**: In the Admin Dashboard, click on the **Module Management** icon. + + ![Admin Dashboard Module Management](./assets/admin-dashboard-module-management.png) + +--- + +## Installing Modules + +### Using the Marketplace + +Click the **Install Module** button to open the module installation options. + +![Module Management Install Module Button](./assets/module-management-install-module-button.png) + +1. **Browse Marketplace**: Select the **Marketplace** tab to explore available modules, which may include both open-source and commercial options. + + ![Module Management Install Modules Marketplace](./assets/module-management-install-marketplace.png) + +2. **Choose Open Source or Commercial Modules**: The marketplace allows you to filter between **Open Source** and **Commercial** modules, streamlining your search. + + ![Module Management Install Marketplace Open Source or Commercial Modules](./assets/module-management-install-marketplace-open-source-commercial-options.png) + +3. **Search Feature**: Use the search box to quickly locate specific modules by name. + + ![Module Management Install Modules Marketplace Search Feature](./assets/module-management-install-search.png) + +4. **Sort Feature**: Sort available modules by various options to find exactly what you need. + + ![Module Management Install Modules Marketplace Sort Feature](./assets/module-management-install-sort-options.png) + +### Uploading a Module + +Alternatively, upload a module directly by using the **Upload** tab. This option allows you to add a NuGet package as a new module to your site. + +![Module Management Install Module Upload Button](./assets/module-management-install-upload.png) + +--- + +## Module Management Filter List + +You can filter the list of modules by category to simplify navigation. + +![Module Management Modules Category Filter](./assets/module-management-module-category.png) + +--- + +## Editing Modules + +To modify a module’s settings, click the **Edit** button next to the module you want to adjust. + +![Module Management Edit Button](./assets/module-management-edit-button.png) + +### Definition Tab + +The **Definition** tab shows the module’s core details, including its description and version information. + +![Module Management Edit Definition](./assets/module-management-edit-definition.png) + +### Permissions Tab + +The **Permissions** tab lets you configure user access for the module, including options to add users with specific permissions. + +- **Add User Permission**: Assign roles and permissions for accessing or managing the module. + + ![Module Management Edit Permissions Add User](./assets/module-management-edit-permissions-add-user.png) + +- **View/Edit Permissions**: Adjust existing permissions as needed for your module. + + ![Module Management Edit Permissions](./assets/module-management-edit-permissions.png) + +### Pages Tab + +Use the **Pages** tab to view and link to a specific page on your site with the module using the **Browse** button . + +![Module Management Edit Pages Browse Button](./assets/module-management-edit-pages-browse-button.png) + +### Translations Tab + +The **Translations** tab allows you to manage localization for the module, ensuring it’s accessible in multiple languages if necessary. + +![Module Management Edit Translations](./assets/module-management-edit-translations.png) + +--- + +## Creating a Module + +The **Create Module** button allows you to develop custom modules for your site, enhancing its functionality. + + ![Module Management Create Module Button](./assets/module-management-create-module-button.png) + +When creating a module, you will be prompted to configure several settings: + + ![Module Management Create Module Setting Description](./assets/module-management-create-module-settings-window.png) + +1. **Owner Name**: Enter the name of the organization creating the module (e.g., "YourCompanyName"). Avoid spaces, punctuation, and the term "oqtane." + + ![Module Management Create Module Setting Owner Name](./assets/module-management-create-module-settings-owner-name.png) + +2. **Module Name**: Specify a unique name for the module, following similar naming guidelines as for the owner name. + + ![Module Management Create Module Setting Module Name](./assets/module-management-create-module-settings-module-name.png) + +3. **Description**: Provide a brief description of the module's purpose and functionality. + + ![Module Management Create Module Setting Description](./assets/module-management-create-module-settings-description.png) + +4. **Template**: Select a module template from the list. Templates are stored in the server directory at `wwwroot/Modules/Templates`. + + ![Module Management Create Module Setting Template](./assets/module-management-create-module-settings-template.png) + +5. **Framework Reference**: Choose the desired framework reference version. The default is "Installed Version," but previous framework versions are also available. + + ![Module Management Create Module Setting Framework Reference](./assets/module-management-create-module-settings-framework-reference.png) + +After entering in the information Location text field shows up in the window displaying where the module will be created prior to clicking create module. + + ![Module Management Create Module Notification](./assets/module-management-create-module-settings-location.png) + +After completing the settings, finalize the module creation by clicking **Create Module**. To exit the window click the **Cancel** button or the **X** icon located on the top right of the window. + + ![Module Management Create Module Window Buttons](./assets/module-management-create-module-settings-window-buttons.png) + +Upon success, a notification confirms that the module was created and you will be asked to compile the module project and then restart to start working with your module in the application framework. + + ![Module Management Create Module Created Success Notification](./assets/module-management-create-module-created-success-notification.png) + +### **Warning**: Module Creation in Production Environments + +**Module creation** should be reserved for **development environments**. Avoid creating or developing modules directly in a **production environment** as it can impact performance, stability, and security. Developing and testing modules in a controlled setting first helps ensure they work as expected when deployed on a live site. + + ![Module Management Create Module Production Notification](./assets/module-management-production-notification.png) + +--- + +## Conclusion + +The **Module Management** feature provides a straightforward way to manage, install, and create modules to enhance your Oqtane site's functionality. Whether you're installing modules from the marketplace, uploading custom modules, or creating your own, this feature helps you add powerful tools and features to your site. Use the editing tools to fine-tune existing modules or start from scratch with a new module to meet your needs. diff --git a/src/pages/manuals/admin/host-management/scheduled-jobs.md b/src/pages/manuals/admin/host-management/scheduled-jobs.md index 8c3a2ee2..e0b1e2bc 100644 --- a/src/pages/manuals/admin/host-management/scheduled-jobs.md +++ b/src/pages/manuals/admin/host-management/scheduled-jobs.md @@ -1,22 +1,92 @@ # Scheduled Jobs -The Schedule page enables you to manage what is essentially recurring, scheduled batch processing for Oqtane.There are many instances where a host may want to set something up to automatically do some task like sending a notification to users and this can be accomplished with the use of this feature. The options that are available on this page are: - -* Add Job: Adds a new job by filling out the fields of: - * Name: Choose the jobs name. - * Type: Specify the type by either using NotificationJob or by creating your own job method in the infrastructure.jobs class in the Oqtane server. You will need to specify the location of the job in the framework, Ex. (Oqtane.Infrastructure.NotificationJob, Oqtane.Server) with the job being a notification job from the infrastructure class, which is a class inside of the Oqtane.Server. - * Enabled: A yes or no to say if you want the job to be active at this time or not. - * Runs Every: Choose an amount of time that specifies how often the job will execute. - * Starting: Enter a date for when you want the job to start. - * Ending: Enter a date for when you want the job to end. - * Retention Log: A number to specify the amount of logs that will be retained. - ![edit-jobs](./assets/edit-jobs.png) -* View Logs: Shows all of the logs generated by all of your jobs within their retention log number. -* Refresh: This refreshes the page to get new logs that have been made while you have been on this page. - -Below this these options is a list of all of the jobs that are currently set up to be executed, that have a few options: -* Edit: Has all of the same fields as adding a job plus a field for the next execution: - * Next execution: Input a date that will be the next time the job will run after the stop button has been pushed. -* Delete: Deletes the job so that it will never execute again. -* Log: View the logs that this jobs has generated. -* Stop: Stops the job from executing anymore, until a next execution has been specified in the edit window. +![Scheduled Jobs](./assets/scheduled-jobs.png) + +## Overview + +The **Scheduled Jobs** feature in Oqtane allows you to manage recurring, scheduled tasks that are automatically executed at specified intervals. This is useful for automating tasks such as sending notifications to users or any other batch processing task that should occur on a schedule. + +--- + +## Accessing the Scheduled Jobs Feature + +1. **Open the Control Panel**: Click the **control panel icon** to access additional settings. + + ![Control Panel Icon](./assets/control-panel-button.png) + +2. **Open the Admin Dashboard**: In the control panel, select the **Admin Dashboard** button. + + ![Open Admin Dashboard](./assets/control-panel-admin-dashboard-button.png) + +3. **Select Scheduled Jobs**: In the Admin Dashboard, click on the **Scheduled Jobs** icon to access the configuration settings. + + ![Admin Dashboard Scheduled Jobs](./assets/admin-dashboard-scheduled-jobs.png) + +--- + +## Scheduled Jobs Options + +On the Scheduled Jobs page, you have the option to configure and manage jobs with the following fields: + +### Add Job + +1. **Name**: Enter a name for the scheduled job. +2. **Type**: Select the type of the job. You can use the pre-configured `NotificationJob` or create a custom job by specifying the location of your job method, for example, `Oqtane.Infrastructure.NotificationJob, Oqtane.Server` for a notification job. +3. **Enabled**: Set this to **Yes** to activate the job or **No** to deactivate it. +4. **Runs Every**: Choose how often the job should run (e.g., daily, weekly, etc.). +5. **Starting**: Enter the date and time when the job should begin executing. +6. **Ending**: Enter the date and time when the job should stop executing. +7. **Retention Log**: Specify the number of logs to retain for the job. Older logs will be discarded once the retention limit is reached. + +--- + +## View Logs + +You can view the logs of all scheduled jobs. + +1. **View Logs**: Click on **View Logs** to see the logs generated by your jobs. The logs are retained according to the specified retention number. + + ![Scheduled Jobs View All Logs Button](./assets/scheduled-jobs-view-all-logs-button.png) + + ![Scheduled Jobs View All Logs](./assets/scheduled-jobs-view-all-logs.png) + +### Refresh + +To refresh the page and get the latest logs: + +1. **Refresh**: Click the **Refresh** button to reload the page and display any new logs that have been generated. + + ![Scheduled Jobs Refresh Button](./assets/scheduled-jobs-refresh-button.png) + +--- + +## Options for Existing Jobs + +The scheduled jobs are listed below, with options to manage them: + +1. **Edit**: Modify job settings, including the next execution date. + - The fields available when editing are the same as those when adding a new job, but with an additional field for **Next Execution**. + - **Next Execution**: Specify the date and time for the next job run after stopping the job. + +2. **Delete**: Remove the job, preventing it from executing again. + +3. **Log**: View the logs generated by a specific job. + +4. **Stop**: Temporarily stop a job. It will not run again until the **Next Execution** date is specified in the **Edit** window. + +--- + +## Search Jobs + +You can search for a specific job by name using the search feature. + +![Scheduled Jobs Search](./assets/scheduled-jobs-search.png) + +--- + +## Restart After Installation to Activate + +After installing or modifying jobs, a notification may appear prompting you to restart the application to activate changes. + +![Scheduled Jobs Restart Notification Message](./assets/scheduled-jobs-restart.png) + diff --git a/src/pages/manuals/admin/host-management/site-management.md b/src/pages/manuals/admin/host-management/site-management.md index b5236bdd..98d2a26a 100644 --- a/src/pages/manuals/admin/host-management/site-management.md +++ b/src/pages/manuals/admin/host-management/site-management.md @@ -1,22 +1,105 @@ # Site Management -Oqtane provides the ability to have multiple sites at you disposal within the singular Oqtane application. The Site Management page provides an inventory of all the sites in a Oqtane instance and quick access to the Site Settings functionality for each. Deleting your sites is permanent\! So it should not be done unless you are certain you want to delete this site. The options to add and edit the set has a few options: - -![site-management](./assets/site-management.png) - -* Site Name: This field is what the site will be called. -* Aliases: This is what the address of the site is that is being created and can create websites under the default top level website, by using a / forward slash with the a name you want under the top level website. -* Default Theme: Choose the theme, which is the colors and styles that will be the default for pages created on this website. -* Default Layout: Choose how many content panes you want to have on a page by default. -* Default Container: Choose if you want a title header for your modules on the site by default. -* Site Template: Select if you want a template for your site or no template for your site. -* Tenant: Select the tenant for the site, which is the database that will be used for the site. - * If you want to create a new tenant or database then you will have to select the "create a new tenant" option which will drop down with another menu that allows for a new tenant to be created, this menu includes: - * Name: This is the name for the new tenant on the site, that you will be creating and what will be displayed when selecting tenants in the future. - * Database Type: Choose if you would like the database to have a local database, which will create a Microsoft SQL database on your local database on your system, and an SQL server which creates a that is linked to an SQL server. - * Server: This is the location of where the server where the database will be located and a default value is provided for a local database. - * Database: This is the name that is initialized for the database inside of the server and a default value is provided for a local database. - * Integrated Security: Choose if you want the host superuser for the site to have the same credentials (username and password) as the database's root account. - * Host Username: This is the username of the super user host account that will be created for the site, it will also be the database's root username if integrated security is set as true. - * Hosts Password: This is the super user host account's password, it will also be the database's root account password if integrated security is set as true. - +![Site Management](./assets/site-management.png) + +## Overview + +Oqtane allows you to manage multiple sites within a single instance of the application. The **Site Management** page provides an overview of all sites, with quick access to the site settings for each one. Be cautious when deleting a site, as it is a permanent action and cannot be undone unless you are absolutely certain. + +--- + +## Accessing the Site Management Feature + +1. **Open the Control Panel**: Click the **control panel icon** to access additional settings. + + ![Control Panel Icon](./assets/control-panel-button.png) + +2. **Open the Admin Dashboard**: In the control panel, click the **Admin Dashboard** button. + + ![Open Admin Dashboard](./assets/control-panel-admin-dashboard-button.png) + +3. **Select Site Management**: In the Admin Dashboard, click the **Site Management** icon to open the site configuration options. + + ![Admin Dashboard Site Management](./assets/admin-dashboard-site-management.png) + +--- + +## Site Management Options + +The **Site Management** page includes options to add and edit sites. The available settings are as follows: + +### Site Details + +1. **Site Name**: Enter the name for your site. +2. **Aliases**: Define the address of the site. You can create sub-websites under the main site by using a forward slash ("/") followed by the desired name (e.g., `/subsite`). +3. **Default Theme**: Choose the theme that will be applied to pages on this site, determining the color scheme and style. +4. **Default Layout**: Select the default layout, which defines how many content panes (columns) will be available on each page. +5. **Default Container**: Choose whether to include a title header for modules on the site. +6. **Site Template**: Select a template to use for the site, or choose to have no template. +7. **Tenant**: Choose the tenant (database) for the site. + - If you need to create a new tenant, select **Create a new tenant**. This will open additional options: + - **Name**: Enter the name for the new tenant. + - **Database Type**: Choose between a local database or an SQL Server database. + - **Server**: Specify the location of the server where the database will be stored (default is the local database). + - **Database**: Enter the database name to initialize on the server (default value for local database). + - **Integrated Security**: Choose whether the host superuser credentials should match the database's root account. + - **Host Username**: Enter the username for the superuser host account. This will also be the database root username if integrated security is enabled. + - **Host Password**: Set the password for the superuser host account. This will also be the database root password if integrated security is enabled. + +--- + +## Add Site + +To add a new site: + +1. Click on the **Add Site** button. + + ![Site Management Add Site Button](./assets/site-management-add-site-button.png) + +2. Fill out the site details in the form that appears. + + ![Site Management Add Site](./assets/site-management-add-site.png) + +--- + +## Search Feature + +You can search for a specific site by name using the search bar. + +![Site Management Search](./assets/site-management-search.png) + +--- + +## Edit Site + +To modify the details of an existing site, click the **Edit** button. + +![Site Management Edit Site](./assets/site-management-edit-button.png) + +--- + +## Browse Site + +Click the **Browse** button to view the site. + +![Site Management Browse Button](./assets/site-management-browse-button.png) + +--- +## Deleting a Site + +Be very careful when deleting a site, as this action is permanent and cannot be undone. Once a site is deleted, all data associated with it, including pages, content, and settings, will be permanently removed. + +To delete a site, follow these steps: + +1. **Access Site Settings**: Navigate to the **Site Management** page from the Admin Dashboard by clicking the **Edit** button next to the site you wish to delete. + + ![Edit Site Button](./assets/site-management-edit-button.png) + +2. **Delete the Site**: In the **Site Settings** page, scroll down to the bottom and find the **Delete** option. Confirm your decision to delete the site when prompted. + +> **Warning**: Deleting a site is irreversible. Ensure that you have backed up any important data before proceeding. + +Once the site is deleted, the action cannot be undone. The site and all of its content will be permanently erased from the system. + + +--- diff --git a/src/pages/manuals/admin/host-management/site-settings.md b/src/pages/manuals/admin/host-management/site-settings.md new file mode 100644 index 00000000..608170f6 --- /dev/null +++ b/src/pages/manuals/admin/host-management/site-settings.md @@ -0,0 +1,130 @@ +# Site Settings (Host Management) + +![site-settings](./assets/site-settings.png) + +## Overview + +The **Site Settings** feature in Oqtane allows both Admin and Host users to configure site-specific options. While Admin users have access to a standard set of settings, Host users are provided with additional, advanced configuration options. This guide will summarize both types of settings and provide links to further details. + +To access **Site Settings** in the Oqtane admin dashboard: + +1. **Open the Control Panel**: Click the **Control Panel** icon to access additional settings. + + ![Control Panel Icon](./assets/control-panel-button.png) + +2. **Navigate to the Admin Dashboard**: In the control panel, click the button to open the **Admin Dashboard**. + + ![Open Admin Dashboard](./assets/control-panel-admin-dashboard-button.png) + +3. **Select Site Settings**: In the Admin Dashboard, click on the **Site Settings** icon to configure your site settings. + + ![Admin Dashboard Site Settings](./assets/admin-dashboard-site-settings.png) + +--- + +## Admin Management Site Settings + +For the **Admin Management** features in **Site Settings**, see the following sections in the [Admin Management Site Settings](../admin-management/site-settings.md) documentation: + +- **General Settings**: [General Settings Section](../admin-management/site-settings.md#general-settings) + - Configure the basic site settings such as site name, description, and default language. + +- **Security Settings**: [Security Settings Section](../admin-management/site-settings.md#security-settings) + - Adjust site security settings, including registration, password policies, and allowed roles. + +- **Performance Settings**: [Performance Settings Section](../admin-management/site-settings.md#performance-settings) + - Control caching, logging, and other performance-related settings. + +- **Localization Settings**: [Localization Settings Section](../admin-management/site-settings.md#localization-settings) + - Manage language preferences and regional settings. + +Each of these links provides in-depth details on configuring the corresponding settings. + +--- + +## Host-Specific Site Settings + +As a Host user, you have access to additional settings that allow for more advanced site configuration. Below is an overview of these exclusive options. + +### URLs + +The **URLs** section lets you manage the URLs associated with your site, including domains, subdomains, or virtual folders. + +![Site URLs](./assets/site-settings-site-urls.png) + +- **Add a URL**: + - Click the **Add** button. + + ![Edit Edit Button](./assets/site-settings-site-urls-add-button.png) + + - Enter the **URL** in the provided field. + - Choose **Yes** or **No** for **Default** to set it as the primary URL. + - Click **Save** to add the URL or **Cancel** to discard changes. + + ![Add URL Window](./assets/site-settings-site-urls-add-window.png) + +- **Edit a URL**: + - Click the **Edit** button next to an existing URL. + + ![Edit Edit Button](./assets/site-settings-site-urls-edit-button.png) + + - Modify the URL or adjust the **Default** setting. + - Click **Save** to save changes or **Cancel** to discard them. + + ![Edit URL Window](./assets/site-settings-site-urls-edit-window.png) + +- **Delete a URL**: + - Click the **Delete** button next to a URL. + + ![Edit Delete Button](./assets/site-settings-site-urls-delete-button.png) + + - Confirm deletion in the prompt window. + + ![Delete URL Confirmation](./assets/site-settings-site-urls-delete-confirmation-window.png) + +--- + +### UI Component Settings + +The **UI Component Settings** section allows you to control render modes and interactivity options for UI components. + +![UI Component Settings](./assets/site-settings-ui-components-settings.png) + +- **Render Mode**: The default render mode for the site, defining how components are rendered on the page. + + ![Render Mode](./assets/site-settings-ui-components-settings-render-mode.png) + +- **Interactivity**: Specifies the render mode for components requiring interactive features. + + ![Interactivity](./assets/site-settings-ui-components-settings-interactivity.png) + +- **Prerender**: Indicates if interactive components should prerender their output on the server. + + ![Prerender](./assets/site-settings-ui-components-settings-prerender.png) + +- **Hybrid**: Determines if the site can integrate with an external .NET MAUI hybrid application. + + ![Hybrid](./assets/site-settings-ui-components-settings-hybrid.png) + +--- + +### Database + +The **Database** section provides essential database information for the site. + +![Database Settings](./assets/site-settings-database.png) + +- **Database**: The name of the database used within the site. This is the tenant name in the framework rather than the physical database name. + +- **Type**: Specifies the type of database (e.g., SQL Server, MySQL). + +- **Connection**: The name of the connection string from `appsettings.json` used to connect to the database. + +--- + +## Conclusion + +The **Site Settings** for Host users offer advanced options for managing URLs, UI components, and database configurations, in addition to the standard settings accessible to Admin users. Use these settings to customize your site further and optimize performance, security, and interactivity. + +For more detailed information on Admin features, refer to the [Admin Management Site Settings documentation](../admin-management/site-settings.md). + diff --git a/src/pages/manuals/admin/host-management/sql-management.md b/src/pages/manuals/admin/host-management/sql-management.md index 1ff9c530..a009f045 100644 --- a/src/pages/manuals/admin/host-management/sql-management.md +++ b/src/pages/manuals/admin/host-management/sql-management.md @@ -1,5 +1,136 @@ # SQL Management -The SQL console permits database access directly from inside Oqtane. So the host, even if it's not near an instance of SQL Server Management Studio, still has access to a powerful database tool. This allows for SQL statements to be run directly from the Oqtane application onto the tenants which are also called databases. The results of any SQL query that is run will be returned directly below the execute button. +![SQL Management](./assets/sql-management.png) -![sql-management](./assets/sql-management.png) +## Overview + +The SQL Management feature provides direct access to the database through the Oqtane interface, allowing administrators to execute SQL queries on the tenant databases (also called sites). This feature enables quick database management and troubleshooting without requiring a separate SQL Server Management Studio instance. + +By using the SQL console, you can run SQL queries directly from the Oqtane application. The results of any executed SQL statements will be displayed below the execute button, providing immediate feedback. This feature is particularly useful for administrators who need to interact with the database quickly. + +### Accessing the SQL Management Feature + +1. **Open the Control Panel**: Click the **Control Panel** icon to access additional settings. + + ![Control Panel Icon](./assets/control-panel-button.png) + +2. **Navigate to Admin Dashboard**: In the Control Panel, select the button to open the **Admin Dashboard**. + + ![Open Admin Dashboard](./assets/control-panel-admin-dashboard-button.png) + +3. **Open SQL Management**: In the Admin Dashboard, click on the **SQL Management** icon to access the SQL console. + + ![Admin Dashboard SQL Management](./assets/admin-dashboard-sql-management.png) + +--- + +## Adding a Connection + +To add a new database connection: + +1. Click the **Add Connection** button in the SQL Management interface. + + ![Add Connection Button](./assets/sql-management-add-connection-button.png) + +2. The **Add Connection Settings** window will appear, where you can configure the connection settings such as the server name, credentials, and database name. + + ![Add Connection Window](./assets/sql-management-add-connection.png) + +--- + +## Default Connection + +Once you've set up your connection, the default connection will be displayed for easy reference. + + ![Default Connection](./assets/sql-management-default-connection.png) + +--- + +## Executing Queries + +After setting up the connection, you can begin writing your SQL queries. To execute a query, click the **Execute** button. + + ![Execute Button](./assets/sql-management-execute-button.png) + +--- + +## Using the SQL Management Console + +Once inside the SQL Management page, you can interact with the SQL console to execute queries on the tenant databases. + +### SQL Console Interface + +- **Query Input Field**: This is where you type your SQL query. +- **Execute Button**: After entering your SQL statement, click the **Execute** button to run the query on the selected tenant database. +- **Results Display**: The results of the executed query will be displayed directly below the **Execute** button, showing either the returned data or any error messages. + +### SQL Query Example + +```sql +SELECT * FROM Users WHERE IsActive = 1; +``` + +This example SQL query will return all active users from the Users table. + +### Error Handling + +If there is an issue with your SQL query, an error message will be shown in the results section, providing helpful feedback to correct the query. Common issues could include: + +- **Syntax errors**: Ensure your SQL syntax is correct. +- **Incorrect table or column names**: Double-check your database schema to ensure the table and column names match. +- **Access permissions issues**: Verify that your user account has sufficient privileges to execute SQL queries on the selected tenant database. + +> **Warning**: Running SQL queries directly on the database can modify data and schema. It is advised to back up your database before making significant changes. + +### Best Practices + +- **Avoid Deleting Data**: Be cautious when running `DELETE` statements or performing operations that alter the database schema. Always double-check the `WHERE` clause before executing a `DELETE` query. +- **Test Queries**: Test queries in a development or staging environment before running them on a production database to prevent unintended consequences. +- **Backup**: Always ensure that you have a recent backup of your database before executing potentially destructive queries, such as `DELETE` or `UPDATE` operations that affect large sets of data. + +### Common SQL Queries + +#### Retrieving All Records + +```sql +SELECT * FROM [TableName]; +``` + +### Retrieving All Records + +```sql +SELECT * FROM [TableName]; +``` + +This query retrieves all records from the specified table. It is useful for getting an overview of the data in any table. + +### Updating Records + +```sql +UPDATE [TableName] +SET [ColumnName] = 'NewValue' +WHERE [Condition]; +``` + +This query updates existing records in the specified table based on the given condition. Use this to modify data for specific records in a table. + +### Deleting Records + +```sql +DELETE FROM [TableName] +WHERE [Condition]; +``` + +### Deleting Records + +Be cautious when using the `DELETE` statement, as it permanently removes records from the database. Make sure your `WHERE` clause is accurate before executing the query. + +### Troubleshooting + +- **Query Doesn't Execute**: If your query doesn't run, verify that the syntax is correct. Ensure that you are connected to the right tenant database. +- **No Results Displayed**: If your query returns no data, check the conditions in your SQL query, or verify that the data exists in the database. Ensure the table and columns are properly named and populated. +- **Permissions Issues**: If you encounter permission-related errors, verify that your user account has the appropriate access rights for executing SQL queries. + +### Conclusion + +The SQL Management console is a powerful tool for managing your tenant databases directly from within Oqtane. While it simplifies database interactions for administrators, it should be used with caution, especially when modifying or deleting data. Always double-check your queries and test them in a safe environment to avoid unintentional changes to your databases. diff --git a/src/pages/manuals/admin/host-management/system-info.md b/src/pages/manuals/admin/host-management/system-info.md index 73e2a60a..dbde2a59 100644 --- a/src/pages/manuals/admin/host-management/system-info.md +++ b/src/pages/manuals/admin/host-management/system-info.md @@ -1,6 +1,83 @@ -# System Info +# System Update -All of the general information that you need to know about the Oqtane framework is available in the system information feature, which includes things like the Oqtane framework version, the blazor runtime, the server path, the CLR version, the OS version, and the server's current time. +![System Update](./assets/system-update.png) -The System Info feature also provides access to Oqtane's API with many of Oqtane's methods and the ability to try them out using the Swagger user interface. -There is also the option to restart the Oqtane framework on this page if you have made a change to the system that would require a restart such as installing or deleting themes or modules. +## Overview + +The **System Update** feature in Oqtane allows administrators to keep the framework up to date, ensuring access to the latest capabilities and features. It also enables you to upload a NuGet package to include specific features or updates that are part of newer versions of Oqtane. This is particularly useful when you are unable to update to the latest Oqtane version but want to incorporate certain features or fixes from that newer release. + +When updating, you can select a NuGet file from your local system, upload it to the framework, and then install it to integrate the package into your current Oqtane installation. This process is helpful for applying partial updates or integrating features without a full framework update. + +--- + +## Accessing the System Update Feature + +To access the **System Update** feature, follow these steps: + +1. **Open the Control Panel**: Click the **Control Panel** icon to access additional settings. + + ![Control Panel Icon](./assets/control-panel-button.png) + +2. **Navigate to Admin Dashboard**: In the Control Panel, click the button to open the **Admin Dashboard**. + + ![Open Admin Dashboard](./assets/control-panel-admin-dashboard-button.png) + +3. **Select System Update**: In the Admin Dashboard, click on the **System Update** icon to access the update feature. + + ![Admin Dashboard System Update](./assets/admin-dashboard-system-update.png) + +--- + +## Downloading An Update + +To download and apply an update, follow these steps: + +1. Click the **Download** button to initiate the update download. + +2. After the download completes successfully, you will see a notification. At this point, click the **Upgrade** button to apply the update. + + > **Note**: Ensure that you are connected to the internet during this process to download the latest update package. + +### System Up To Date Notification + +If the Oqtane framework is already up to date, you will see the following notification: + +![System Update Up To Date Notification](./assets/system-update-system-up-to-date-notification.png) + +This indicates that no update is required and you are already using the latest version of the framework. + +--- + +## Uploading An Update + +In some cases, you may want to upload a NuGet package that includes new features or fixes from a newer version of Oqtane. To upload an update, follow these steps: + +1. Click the **Upload** button to browse and select the NuGet package file on your local system. + + ![System Update Upload](./assets/system-update-upload.png) + +2. After selecting the file, click the **Upgrade** button to install the uploaded package into your current version of Oqtane. + + ![System Update Upgrade Button](./assets/system-update-upload-upgrade-button.png) + + > **Tip**: This step is useful if you cannot upgrade to the latest version of Oqtane but still need to integrate newer features or updates provided in a NuGet package. + +--- + +## Development Environment Notification + +The **System Update** feature is only available in production environments. If you are working in a development environment, you will see a notification message indicating that updates cannot be performed. + +This is a safeguard to prevent accidental updates in environments where it may not be appropriate. The message will appear as shown in the image below: + +![System Update Development Environment](./assets/system-update-development-environment.png) + +> **Note**: If you need to perform updates in a development environment, consider switching to a production environment or testing updates locally before applying them to the live system. + +--- + +## Conclusion + +The **System Update** feature in Oqtane ensures that your system is running the latest framework version, incorporating important features, bug fixes, and updates. You can either download updates directly from the Oqtane servers or upload NuGet packages to install specific updates. Always verify your environment type (production vs development) and follow the steps carefully to maintain system integrity. + +If you encounter any issues or have questions about updating, consult the logs or seek assistance from the community or support channels. diff --git a/src/pages/manuals/admin/host-management/theme-management.md b/src/pages/manuals/admin/host-management/theme-management.md index 9baf3f0b..205b635c 100644 --- a/src/pages/manuals/admin/host-management/theme-management.md +++ b/src/pages/manuals/admin/host-management/theme-management.md @@ -1,9 +1,121 @@ # Theme Management -The theme page is not used that often. Generally, it's used during the development of a new site and sometimes is used during the rollout of a new site brand. It allows you to view the available themes and containers that have been installed in your site and then applied as the default for new and existing pages and modules. +![theme-management](./assets/theme-management.png) -Themes on Oqtane provide a multitude of different colors and styles for pages to be presented in. These themes can provide unique looking pages and websites as a whole. There are two default themes for Oqtane, the Blazor theme and the Oqtane theme. +## Overview -You can also download new themes to use by clicking the install theme button at the top of the page and choosing some themes to download, so you change the look of your site. There is also an upload tab which allows you to put Nuget files for themes that are not available in the download menu onto your Oqtane framework. +The **Theme Management** feature in Oqtane is primarily used during the development phase of a site or when launching a new site brand. It allows you to manage the themes and containers installed on your site and set the default theme for pages and modules. Themes define the overall look and feel of your site, including colors, styles, and layouts. -![theme-management](./assets/theme-management.png) +Oqtane provides two default themes: +- **Blazor Theme**: A minimalistic theme ideal for simple pages. +- **Oqtane Theme**: A more advanced theme offering a variety of styling options. + +Additionally, you can download new themes from the marketplace or upload custom themes via NuGet packages. + +--- + +## Accessing the Theme Management Feature + +To access **Theme Management** in the Oqtane admin dashboard, follow these steps: + +1. **Open the Control Panel**: Click the **Control Panel** icon to access additional settings. + + ![Control Panel Icon](./assets/control-panel-button.png) + +2. **Navigate to Admin Dashboard**: In the control panel, click the button to open the **Admin Dashboard**. + + ![Open Admin Dashboard](./assets/control-panel-admin-dashboard-button.png) + +3. **Select Theme Management**: In the Admin Dashboard, click on the **Theme Management** icon to manage your themes. + + ![Admin Dashboard Theme Management](./assets/admin-dashboard-theme-management.png) + +--- + +## Installing Themes + +To install a new theme: + +1. Click the **Install Theme** button. + + ![Theme Management Install Theme Button](./assets/theme-management-install-theme-button.png) + +2. You can install themes from two tabs: + - **Marketplace**: Choose between **Open Source** or **Commercial** themes available for download. + + ![Theme Management Install Theme Marketplace Tab](./assets/theme-management-install-theme-marketplace.png) + + - **Upload**: If you have a custom theme as a NuGet package, you can upload it here. + 1. Click the **Choose Files** button to select the theme file to upload. + 2. Click the **Upload** button to install the theme. + + ![Theme Management Install Theme Upload Tab](./assets/theme-management-install-theme-upload.png) + +--- + +## Editing Themes + +You can edit existing themes to customize their properties. + +1. Click the **Edit** button next to the theme you want to modify. + + ![Theme Management Edit Button](./assets/theme-management-edit-button.png) + +2. In the edit window, you can change the theme settings, such as color schemes, fonts, and other design elements. + + ![Theme Management Edit Window](./assets/theme-management-edit.png) + +--- + +## Creating Themes + +If you want to create a completely new theme, Oqtane allows you to do so from the **Create Theme** option. + +1. Click the **Create Theme** button to begin. + + ![Theme Management Create Theme Button](./assets/theme-management-create-theme-button.png) + +2. In the create theme window, provide the following details: + + - **Owner Name**: Enter the owner or creator of the theme. + + ![Owner Name Setting](./assets/theme-management-create-theme-settings-owner-name.png) + + - **Theme Name**: Give your theme a name. + + ![Theme Name Setting](./assets/theme-management-create-theme-settings-theme-name.png) + + - **Template**: Select a theme template. Templates are located in the `wwwroot/Themes/Templates` folder on the server. + + ![Template Setting](./assets/theme-management-create-theme-settings-template.png) + + - **Framework Reference**: Choose a framework version to ensure compatibility with your environment. + + ![Framework Reference Setting](./assets/theme-management-create-theme-settings-framework-reference.png) + + - After setting the above settings **Location** will appear showing the location of where the theme files will be created. + + ![Framework Reference Setting](./assets/theme-management-create-theme-settings-location.png) + +3. Once all settings are configured, click the **Create Theme** button to save the new theme. To exit without creating a theme click the **Cancel** button next to the **Create Theme** button or by clicking the **X** in the top right corner. + + ![Theme Management Create Theme Settings Create Theme Button](./assets/theme-management-create-theme-settings-create-theme-button.png) + +4. After successfully creating the theme, you will see a notification confirming the creation and instructing you to compile the new theme project and restart the application. + + ![Theme Management Create Theme Success Notification](./assets/theme-management-create-theme-created-succes-notification.png) + + +### **Warning**: Theme Creation in Production Environments + +**Theme creation** is recommended for **development environments** only. It is not advisable to develop or create themes directly in a **production environment** as it can lead to performance issues, security concerns, or disruptions to the live user experience. For production sites, it is best to pre-build and test themes in a controlled environment before deploying them to your live site. + + ![Theme Management Create Theme Production Notification](./assets/theme-management-create-theme-production-notification.png) + +--- + +## Conclusion + +The **Theme Management** feature provides a straightforward way to manage, install, and create themes for your Oqtane site. Whether you're installing themes from the marketplace, uploading custom themes, or creating your own, this feature allows you to customize the look and feel of your site easily. Use the editing tools to fine-tune existing themes or start from scratch with a new theme to match your site's branding. + +If you encounter any issues during theme installation or customization, refer to the logs or consult the support channels for assistance. diff --git a/src/pages/manuals/admin/host-management/toc.yml b/src/pages/manuals/admin/host-management/toc.yml index 4044ab45..99e94344 100644 --- a/src/pages/manuals/admin/host-management/toc.yml +++ b/src/pages/manuals/admin/host-management/toc.yml @@ -1,6 +1,9 @@ - name: Introduction href: index.md +- name: Site Settings + href: site-settings.md + - name: Event Log href: event-log.md @@ -24,3 +27,6 @@ - name: Theme Management href: theme-management.md + +- name: Langauge Management + href: language-management.md diff --git a/src/pages/manuals/admin/installation/index.md b/src/pages/manuals/admin/installation/index.md index 2e341a7d..bcd91d73 100644 --- a/src/pages/manuals/admin/installation/index.md +++ b/src/pages/manuals/admin/installation/index.md @@ -27,7 +27,7 @@ For different deployment environments, such as production or development, consul > **Note**: Oqtane is optimized for Windows Server with IIS but also supports deployment on Linux (e.g., with NGINX or Apache). -- [Installation Manuals](../../../manuals/installation/index.md): Detailed setup instructions for deploying Oqtane in different environments. +- [Installation Guides](../../../guides/installation/index.md): Detailed setup instructions for deploying Oqtane in different environments. markdown @@ -41,4 +41,4 @@ For further insights on Oqtane installation and configuration, consider explorin ## See Also -For more comprehensive setup guidance, see the [Installation Manuals](../../../manuals/installation/index.md). +For more comprehensive setup guidance, see the [Installation Guides(../../../guides/installation/index.md). diff --git a/src/pages/manuals/admin/installation/installation-wizard.md b/src/pages/manuals/admin/installation/installation-wizard.md index f50c4485..86e4fe2b 100644 --- a/src/pages/manuals/admin/installation/installation-wizard.md +++ b/src/pages/manuals/admin/installation/installation-wizard.md @@ -32,7 +32,7 @@ The Oqtane Installation Wizard simplifies the setup process, guiding you through > **Note:** The current web address used to access the install wizard will be set as the default base URL or alias for your Oqtane site. - ![Site Settings Screen](./assets/installation-wizard-application-configuration.png) + ![Site Settings Screen](./assets/installation-wizard-application-administration.png) 4. **Complete Installation**: - Review your configuration and click **Install**. The wizard will apply your settings, configure the database, and prepare your Oqtane instance for use. (Optionally, you can select a checkbox to receive product updates and security bulletins.)