diff --git a/.vscode/extensions.json b/.vscode/extensions.json deleted file mode 100644 index 77b374577..000000000 --- a/.vscode/extensions.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - // For more information, visit: https://go.microsoft.com/fwlink/?linkid=827846 - "recommendations": ["angular.ng-template"] -} diff --git a/.vscode/launch.json b/.vscode/launch.json deleted file mode 100644 index 740e35a0c..000000000 --- a/.vscode/launch.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 - "version": "0.2.0", - "configurations": [ - { - "name": "ng serve", - "type": "pwa-chrome", - "request": "launch", - "preLaunchTask": "npm: start", - "url": "http://localhost:4200/" - }, - { - "name": "ng test", - "type": "chrome", - "request": "launch", - "preLaunchTask": "npm: test", - "url": "http://localhost:9876/debug.html" - } - ] -} diff --git a/.vscode/tasks.json b/.vscode/tasks.json deleted file mode 100644 index a298b5bd8..000000000 --- a/.vscode/tasks.json +++ /dev/null @@ -1,42 +0,0 @@ -{ - // For more information, visit: https://go.microsoft.com/fwlink/?LinkId=733558 - "version": "2.0.0", - "tasks": [ - { - "type": "npm", - "script": "start", - "isBackground": true, - "problemMatcher": { - "owner": "typescript", - "pattern": "$tsc", - "background": { - "activeOnStart": true, - "beginsPattern": { - "regexp": "(.*?)" - }, - "endsPattern": { - "regexp": "bundle generation complete" - } - } - } - }, - { - "type": "npm", - "script": "test", - "isBackground": true, - "problemMatcher": { - "owner": "typescript", - "pattern": "$tsc", - "background": { - "activeOnStart": true, - "beginsPattern": { - "regexp": "(.*?)" - }, - "endsPattern": { - "regexp": "bundle generation complete" - } - } - } - } - ] -} diff --git a/account-settings/billing/data-deletion.mdx b/account-settings/billing/data-deletion.mdx index b3461e570..f485ff4a5 100644 --- a/account-settings/billing/data-deletion.mdx +++ b/account-settings/billing/data-deletion.mdx @@ -12,14 +12,14 @@ Products can be suspended in three cases: ## When are services and data deleted after suspension? -After a service is suspended, we don't immediately delete it and its associated [customer data](/account-settings/billing/data-deletion#what-data-will-be-deleted). The period between suspension and deletion depends on the product. +After a service is suspended, we don't immediately delete it and its associated [customer data](/account-settings/billing/data-deletion#what-data-will-be-deleted). The period between suspension and deletion depends on the product. -After the product is suspended, some time passes before it will be deleted with all [customer data](/account-settings/billing/data-deletion#what-data-will-be-deleted). The period between suspension and deletion depends on the product. +After the product is suspended, some time passes before it will be deleted with all [customer data](/account-settings/billing/data-deletion#what-data-will-be-deleted). The period between suspension and deletion depends on the product. **Warning** -All periods mentioned below are applied to all Gcore accounts by default. They can differ in particular cases if a personal manager or technical support changes the number of days for your account by mutual preliminary arrangement. +All periods mentioned below are applied to all Gcore accounts by default. They can differ in particular cases if a personal manager or technical support changes the number of days for your account by mutual preliminary arrangement. Additionally, Gcore reserves the right to delete data (including without prior notice) to enforce its rights as specified in the Master Services Agreement, other Gcore documentation, or applicable law. @@ -38,21 +38,21 @@ Additionally, Gcore reserves the right to delete data (including without prior n Edge Cloud - Managed Kubernetes + Managed Kubernetes 0* - Function as a Service + Function as a Service - Container as a Service + Container as a Service - Managed Logging + Managed Logging 14 days - Managed PostgreSQL + Managed PostgreSQL Other Edge Cloud features (including Basic VM, Virtual Machines, Volumes, File Shares, Snapshots, and Bare Metal) @@ -90,7 +90,7 @@ Additionally, Gcore reserves the right to delete data (including without prior n - + *Data stored on worker nodes will be deleted immediately after suspension. Data stored on volumes attached to the cluster will be deleted within 48 hours. @@ -103,17 +103,17 @@ The standard durations are subject to change. Check the [Master Services Agreeme ## What data will be deleted? -**Product** | **Feature** | **Data to be deleted** ----|---|--- -CDN | | CDN resources, SSL certificates, created rules, and origin groups -Edge Cloud | Managed Kubernetes | Nodes with all data stored locally -Function as a Service | Created functions -Container as a Service | Created containers -Managed Logging | Logs and other data -Managed PostgreSQL | Databases and other data -Object Storage | | Storages, buckets, all files and objects -Managed DNS | | Zones and records -Video Streaming | | CDN resources and added media -Web Application Security | | Resources under protection -DDoS Protection | | DDoS profile -WAAP | | Resources under WAAP protection \ No newline at end of file +**Product** | **Feature** | **Data to be deleted** +---|---|--- +CDN | | CDN resources, SSL certificates, created rules, and origin groups +Edge Cloud | Managed Kubernetes | Nodes with all data stored locally +Function as a Service | Created functions +Container as a Service | Created containers +Managed Logging | Logs and other data +Managed PostgreSQL | Databases and other data +Object Storage | | Storages, buckets, all files and objects +Managed DNS | | Zones and records +Video Streaming | | CDN resources and added media +Web Application Security | | Resources under protection +DDoS Protection | | DDoS profile +WAAP | | Resources under WAAP protection diff --git a/docs.json b/docs.json index 0db502aec..121e7ef85 100644 --- a/docs.json +++ b/docs.json @@ -1203,6 +1203,41 @@ ] } ] + }, + { + "tab": "Reseller Documentation", + "groups": [ + { + "group": "Reseller Support", + "pages": [ + "reseller-support", + "reseller-support/new-admin-panel-interface", + "reseller-support/getting-started", + "reseller-support/cdn-section-overview", + "reseller-support/cdn-service-management", + "reseller-support/storage-service-management", + "reseller-support/fastedge-management", + "reseller-support/service-statuses", + "reseller-support/api", + { + "group": "Manuals", + "pages": [ + "reseller-support/manuals/manage-clients", + "reseller-support/manuals/manage-sellers", + "reseller-support/manuals/vendor-settings", + "reseller-support/manuals/configure-password-policy", + "reseller-support/manuals/configure-sso-via-saml", + "reseller-support/manuals/set-up-control-panel-services-urls", + "reseller-support/manuals/configure-global-visibility", + "reseller-support/manuals/configure-personal-visibility", + "reseller-support/manuals/generate-monthly-reports", + "reseller-support/manuals/block-activate-users-and-sellers", + "reseller-support/manuals/view-the-history-of-users-requests-and-actions-via-activity-logs" + ] + } + ] + } + ] } ], "global": { diff --git a/home.mdx b/home.mdx index bb37abab9..9016ea758 100644 --- a/home.mdx +++ b/home.mdx @@ -12,26 +12,30 @@ import {GcoreHero} from "/snippets/Hero.mdx"; + + + + + + + + + + - + {/* - - - - - - - + */} diff --git a/reseller-support.mdx b/reseller-support.mdx new file mode 100644 index 000000000..e68983481 --- /dev/null +++ b/reseller-support.mdx @@ -0,0 +1,15 @@ +--- +title: Reseller support +--- + +Welcome to the Gcore Reseller documentation page! Here, we explain how to work with the Admin Portal, manage accounts and sellers, and configure products. + +From the left-side menu, you can access in-depth documentation: + +- **New interface** — overview of the dashboard for managing accounts and sellers, viewing reports, and configuring branding and product visibility settings. +- **Getting started** — first steps after becoming a Gcore reseller. +- **CDN management** — activate CDN, set statuses, and manage features. +- **Storage management** — activate Storage and configure statuses. +- **Product statuses** — overview of product billing statuses. +- **API** — reach the API documentation for resellers. +- **Manuals** — detailed guides on managing accounts and sellers; configure branding for your Customer Portal and SSO authorization and manage product visibility. \ No newline at end of file diff --git a/reseller-support/api.mdx b/reseller-support/api.mdx new file mode 100644 index 000000000..6070559e7 --- /dev/null +++ b/reseller-support/api.mdx @@ -0,0 +1,13 @@ +--- +title: API +--- + +For managing Reseller's settings via API use the documentation. + +It can be found by link from the Admin Portal. + + +API + + +**Important!** The API documentation cannot be reached by https://api.gcore.com/docs/ link. \ No newline at end of file diff --git a/reseller-support/cdn-section-overview.mdx b/reseller-support/cdn-section-overview.mdx new file mode 100644 index 000000000..e48457a7c --- /dev/null +++ b/reseller-support/cdn-section-overview.mdx @@ -0,0 +1,89 @@ +--- +title: CDN section overview +description: Explore our guide to CDN customer details, resource data, activity logs, and origin groups for efficient CDN management. +--- + +The CDN section collects information about your customers who use CDN and the resources they utilize. It includes the subsections Accounts, CDN resources, Activity Logs, and Origin Groups. + +## Customers + +This subsection provides details about customers who have created CDN resources. Each entry includes: + +- The customer’s account ID +- The CDN resource custom domain +- The email associated with the account +- The company name +- The date the CDN resource was created +- The CDN resource ID, along with custom domains and traffic data +- The amount of incoming traffic +- A list of paid features activated for the CDN resources +- The CDN resource status (e.g., “New,” “Trial,” “Trial End,” “Active,” “Paused,” “Activating,” “Deleted”) + +You can apply filters to manage specific entries. By default, only CDN resources with an “Active” status are displayed. + +Click three-dot icon on the right to edit a customer's settings. For further details, refer to the dedicated guide: Manage сlients. Click the arrow to log in to the Customer Portal as a customer. + + +Clients tab in the CDN section + + +## CDN resources + +This subsection lists all CDN resources created by customers. Each entry includes: + +- The CDN resource ID +- The CDN resource custom domain (CNAME) +- The customer's Account ID +- The ID of the main resource (not the reserve, if an origin group contains multiple origins) +- The SSL ID (if applicable) +- The shielding status (if enabled) +- Any CDN resource rules (if created) +- The origin group ID +- The CDN resource status (e.g., “New,” “Trial,” “Trial End,” “Active,” “Paused,” “Activating,” “Deleted”) +- The resource type (default or technical) +- A toggle indicating whether automatic suspension is enabled for the CDN resource +- The date the CDN resource was created + +You can log in as a customer to configure specific CDN resource settings without having to navigate to the Customer Portal. + +You can also filter resources scheduled for automatic suspension. This feature can assist you in contacting customers to discuss their plans for using CDN resources or to refine suspension and data deletion procedures. + + +CDN resources tab in the CDN section + + +## Activity logs + +This subsection contains activity logs that document CDN resource changes, rule configurations, purge, and prefetch requests. Each entry includes: + +- The Account ID +- The user ID (customers can create multiple users per account) +- The date and time of the request (in UTC) +- The HTTP request method (GET, POST, PUT, DELETE, or PATCH) +- The requested path +- Request data (if available) +- The request status code (e.g., 200, 404, 503) +- The customer's remote IP address +- The requested host +- The API token ID and the ID of the user who issued it + +You can add filters to display logs based on specific parameters. + + +Activity logs tab in the CDN section + + +## Origin groups + +This subsection provides information about origin groups. Each entry includes: + +- The origin group ID +- The origin group name +- A list of origins included in the group +- The CDN resource’s custom domain and ID (if a CDN resource has been specified for the origin group) + +You can edit or delete an origin group by clicking the three dots and selecting the appropriate action. + + +Origin groups tab in the CDN section + diff --git a/reseller-support/cdn-service-management.mdx b/reseller-support/cdn-service-management.mdx new file mode 100644 index 000000000..7c53b5643 --- /dev/null +++ b/reseller-support/cdn-service-management.mdx @@ -0,0 +1,106 @@ +--- +sidebarTitle: CDN management +title: CDN service management +--- + +import { Caution } from "/snippets/caution.mdx"; + + +## General CDN settings + +To open the general CDN settings of a particular customer, go to the account settings: + +1\. Go to Accounts and open the list of customers. + +2\. Click on the ID of the customer. Or, click the three dots and then click **Edit**. + + +Clients + + +A new page will open. + +## Manage general settings + + +Services + + +### Activate CDN + +1\. Go to the "Products" page. + +2\. Click **Show more** to open settings. + +3\. Enable the **Activate product** checkbox. Once the "Activate product" checkbox is enabled, the customer can create and manage CDN resources. You can deactivate the product by unchecking the checkbox. In this case, the customer will see a product activation request form on the CDN tab instead of the CDN resources list. + +**Note**: Deactivating the "Activate product" checkbox may suspend the work of active resources. + +### Transition to deleted status + +The CDN product status switches from "TrialEnd"/"Paused" to "Deleted" after a specified number of days. The "Deleted" status means the customer's resources are deleted. You cannot change the number of days yourself. To change the number of days before deletion for a specific customer, email us at [support@gcore.com](mailto:support@gcore.com). + +Don’t forget to click **Save changes** to apply them. + +## Free and paid features + +To see the list of available features, click **CDN settings**. + + +Services + + +You can also access customer settings via the CDN application. + +1\. Open the list of customers, in the "СDN" section. + +2\. Click on the ID of the desired customer. Or, click the three dots and then click **Edit**. + +3\. Navigate to the **Features** tab. + + +Edit customer + + +All available features will appear as a list with toggle buttons. Some features are free, while others are paid. + +Free features can be identified by the "Show Origin, Shield, and CDN Traffic Separately" option. Enabling this option allows you to view the traffic data in your Customer Portal in a more detailed way. By default, this feature is turned off, which means all traffic data from the origin, shield, and Content Delivery Network (CDN) is displayed together as a combined report. However, if you enable this feature, you can see the traffic from the origin, shield, and CDN separately. Each of these categories will have its own individual report, allowing you to analyze and understand the traffic from each source more clearly. + +Paid features include advanced directory, user agents, geo statistics, raw logs, origin shielding (to set the locations, contact technical support or your manager), and Video Streaming. + + +Paid features + + +After activation, don’t forget to save changes. + +Certain features, such as resources with shared cache zone, wildcard purge, and Image Stack, can only be enabled by contacting the Gcore support team at [support@gcore.com](mailto:support@gcore.com). You can learn more about these features by hovering your cursor over the question mark by their name. + +## Balancer + +CDN servers are grouped into regions in Geobalancer: *North America*, *CIS*, *Australia*, *Middle East*, *Africa*, *Europe*, *Asia*, *Latin America*, and *World*. The *World* option means anycast addressing is used, so the content could be served from any region in the global network, depending on which server can deliver the content most efficiently at that particular moment. + + +Balancer tab + + +### Set traffic balancer + +By default, this feature is disabled. If you want to manage routing, e.g., exclude some regions from delivery if there are no end users in this region, enable the feature as follows: + +1\. Click **Enable traffic balancer**. + +2\. Ensure that “Enable IPv6 delivery” checkbox is checked if you want to include IPv6 addresses in responses (AAAA record). If you need only IPv4 addresses (A record)—uncheck it. + +3\. Uncheck the checkboxes of the regions you want to exclude. + + + +To disable regions for your customers, you must also disable the “World” region. Otherwise, the balancer won't work correctly. + + +4\. Save changes. + + +Balancer settings + diff --git a/reseller-support/fastedge-management.mdx b/reseller-support/fastedge-management.mdx new file mode 100644 index 000000000..fb7945ef1 --- /dev/null +++ b/reseller-support/fastedge-management.mdx @@ -0,0 +1,231 @@ +--- +sidebarTitle: FastEdge management +title: Understanding how to manage FastEdge apps in the Admin Panel | Gcore +description: Explore our guide to FastEdge applications and templates management. +--- + +In the Gcore Admin Panel, you can manage two types of FastEdge applications and their corresponding templates: + +* **HTTP applications**: Manage your cloud applications deployed on edge servers across the global Gcore CDN network. + +* **CDN applications**: Manage FastEdge applications integrated with Gcore CDN infrastructure to extend the CDN functionality. + +## Manage FastEdge applications + +The **HTTP Applications** and **CDN Applications** pages contain information about all FastEdge apps created and used by your customers. + + +HTTP Applications page + + + + +You can save the preferred filters and columns displayed in the applications and templates tables. For instructions on how to configure and save presets, check out the Search presets section. + + + +### Filter data in the applications table + +You can filter application data based on the following criteria: + +* **Client ID**. A unique identifier for the customer account where the application was created. + +* **Status**. The current state of the application: + + * **Active**: The application is up and running. + + * **Disabled**: The application is stopped. + +* **Template ID**. A unique identifier for the template used to create the application. If this column is empty, it indicates that the application was created without a template. + +* **Binary ID**. A unique identifier for the binary file from which the application was created. Useful for distinguishing different versions of an app built from the same template. + +* **Plan**: The subscription plan according to which the application is billed. This is typically determined by the customer’s plan. + + +List of table filters + + +To filter information in the table: + +1\. Click **Add filter**. + + +Add filter button highlighted + + +2\. Specify the required criteria. For example, set the application status to **Active**. + + +Table filter set to active status + + +3\. Click **Apply filter**. + +The table results will be updated accordingly, and you’ll see the list of all currently running applications. + +Click **Reset all** to switch back to the default view. + + +Reset all link highlighted + + +### Configure columns in the applications table + +The applications table displays the following information about FastEdge apps: + +* **ID**: A unique identifier for the application. This information can be useful for diagnostic purposes and troubleshooting. If you encounter issues with a specific app and require assistance from our support team, we recommend providing the app ID in your support request. + +* **Name**: The application name specified in the Customer Portal during application creation. + +* **Upgradable**: If the column shows **Outdated**, this means that the application was created from a template and is using an old version of the binary. In this case, it’s best to update the application to the newest version. + +* **URL** (HTTP applications only): Link to the deployed HTTP application. + +* **Reseller**: The ID of a reseller account where the application was created. + +* **Description**: If your customer provided a description when creating the application in the Customer Portal, the description will appear in this column. + +### Stop or activate an application + +1\. Open the relevant page: **HTTP Applications** or **CDN Applications**. + +2\. Find the application that you want to manage and click the three-dot icon next to it. + +3\. Select the required action: **Stop** or **Start**. + + +Application settings menu with stop button highlighted + + +The application status will be changed respectively, and the changes will also be reflected in the Customer Portal, where your customers can also stop or start the application. + +### Upgrade a binary version + +Sometimes, you might see the **Outdated** status in the **Upgradeable** column. This status is only relevant to applications created from templates, and it means that the template has been updated. + +If this happens, we recommend upgrading the application binary to the newest template version to get the latest improvements and security fixes: + +1\. Open the relevant page: **HTTP Applications** or **CDN Applications**. + +2\. Find the application that you want to update and click the three-dot icon next to it. + +3\. Click **Upgrade binary version**. + + +Application settings menu with upgrade button highlighted + + +Your application’s binary has been upgraded to the latest version. + +### Delete an application + + +To delete a FastEdge CDN application, first disconnect it from the CDN resource. You won’t be able to proceed with the deletion until this step is completed. + + +If you delete a FastEdge application, it will be permanently removed from the Customer Portal. + +To delete an application: + +1\. Open the relevant page: **HTTP Applications** or **CDN Applications**. + +2\. Find the application that you want to remove and click the three-dot icon next to it. + +3\. Click **Delete**. + + +Application settings menu with delete button highlighted + + +4\. Confirm your action by clicking **Yes, delete**. + +The application has been successfully removed. + +## Manage application templates + +On the **Templates** pages, you can view and manage all templates created by your customers in the Customer Portal. + + +CDN Templates page + + +## Filter data in the templates table + +You can filter the templates based on the following criteria: + +* **Client ID**. A unique identifier for the customer account where the template was created. + +* **Group ID**. A unique identifier for the default group that’s associated with a single reseller and includes all customers created by that reseller. You can create and manage groups via API. + + +List of table filters + + +To filter templates in the table: + +1\. Click **Add filter**. + +2\. Specify the required criteria. For instance, enter the ID of a particular client to view all their templates. + + +Table filter set to active status + + +3\. Click **Apply filter**. + +The table results will be updated accordingly. + +### Configure columns in the templates table + +The templates table displays the following information: + +* **ID**: A unique identifier for the template. + +* **Name**: A template name specified in the Customer Portal. + +* **Reseller**: A unique identifier for the reseller that created the template. + +* **Group ID**: A unique identifier for the group that includes all reseller’s customers. + +* **Description**: If your customer provided a description when creating the template in the Customer Portal, the description will appear in this column. + +* **Instructions**: Guidelines for using the template (if those were provided in the Customer Portal). + +### Share or unshare a template + +Sharing a template makes it accessible to all your customers in the Customer Portal. They will be able to view it in the templates list and create FastEdge applications from this template. + +To use the template sharing options: + +1\. Open the relevant template page, either under the **HTTP Applications** or **CDN Applications**. + +2\. Find the needed template and click the three-dot icon next to it. + +3\. Click **Share template** or **Unshare template**. + + +Template settings menu with unshare button highlighted + + +Shared templates have the group ID specified in the table. If the **Group ID** column is empty, this means that the template isn’t shared with your customers, and they can’t see it in the Customer Portal. + +### Delete a template + +If you delete a template, it will be removed from the Customer Portal and you won’t be able to restore it back. You’ll need to upload the template again. + +To delete a template: + +1\. Open the relevant template page, either under the **HTTP Applications** or **CDN Applications**. + +2\. Find the template that you want to remove and click the three-dot icon next to it. + +3\. Click **Delete template**. + + +Template settings menu with delete button highlighted + + +4\. Confirm your action by clicking **Yes, delete**. + +The template has been successfully removed. \ No newline at end of file diff --git a/reseller-support/getting-started.mdx b/reseller-support/getting-started.mdx new file mode 100644 index 000000000..dd0085f41 --- /dev/null +++ b/reseller-support/getting-started.mdx @@ -0,0 +1,103 @@ +--- +title: Getting started +--- + +Once we create a reseller account, you'll get an email with the registration confirmation link. Follow the link to set a password. The link will be active for 24 hours. Write to [support@gcore.com](mailto:support@gcore.com) if the link expires or you experience other issues. + +Admin Portal enterance URL is ```https://admin.gcore.top/```. + +## What's next? + +Reseller is your account admin. Only one user in your organization can be a Reseller. This user can add Sellers, set up account branding and generate Statistics reports in the Admin Portal. + +## Inviting Sellers + +Seller is an additional user who has access to the Admin Portal. Users with this role can add clients and set up their resources. There are no limits to the number of Sellers for one organization. + +You can read on Seller account creating and management in this article. + +## Setting up Customer Portal + +In the Customer Portal, customers can set up their products, check statistics, and contact technical support. With no additional settings, your customers will be seeing Gcore Customer Portal which has our corporate colors, logo, and is based at https://accounts.gcore.com. + +If you are using your own Customer Portal and just need our API documentation to integrate your service with ours, here are the links: + +- Reseller API documentation +- Product API documentation + +If you and your customers are going to use the Customer Portal and you would like to change its look, read the following articles: + +- How to set up Customer Portal product URLs +- Settings + +## Creating customer accounts + +After you log into the Admin Portal, you'll be transferred to the "Accounts" section. Here you can create and edit your customers' accounts (customers are unable to register in your Admin Portal on their own). Both Sellers and Reseller can create customer accounts. You can read more on creating customer accounts in this article. + +Along with the Reseller account, we create a customer account with the same email and company name. This account is used for collecting your customers' stats, generating monthly reports (more on it in this article), keeping track of your Sellers and Reseller accounts (they are considered the users for that customer). Also, we recommend creating CDN Resources for the Customer Portal products in this account (more on it in this article). This account can't be deleted. + +## Product management + +All our products are available for reselling: CDN, Web Application and API protection, Video Streaming, Edge Cloud, Managed DNS, and Storage. + +When signing the contract, you discuss with your manager what products you want to resell. By default, the selected products will be displayed in the Customer Portal. You can adjust the visibility of products to all customers in the Admin Portal: + +1\. Navigate to the **Vendor settings** section. + +2\. Open the **Products** page. + +3\. Enable or disable toggles near the preferred products to manage their visibility in the Customer Portal. + + +Service management + + + +If you have activated **Video Streaming** product for your customers, note that each customer on the trial plan will automatically get access to one live stream. + + +You can also override the **General settings** in the customer settings. To do so: + +1\. In the sidebar, select **Accounts**. + +2\. Find the needed customer and click its account ID open the settings. Alternatively, you can click the three-dot icon and select **Edit**. + + +Edit account button + + +3\. On the **Products** page, choose the products that you want to activate or disable for the user. Note that you can’t disable the product with an **Active** or **Trial** status. Click the **Show more** button and change the status to **Trialend** or **Paused** before disabling the product. + + +Products page + + +If you enable a product, it will be displayed in the customer's Customer Portal. Disabled products will disappear from the customer's Customer Portal. + +If you want to log into that account as the customer's admin user, click the **Log in** button that’s displayed next to the three-dot icon. + + +Log in as a user button + + +**Please note**: Displaying a Product in the Customer Portal does not allow the customer to manage it by default. If the product is displayed but not configured (see the product management articles below), the customer will see the product activation request window: + + +Storage + + +When submitting an activation request, Gсore technical support or you — depending on the setting of the "Support email" field in the "Vendor settings" section — will receive an email about the customer's wish to access the product. + +Articles on product management: + +- CDN product management +- Storage product management + +## Useful links + +If you would like to get notifications about planned maintenance activities and incidents, subscribe to our Status Page. You can read more about the service and its subscription methods in this article. + +- Reseller API documentation +- Product API documentation + +This knowledge base describes how to manage products as an administrator from the Admin Portal and doesn't include articles on how to set up products as a customer. For the latter, read the articles here: https://gcore.com/docs/. If you have questions, please, send them to [support@gcore.com](mailto:support@gcore.com). \ No newline at end of file diff --git a/reseller-support/manuals/block-activate-users-and-sellers.mdx b/reseller-support/manuals/block-activate-users-and-sellers.mdx new file mode 100644 index 000000000..5f1df5d0c --- /dev/null +++ b/reseller-support/manuals/block-activate-users-and-sellers.mdx @@ -0,0 +1,44 @@ +--- +title: Block or activate a seller +--- + +## What is the "Block" feature? + +The new Admin Portal's "Block" feature allows you to block sellers, which is an effective tool for managing access to the Admin Portal and maintaining a secure and trustworthy community of consumers. + + +All requests to the Admin Portal API, including authorization tokens, password recovery, and activation requests, are prohibited. + + +The blocking restrictions will remain in effect until you cancel them with the "Activate" feature. + +## Block or activate a seller + +1\. Go to the Sellers section in the Admin Portal. + +The new page will open, and you can do the remaining steps there. + +2\. Find the seller you need using the filters. + +3\. Scroll the page on the right and click the three dots. + +4\. Select **Block**. + +The seller will be blocked. + +Click **Activate** if you need to unblock the seller in step #4. + +## Check if a seller is blocked or active + +1\. Go to the Sellers section in the Admin Portal. + +2\. Find the seller you need by using the filters. + +3\. Check the value of the seller in the "Blocked" column. + + +Blocked column + + +- If the status is "true", the seller is blocked and cannot access the account and products. +- If the status is "false", the seller is active and has access to the account and products. diff --git a/reseller-support/manuals/configure-global-visibility.mdx b/reseller-support/manuals/configure-global-visibility.mdx new file mode 100644 index 000000000..0c3e28521 --- /dev/null +++ b/reseller-support/manuals/configure-global-visibility.mdx @@ -0,0 +1,28 @@ +--- +title: Configure global visibility of products +sidebarTitle: Global visibility +--- + +You can configure global visibility in the "Settings" section, "Products" tab of the Admin Portal. + + +Products page + + +**As the result of switching the global product visibility from OFF to ON** a product is activated for all customers, except customers with individual settings for this product. + +**Switching the global product visibility from ON to OFF** for a product without individual settings is allowed or prohibited depending on the product's status. + +1\. It is allowed to disable a product if it's in the "New", "Trialend", "Paused", or "Deleted" statuses. As a result: + + - A product becomes inactive in personal visibility settings. + - All settings for this product become inactive in the product tab (Accounts > Account ID > Product). + - Disabled products are not displayed in the customer's Customer Portal. + +2\. It is allowed to disable a product if a product is in "Trial" or "Active" statuses. Switch its status to "Trialend" or "Paused" before disabling the product and then try again. + + +settings + + +For a newly created customer are available all the products set in the global visibility settings. diff --git a/reseller-support/manuals/configure-password-policy.mdx b/reseller-support/manuals/configure-password-policy.mdx new file mode 100644 index 000000000..4be1e4400 --- /dev/null +++ b/reseller-support/manuals/configure-password-policy.mdx @@ -0,0 +1,59 @@ +--- +title: Configure password policy +--- + +We enforce a predefined password security policy that protects your system from unauthorized access. The policy comprises the following rules: + +* **Password reuse**. After a password expires, a user must create and use three unique passwords before using the old password again. The system stores the last three passwords to prevent immediate reuse. + +* **Password expiration**. You can set up the frequency of password expiration or disable this feature altogether. If the policy is disabled, users can retain their passwords indefinitely. + +## Enable password policy + +Before setting up the policy, make sure you have disabled the login/password authentication option. If this setting is already applied, skip **Step 1**. + +### Step 1 (Optional). Enable username/password login + +Before configuring the password policy, make sure that the **Username/Password login** option is enabled for a user. Otherwise, you won’t be able to save the policy settings. + +To enable authorization via username and password: + +1\. In the Admin Portal, navigate to the **Security** settings. + +2\. Click **Authorization**. + +3\. Enable the **Username/Password login** toggle. + +4\. Click **Save** to apply the changes. + + +SSO in the Admin Portal + + +### Step 2. Activate password policy + +To configure password frequency change for an account: + +1\. In the Admin Portal, navigate to the **Security** settings. + +2\. Click **Password policy**. + + +SSO in the Admin Portal + + +3\. Enable the **Frequency of password changing** toggle. + + +SSO in the Admin Portal + + +4\. Specify the number of days after which the password becomes invalid. The password can be set to expire between 30 and 180 days. + + +We recommend setting a password change frequency between 60 and 90 days. + + +5\. Click **Save** to apply the changes. + +Two weeks before the expiration date, all users with enabled password policy will start receiving emails reminders about password change. \ No newline at end of file diff --git a/reseller-support/manuals/configure-personal-visibility.mdx b/reseller-support/manuals/configure-personal-visibility.mdx new file mode 100644 index 000000000..7bd64f967 --- /dev/null +++ b/reseller-support/manuals/configure-personal-visibility.mdx @@ -0,0 +1,28 @@ +--- +title: Configure personal visibility of products +sidebarTitle: Personal visibility +--- + +You can configure personal visibility in the customer's settings: Accounts > Account ID > Products. + + +Configure personal visibility of products + + +# Changing Product Visibility + +To enable a product, change the product visibility from OFF to ON, confirm the changes, and save the settings. + +To disable a product, change the product visibility from ON to OFF. The product must be in one of the following statuses: +- New +- Trialend +- Paused +- Deleted + +When you disable a product, all settings for the product will become inactive. Disabled products will no longer appear in the customer's personal account. + +Important: If a product is in the Trial or Active status, you will encounter an error. To proceed, first switch the product’s status to Trialend or Paused, and then disable it. + +# Interaction with Global Visibility Settings + +Once changes are made to a customer's personal visibility settings, the affected products will no longer be influenced by global visibility settings. This ensures that personalized product visibility configurations are retained independently. diff --git a/reseller-support/manuals/configure-sso-via-saml.mdx b/reseller-support/manuals/configure-sso-via-saml.mdx new file mode 100644 index 000000000..ea65e32fe --- /dev/null +++ b/reseller-support/manuals/configure-sso-via-saml.mdx @@ -0,0 +1,115 @@ +--- +title: Configure Single Sign-On (SSO) via SAML +sidebarTitle: Configure SSO +--- + +You can give customers the ability to authorize using SSO (Single Sign-On) — a single sign-on technology with which a user can log in to a personal account using a corporate account. + +To implement the technology, our systems use the SAML 2.0 XML protocol which is an open standard for the secure exchange of authentication and authorization data between the corporate identity provider (IdP) and the service provider (SP) of Gcore. + +## Configuring SSO in the Admin Portal + + +SSO in the Admin Portal + + +To allow your users to log in using SSO, in the Admin Portal: + +1\. Go to the "Authorization" tab. + +2\. In the "Login options" section, activate the "SSO Login" authorization method. + +3\. In the "Provider" section, enter your provider information. + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
NameYour identity provider name. You can specify any name, the data from this field will be displayed only in the Admin Portal and do not affect the SSO settings.
Entity IDUnique URL for the connection to the identity provider. Provided by the IdP.
DomainsThe list of domain names will be used to redirect to the identity provider page for authorization via SSO.
SAML metadataXML file with the identity provider metadata. Provided by the IdP.
+ +Activate "Force redirect to the Identity provider" if desired. If this option is enabled the user only has to enter a username and password to log in. If it is disabled the user has to enter the corporate domain additionally. + +4\. Using the checkboxes at the bottom, select the type of account for entering using the SSO — customer's one, administrator’s one, or both. + +## Data for the identity provider + +After entering the identity provider information on the Gcore side, enter the Gcore information in the identity provider settings. All necessary metadata is available by link: https://api.gcore.com/iam/auth/saml2/metadata. + +If you use a self-signed SSL certificate, you must enable the use of such certificates in the settings of the identity provider. + +## Authorization via SSO in the customer's Customer Portal + +1\. Click "Sign in with SAML SSO". + + +Sign in with SAML SSO + + +2\. This step will appear if you have not activated the "Force redirect to the Identity provider" option. If you have done, it will not appear. + +Enter the corporate domain for which SSO authorization is connected and click "Sign in with SAML SSO". + + +SSO authorization + + +3\. Enter your username and password and log in. + + + log in + + +## Authorization via SSO in the Admin Portal + +1\. Click "Sign in with SAML SSO". + + +Sign in with SAML SSO + + +2\. This step will appear if you have not activated the "Force redirect to the Identity provider" option. If you have done, it will not appear. + +Enter the corporate domain for which SSO authorization is connected and click "Sign in". + + + SSO authorization + + +3\. Enter your username and password and log in. + +## Supporting IDP-Initiated Login + +In cases where the identity provider (IdP) initiates the login, specific configurations are necessary to ensure the redirection flow functions correctly. While our implementation primarily supports service provider (SP)-initiated login, IdP-initiated login can also be accommodated with the following adjustments: + +1\. Redirect to SP login endpoint: Configure the IdP to redirect login requests to the Gcore Service Provider endpoint: `auth.gcore.com`. If you have a custom domain, use the custom domain URL: `auth.example.com`. + +2\. Update Gcore Customer Portal settings: Ensure the "SSO Login" authorization method is active and properly configured to process incoming requests from the identity provider (IdP). If desired, you can enable the option to force redirects to the IdP for seamless authentication. + +3\. Modify IdP settings: Configure the IdP to require SP-initiated login. This ensures that when users attempt to log in from the IdP, they are redirected to the Gcore portal login URL (e.g., auth.gcore.com or auth.example.com) before the IdP completes authentication. + +4\. Verify redirect flow: Confirm that the login process follows these steps: +- The user clicks "Login to Gcore Customer Customer Portal" on the IdP. +- The request is redirected to auth.gcore.com or auth.example.com. +- The user is then redirected back to the IdP for authentication. +- After successful authentication, the user is logged into the Gcore Customer Portal with the appropriate domain settings applied. diff --git a/reseller-support/manuals/generate-monthly-reports.mdx b/reseller-support/manuals/generate-monthly-reports.mdx new file mode 100644 index 000000000..cce6832eb --- /dev/null +++ b/reseller-support/manuals/generate-monthly-reports.mdx @@ -0,0 +1,111 @@ +--- +title: Generate monthly reports +sidebarTitle: Monthly reports +--- + +Generate monthly reports to analyze your customers' traffic consumption. + +## Generating report + +Go to the "Reports" section in the Admin Portal and click on the Create new report button in the upper-right corner. + + +Reports section + + +Choose the report parameters in the pop-up window. + + +report parameters + + +In the "Product" field choose a product. + +In the "Features" field choose components of statistics. Based on these components, you can calculate the cost of products for your customers. + +### CDN + +1. CDN-HTTP/HTTPS Delivery (per GB) -total traffic. +2. CDN - HTTP/HTTPS Delivery - Bandwidth (Gbps) - bandwidth. +3. Origin Shielding - the number of shieldings (pcs.) +4. CDN - HTTP/HTTPS Upstream - traffic from an origin source to CDN servers or from an origin source to a shield, if there is a shield. +5. CDN - HTTP/HTTPS Sent - traffic from CDN servers to users. +6. CDN - HTTP/HTTPS Shield - traffic from a shield to CDN servers. +7. Image optimization service - the number of images transformed on the Image optimization service. +8. Raw Logs - the number of resources that used Raw Logs + +### Storage + +1. Used Volume (AVG) - average used volume. +2. Used Volume (MAX) - maximal used volume. +3. Data Transfer - total traffic. +4. Requests - the number of requests. + +### Video Streaming + +1. Live stream transcoding - Minutes - total time of live stream transcoding. +2. Live stream transcoding - Sream - number of active simultaneous streams +3. VOD Storage - maximal used volume for VOD + +Choose one or more grouping parameters: + +- by account — groups data by account ID, +- by product — groups data by CDN-Resource ID or Storage name, +- by regions — groups data by traffic geographical region. + +Specify a month and a year for which the report should be generated. + +**Note**: Due to the internal architecture of stats collection, it's best practice to generate the report for the previous month not before the 2nd day of a new month. + +Click on the "Create report" button to send a report generation request. The process might take up to 15 minutes. You can see the report status in the "Reports" section in the "Status" column (the status is updated every 15 minutes): + +- Generating — a report is being processed, +- Ready — a report is ready for download, +- Failed — an error occurred during the report generation. + +Once the report is ready you can download it in CVS format. + +## Reading report + +The report represents data for a specified month, it uses commas to separate values. + +There is a report example below grouped by customer and region parameters. + + +report + + +Report's first line has the reseller's ID and company name (marked as1). + +Below (marked as 2) — blocks with data for reseller's customers: + +- There is a separate data block for each customer in the report. +- Only those customers who have generated some traffic (or other statistical data) get included in the report. + +The first line in the block is the list of headers. Others — the report data. + +At the beginning of the line, there is some data about the customer (Account ID, Company name). Then — about the product (Product ID, Product name), the region (Region ID, Region name), and usage (Usage, Unit). + +Account ID and Company name are mentioned only in the second line. Then they are not shown. + +Example of the line mentioning Account ID and Company name: + +``` +234,Client_one,92,CDN - HTTP/HTTPS Delivery (per GB),7,Latin America,0.0000,GB +``` + +Example of the line without Account ID and Company name: + +``` +,,92,CDN - HTTP/HTTPS Delivery (per GB),8,Middle East,0.0023,GB +``` + +You can look up the full description of the report parameters in the API documentation: "Get a Report in CSV" request. + +## Deleting report + +To delete a report, go to the "Reports" section, on the three dots in the "Actions" column, and choose "Delete". + + +Deleting report + diff --git a/reseller-support/manuals/manage-clients.mdx b/reseller-support/manuals/manage-clients.mdx new file mode 100644 index 000000000..45ee145d5 --- /dev/null +++ b/reseller-support/manuals/manage-clients.mdx @@ -0,0 +1,143 @@ +--- +title: Manage customers +--- + +In the "Accounts" section, you can add, view, edit, and delete customers. A customer is not allowed to self-register. Only users with "Reseller" or "Seller" rights can create customer accounts. + +## Create an account + +To create a new customer account, go to the "Accounts" subsection and click the "Add new account" button in the upper-right corner. + + +Accounts subsection + + +In the next window, add information about a customer and select the products that will be available for them. + +In the field on the left, enter information about a new customer: e-mail, first and last name, company, name in your system, sign-in password; select "Seller" from the list to sort customers by the "Seller" attribute in the "Accounts" tab and the language for automatic emails in the "Lang" field: "en" — for emails in English. + +In the field on the right, toggle on the products that you want to make available for the customer. By default, the global product visibility settings are inherited. + + +global product visibility settings + + +**Important!** If you want to customize product visibility and override settings of the global product visibility in the "Settings" section, the "Products" subsection switch on and off a product toggle as required. Be aware that further changes in the global product visibility settings will not affect the customer's custom product visibility. To learn more about it, click here. + +You can reconfigure customized product visibility in the account settings after creating an account. + +Enabling a product in the "Products" section **creates a tab of a given product** in the account settings and the customer's Customer Portal, **but does not activate the product**. To activate a product, go to a account settings, check "Activate product" and set the product status. To learn how to set up a product, refer to our guide on CDN configuration. + + +Product statuses + + +## Edit an account + +After creating a customer account, you can set up their products, edit personal data and manage rights of users of that account. + +For set-up guides, refer to the following product docs: + +- New Admin Portal interface +- Getting started +- CDN management +- Storage management +- Product statuses +- API + +To edit the personal data and manage user rights, click on the ID of the desired customer, or click on the "Edit" button in the "Actions" сolumn. If you click on the "Log in" button you'll log in the customer's Customer Portal panel under customer's admin user. + + +Edit an account + + +### Edit account tab + +In this section, you can: + +1\. Log in to the Customer Portal using the client’s credentials. + +2\. Check the “Test Account” checkbox to hide a customer from the all customers list in the Customers subsection. Customer accounts marked as test accounts will not be displayed in the list. If you want to see test accounts, set the filter to “Test account true.” + +In the “Settings” section, fields with the information about the customer are included per steps 3–6. + +3\. Review the "Account status." It shows the steps of using an account. The customer's status is determined automatically according to the conditions: + +- **Preparation**. An account has been created, but the user has not yet used any product. +- **Trial**. An account has at least one product in “Trial” status, but no product in “Active” status. +- **Active**. An account has at least one product in “Active” status. +- **Trial End**. At least one of the product is in the “Deleted,” “Trial End,” or “Paused” status, and no product is in “Active” or “Trial” status. +- **Deleted**. An account is deleted. + +**Note**: You can’t edit the "Account status” field. + +4\. Change a customer’s email address (Company email) and company name (Company.) + +5\. Set your Account ID in the “Custom ID” field. You can use letters, numbers, and special characters. Your customers will see the value in the API requests but cannot edit it. + +6\. Select “Seller” for every customer in the “Seller” dropdown list, to facilitate the search. + +7\. If you change something, don’t forget to save the changes at the top of the page. + + + +Edit customer tab + + +### Services tab + +You can customize product visibility for a customer. + +### Users tab + +On this tab, you can edit personal data and manage user rights. You can invite new users only via the customer's Customer Portal. + +You can edit a customer's name, email address, language of automatic emails and user type. + + +Users tab + + +About Users + +## Delete account + +To delete their accounts, customers should navigate to the "Profile" section: + + +Open profile + + +Then, open the "Account profile" tab, go to the "Delete account" page and click **Delete my account**. + + +Delete account + + +After confirmation all products of their accounts will be stopped, and the deletion request appears in the Customer Portal. + +You can also receive emails about status updates of deletion requests. We describe how to do it in the "Vendor settings" article. + +When you receive a deletion request, you have 10 days to contact the customer and convince him/her not to quit. After 10 days the account will be deleted automatically. + +To process the request manually, open the "Delete account" tab. + + +Delete account + + +On the left you'll see information about a current request status. On the right you will find the history of all the customer's deletion requests. Below there are two buttons used to manage requests. + +"Cancel the deletion request" cancels the deletion request. When you press this button, the window for notes will appear — you can add a comment here. It will be saved in the history of all the customer's deletion requests and will relate to the canceled request. + +"Delete account" deletes the account. When you press this button, the confirmation window will appear. Press "Yes, delete account" to destroy the account. + +You can delete an account even if a customer hasn't sent a request — for example, to destroy abandoned or test accounts. + +## Log in to a customer account + +Open the list of customers, in the "Accounts" section, find the desired customer and click on the "Log in" button in the "Actions" сolumn. You'll log in the customer's Customer Portal under customer's admin user + +**Important!** Currently, users with «Reseller», «Seller» roles share the same UI and available operations in the customer's Customer Portal. + +We are working on granting more rights for "Resellers" and "Sellers" for an account management. diff --git a/reseller-support/manuals/manage-sellers.mdx b/reseller-support/manuals/manage-sellers.mdx new file mode 100644 index 000000000..db6765d4d --- /dev/null +++ b/reseller-support/manuals/manage-sellers.mdx @@ -0,0 +1,49 @@ +--- +title: Manage sellers +--- + +Use the "Users" section, "Sellers" tab to add, edit or delete users with Sellers rights. + +## Creating Seller accounts + +To add a Seller go the "Sellers" tab and click on the "Add Seller" button. + + +Creating Seller accounts + + +In a new window specify the Seller's name, email and phone number then click on the Send Invite button. An email with the password set up link will be sent to the specified email. The link will be active for 24 hours. + +There is a "Status" column on the "Sellers" tab where you can see whether a Seller has followed the link ("Activated" status) in the email or not ("Not activated" status). + +If the link has expired a Reseller can resend the invitation - click on the "Resend Invite" button in the "Actions" сolumn of the desired Seller (the button is shown only if a user hasn't activated the account; the timestamp of the last invitation is also shown next to the Seller status). + + +Resend Invite button + + +## Deleting Seller accounts + +Click on the "Delete Seller" button in the "Actions" сolumn of the desired Seller. Once an account is deleted the Seller loses access to the Admin Portal and password recovery. The user profile (name, email, phone) also becomes unavailable. + + +Deleting Seller accounts + + +## Seller password recovery + +To reset Seller's password use one of two ways: + +1\. Click on the "Reset password" button in the "Actions" сolumn of the desired Seller. + + +Reset password + + +2\. Ask Seller to Reset password via the login form on https://admin.gcore.top. + + +Reset password via the login form + + +The old password stops working only once the new password is set up. diff --git a/reseller-support/manuals/metadata.mdx b/reseller-support/manuals/metadata.mdx new file mode 100644 index 000000000..0ff840a6b --- /dev/null +++ b/reseller-support/manuals/metadata.mdx @@ -0,0 +1,6 @@ +--- +title: metadata +displayName: Manuals +published: true +order: 70 +--- \ No newline at end of file diff --git a/reseller-support/manuals/set-up-control-panel-services-urls.mdx b/reseller-support/manuals/set-up-control-panel-services-urls.mdx new file mode 100644 index 000000000..c9afd7f6a --- /dev/null +++ b/reseller-support/manuals/set-up-control-panel-services-urls.mdx @@ -0,0 +1,35 @@ +--- +title: Set up Customer Portal product URLs +sidebarTitle: Set up product URLs +--- + +The customer's Customer Portal is a combination of different products. Here are the product URL examples for Gcore customers: + +- auth.gcore.com — authorization +- accounts.gcore.com — customer account management +- cdn.gcore.com - CDN product +- cloud.gcore.com — Edge Cloud product +- streaming.gcore.com — Video Streaming product +- storage.gcore.com — Storage product +- control.gcore.com — Web Application Security product +- dns.gcore.com — Managed DNS product +- api.gcore.com/docs - API Documentation +- api.gcore.com - API domain. + +We are using Single Sign-On authentication between the products, so once users log in to the Customer Portal (authorization service), they can access other products automatically. + +All of the URLs above have the same base — gcore.com — which we call Base Customer Portaldomain. Products' subdomains are added automatically to the Base Customer Portal domain. + +You need to inform your manager which Base Customer Portal domain you would like to have, and we will set up the products for your users' Customer Portal. + +**Note**: The goal of this article is to explain how the customers' Customer Portal works. To avoid issues with the Customer Portal performance we recommend you abstain from making changes to CDN Resources described below. + +A CDN Resource powers every product. We create those resources in your technical account. The technical account is your first customer account in the Admin Portal. It's created automatically; its email and company name match reseller's email and company name. + +The technical account is used to collect statistics and to form monthly reports. All Admin Portal users (Reseller and Sellers) are listed under this account. The technical account can't be deleted. We recommend you abstain from making any changes to this account on your own. + +Due to the security reasons, the Customer Portal works only via HTTPS so for each CDN Resource an SSL-certificate must be added or you can add one wildcard SSL-certificate for the Base Customer Portal domain value. + +Once we set up the CDN Resources we ask you to add new records to your DNS settings. You need to create a CNAME record for each product URL. CNAME record is pointed to you personal domain zone which we also provide. + +When everything is ready we put your Base Customer Portal domain into the field with the same name in the "Branding settings" section. \ No newline at end of file diff --git a/reseller-support/manuals/vendor-settings.mdx b/reseller-support/manuals/vendor-settings.mdx new file mode 100644 index 000000000..1313e4def --- /dev/null +++ b/reseller-support/manuals/vendor-settings.mdx @@ -0,0 +1,239 @@ +--- +title: Vendor settings +--- + +import { Caution } from "/snippets/caution.mdx"; + +Here you can add your trademark, corporate identity, symbols and contact info when reselling our products. Your company branding will be displayed in the customer's Customer Portal instead of the Gcore one. + +To set up branding, go to the "Branding settings" tab in the "Vendor settings" section. + + +Branding settings + + +## Base control panel domain + +Enter the top level domain into the "Base Customer Portal domain" field. It will be used to generate the product subdomains. + +For example, if you specify "mycompany.com", your products will be available at "auth.mycompany.com", "cdn.mycompany.com", "accounts.mycompany.com". + + +Base Customer Portal domain + + + +To avoid issues with the Customer Portal, we don't recommend making changes in the field. + + +For more details about the "Base Customer Portal domain" field, refer to How to set up Customer Portal product URLs. + +## Colors and logo + +### Brand name + +Enter your brand name. It will be displayed in the title tag of the page’s tab, in the “Help” menu > “Website”, on the Welcome page, in the body of email notifications, and in the sender's name. + +### Languages + +Configure the languages that will be available for your customers in the Customer Portal. + +### Logo at the sign-in page + +This option configures the logo on the user sign-in page: https://auth.gcore.com/login/signin + + +Logo at the sign-in page + + +### Header logo + +The setting configures the logo in the product column and on the user sign-in page: https://auth.gcore.com/login/signin + + +Header logo + + + +Your image must be: + +- Smaller than 4 MB. +- SVG (recommended)/PNG/JPG file. +- 75 x 40 px resolution. + + + +### Header text color + +The setting configures the color of icons and product names in the navigation menu in the Customer Portal. + +### Favicon + +This configures the favicon. + + +Favicon + + + +Your image must be: + +- ICO file. +- 16 x 16 px. + + + +### Brand color + +This configures the color of hovered menu items and links in the Customer Portal and on the sign-in page. + + +Brand color + + +## Customer Support Tools + +Customer support tools include the phone number and email address of technical support, as well as links to the Status Page that informs about incidents and maintenance, the company's website, Knowledge Base and API documentation, and chat with the Gcore technical support. + +All tools, except for the chat, are available in the customer's Customer Portal in the "Help" section. + +If the chat option is activated, it is shown as a pop-up widget in the customer's Customer Portal. + +By default, when the "Branding settings" are not activated, the customer's Customer Portal shows links, email address, and phone number of the Gcore technical support. + +### Support phone number + +This setting allows displaying the phone number of your technical support. + +### Support email + +The setting allows displaying the email address of your technical support. + + +Support email + + +### Link to User Agreement + +The setting allows displaying the link to your legal documents. + +### Link to a company website + +The "Link to website" setting allows displaying the link to your website. + +### Show API documentation + +The setting allows displaying links to your API documentation. + +### Show Knowledge Base + +The setting allows displaying a link to your Knowledge Base. + +### Show Status Page + +The setting allows displaying a link to your Status Page. + + +Useful links for customers + + +### Show online chat + +The setting allows your customers to contact Gcore technical support via a chat in their Customer Portal. If the chat option is activated, it is shown as a pop-up widget in the customer's Customer Portal. + +### Show Create new account + +The setting allows your customers to create additional accounts. + +If it is activated, your customers can create additional accounts from their Customer Portals. + + +Show Create new account + + +## Email alerts + +This setting allows you to specify email addresses that will receive notifications about your customers' actions: account deletion requests and failed authorization attempts. + +**Email for deletion requests.** Here you can enter an email address to receive notifications about status updates of deletion requests. We will automatically send you emails about three events: a customer sends the request, the request is canceled, and the account is deleted. + +**Email for unsuccessful login attempts.** Here you can add an email address to receive notifications about unsuccessful login attempts. This will help you promptly respond to any suspicious activity in the accounts of all admin and Customer Portal users. + +To receive emails, turn on the needed toggle and enter your email address into the field. If you want the emails to be sent to multiple email addresses, add them with the "+" button. Don't forget to save the changes. + + +Email alerts settings + + +## SMTP Provider Settings + +This setting allows your customers to receive automatic event notifications about the product they use. For example: + +- the trial period has started, +- the trial period will end soon, +- a password has been changed, +- a new user has been added to the account. + +By default, your customers receive emails sent via a Gcore mail provider from support@gcore.com. If it is ok for you, you do not need to configure anything. + +If you want to send automatic emails from another email address, specify your SMTP server and the address from which the emails should be sent. To do this: + +1\. Open "Branding settings" and make sure the "Base Customer Portal domain" field is filled in. If not, emails will not be sent. + + +Branding settings + + +2\. Go to the "SMTP Provider Settings" tab and enable the "Email for service emails" option. You will see the page with SMTP settings that need to be configured. + + +SMTP settings that need to be configured + + +3\. Configure the following settings: + +- Enter the email address that you want to use to send automatic emails to your customers. It will be displayed in the "From" field in emails. +- Enter the domain of your SMTP server such as smtp.serveraddress.com, or specify its IP address. +- Enter the port that your SMTP server uses. + + +Port 25 is commonly abused to send spam, so some ISPs block this port. If so, some customers may not get your emails via port 25. We recommend using port 465 or 587. + + + +- Check the "TLS" box if this security protocol for email encryption is enabled on your SMTP server. +- Enter your username and password of your SMTP server. + +4\. Save changes. + +To make sure that everything is configured properly, send yourself a test email by clicking the "Send test email" button. The email will be sent to your account's primary email address. + +## DNSaaS settings + + +DNSaaS settings + + +If the DNS product is available for your customers, you can set the values of your primary name server, secondary name server, and email address that will be used to generate SOA records. +This information will be displayed in the customer's Customer Portal when they add a domain name for the DNS zone. + +By default, we show Gcore primary and secondary name servers and Gcore email address. + +## Products + +In the Admin Portal, you can set products that are available to you and also visible to your customers. There are two levels of visibility: global (or default) and personal. +In the global visibility settings, you can set the visibility of products for all your customers. + + +Global products in vendor settings + + +In the personal visibility settings, you can enable or disable the visibility of products for a particular customer. The visibility statuses of personally configured products will not be available for changes from the global visibility settings. + + +If you have activated **Video Streaming** product for your customers, note that each customer on the trial plan will automatically get access to one live stream. + + + +List of account products + diff --git a/reseller-support/manuals/view-the-history-of-users-requests-and-actions-via-activity-logs.mdx b/reseller-support/manuals/view-the-history-of-users-requests-and-actions-via-activity-logs.mdx new file mode 100644 index 000000000..27f6846d8 --- /dev/null +++ b/reseller-support/manuals/view-the-history-of-users-requests-and-actions-via-activity-logs.mdx @@ -0,0 +1,68 @@ +--- +title: View the history of users’ requests and actions via Activity logs +sidebarTitle: Activity logs +--- + +## What is an Activity logs section for? + +The Activity logs section displays changes that users have made. Users are all the customers and sellers that you have added. Changes they can make include requests sent via the API and actions in the Customer Portal. + +## View users’ changes in the Activity logs section + +1\. Go to the https://admin.gcore.top/. + +2\. Open Activity logs in the Security section. + +The entities will be displayed on the right. + + +Activity logs + + +You can sort and filter entities by the following columns: + +- **Account**: ID of the customer that made the request +- **User ID**: ID of the user that made the request +- **Requested** at: Date and time when the request was made +- **Method**: Request HTTP method, such as GET, POST, PUT, DELETE, or PATCH +- **Path**: Request URL +- **Data**: Request body +- **Reverted**: Whether the request was rolled back +- **Status** code: Status code that the request returned in the response +- **Remote IP**: IP address from which the request was made +- **Host**: Host from which the request was made + +If certain columns are not required, you can disable them. Click **Manage Columns** in the upper right area and turn off the switch. + + +Manage Columns + + +## Use filters + +You can search for specific requests by setting filters. For example, you can filter out all logs for a user with a specific ID or all requests with the GET method. + +To filter logs by a specific parameter: + +1\. Click **Add filter**. +2\. Select the needed search condition, e.g., the period where any changes were made. +3\. Select the period. +4\. Click **Apply filter**. + + +Use filters + + +That’s it. As a result, you will see only entities for the specified period (in this case, from June 27, 2023, to July 04, 2023.) + +## How to look for changes in a particular customer + +Customers' accounts can be changed not only by customers themselves, but also by sellers. For example, a seller can change the product to "Trial" status. In this case, if you try to find the changes in the "Customer" column by specifying the Account ID, there will be no entity, because it was not the customer who made the change. + +To look for all changes, you should specify the Account ID in the “Path” filter as shown below. + + +Path filter + + +With this approach, all entities that are related to the customer will be filtered out, regardless of who made the change. diff --git a/reseller-support/new-admin-panel-interface.mdx b/reseller-support/new-admin-panel-interface.mdx new file mode 100644 index 000000000..972860b10 --- /dev/null +++ b/reseller-support/new-admin-panel-interface.mdx @@ -0,0 +1,112 @@ +--- +title: New Admin Portal interface +sidebarTitle: New interface +--- + +The new Admin Portal is an improved dashboard for managing accounts and sellers, viewing reports, and configuring settings such as branding and product visibility. + +Compared to the previous version of the admin panel, the new one retains all essential functions while adding new features, such as quick filters and presets for better searching and filtering. The new Admin Portal also has a more user-friendly interface. + +In this guide, we describe the structure and features of the Admin Portal panel. + +## Structure of the new Admin Portal + +The new Admin Portal has the following sections: + + +Structure of the new Admin Panel + + +**0\.** The button which collapses the left-side menu. All screenshots of the following interface are shown with the menu collapsed. + +**1\. Accounts**: This section displays a list of customers. Here you can manage the accounts of existing customers, including logging into the Customer Portal on their behalf, editing their data, deleting their accounts, or adding new accounts. + +**2\. Users**: This section contains two subsections, "Sellers" and "All users", where you can search for and manage users in these categories' accounts. + + +Users + + +**3\. CDN**: This section displays a list of all CDN resources created by your customers. Here you can search for a specific resource by ID or CNAME. + + +CDN + + +**4\. Streaming**: This section displays all accounts of your customers and their streaming statuses. + + +Streaming + + +**5\. FastEdge**: This section displays a list of all FastEdge applications created by your customers. Here you can manage FastEdge apps and templates. + + +FastEdge + + +**6\. Security**: This section contains the "Authorization" subsection. Here you can configure SSO. You can also enable the "Activity Logs" feature by contacting the [support team](mailto:support@gcore.com) or your personal manager. + + +Security + + +**7\. Vendor settings**: This section contains several subsections, including "Branding Settings", "SMTP Provider", "DNSaaS Settings", and "Products". Here you can manage the appearance of the Customer Portal, set up custom email addresses for product notification emails to your customers, change the default NS servers, and configure product visibility. + + +Settings + + +**8\. Billing**: This section presents monthly reports, allowing you to generate monthly reports to analyze your customers' traffic consumption. Additionally, you can enable "Invoice Reports" by contacting the [Gcore support team](mailto:support@gcore.com) or your personal manager. + + +Reports + + +**9\. Help**: This section contains links to the Knowledge Base, API documentation, and Legal documents. + +**10\. Profile**: In this section, you can copy the created API token. + +## New features of the new Admin Portal + +We have described all-important new features. If there is a feature you are interested in that is not mentioned, please send a request to the [Gcore support team](mailto:support@gcore.com). + +### Quick filters + +We have added quick filters by Account ID, email, name, company name, and customer status to make searching more flexible. + + +Quick filters + + +### Search presets + +We have added the ability to create presets for your search. With this feature, you can save filters to quickly apply them to future searches without having to recreate them each time. + +To create a preset: + +1\. Open the "Accounts" section and click **Add filter**. + + +Add filter + + +2\. Choose the necessary filters from the list, add the conditions, and click **Apply** filter. We suggest different filters in addition to the quick filters listed on the page. Applied filters will be added to the page. For example, we added filters by only real accounts (not tested) and CDN status "New": + + +Apply filter + + +3\. When all necessary filters have been added, click **My presets** and **Set current set as a preset**. + + +Set current set as a preset + + +4\. Type a name and click **Create**. + + +Create preset + + +After that, the created preset will be displayed in the list of presets. \ No newline at end of file diff --git a/reseller-support/service-statuses.mdx b/reseller-support/service-statuses.mdx new file mode 100644 index 000000000..fc522589c --- /dev/null +++ b/reseller-support/service-statuses.mdx @@ -0,0 +1,51 @@ +--- +title: Product statuses +--- + +You can configure the product statuses on the "Products" page in the settings of the desired customer. + + +Product statuses + + +## Activate product + +If you enable the **Activate product** checkbox, a customer can use that product. You can deactivate the product by unchecking the checkbox. + +Keep in mind that deactivating the **Activate product** checkbox may suspend the work of active resources. + + + +If you have activated **Video Streaming** product for your customers, note that each customer on the trial plan will automatically get access to one live stream. + + + +## Product status + +### New + +The status is applied to customers who sign up via our website before they confirm the registration via email. You register your customers yourself, so they won't have this status. + +### Trial + +When a customer is created from the Admin Portal, the Trial status is applied. The customer receives an email about the trial start. The trial settings can be changed in the Admin Portal. + +### TrialEnd + +When the trial ends, the product is switched to the TrialEnd status automatically. All the product resources get suspended. The customer will receive an email about the end of the trial period. + +### Active + +If the customer signs a contract with you, change the product status to Active manually before the trial ends and the client's products get suspended. + +### Paused + +If you want to temporarily suspend the customer, use the Paused status. All of the product resources will be paused. + +### Deleted + +This status is connected to the Transition to Deleted status setting. The Deleted status is set automatically once the specified number of days is over. When the Status is switched, the product resources get deleted. You cannot change the number of days yourself. To change the number of days for a specific customer, email us at [support@gcore.com](mailto:support@gcore.com). + + +Transition to Deleted status setting + diff --git a/reseller-support/storage-service-management.mdx b/reseller-support/storage-service-management.mdx new file mode 100644 index 000000000..13ab48596 --- /dev/null +++ b/reseller-support/storage-service-management.mdx @@ -0,0 +1,62 @@ +--- +title: Storage management +--- + +The product management page contains settings for its activation, trial period, and status. + +To open the product management page: + +1\. Open the list of customers, in the "Accounts" section. + +2\. Click on the Account ID of the desired customer, or click on the "Edit" button in the "Actions" сolumn. + + +Edit account option in actions menu + + +3\. Click on the "Products" tab. + +## Activate product + +If the "Activate product" checkbox is enabled, a customer can use the product. You can deactivate the product by unchecking the checkbox. + +**Note**: Keep in mind that deactivating the "Activate product" checkbox may suspend the work of active resources. + + +Activate product + + +When the product is disabled, the customer sees the request form. + + +Storage + + +## Trial settings + +Use this tab to change trial period settings. + +You can change the trial period setting: + +- The Trial end date field sets the end date of the trial period. +- Change the value of the Trial storage volume field to increase the trial period traffic limit. + + +Trial settings + + +On the Dashboard page, customers see how many Storage trial days are left. + + +how many Storage trial days are left + + +## Transition to Deleted status + +After the specified number of days, the Storage product status switches from "TrialEnd"/"Paused" to "Deleted". + +All the customer's resources and files in Storage will be deleted. To change the number of days for a specific customer, email us to [support@gcore.com](mailto:support@gcore.com). + + +Transition to Deleted status + diff --git a/streaming-platform/live-streams-and-videos-protocols-and-codecs/what-initial-parameters-of-your-live-streams-and-videos-we-can-accept.mdx b/streaming-platform/live-streams-and-videos-protocols-and-codecs/what-initial-parameters-of-your-live-streams-and-videos-we-can-accept.mdx index e97fe1eea..2c161c0b8 100644 --- a/streaming-platform/live-streams-and-videos-protocols-and-codecs/what-initial-parameters-of-your-live-streams-and-videos-we-can-accept.mdx +++ b/streaming-platform/live-streams-and-videos-protocols-and-codecs/what-initial-parameters-of-your-live-streams-and-videos-we-can-accept.mdx @@ -7,7 +7,7 @@ sidebarTitle: Input parameters Gcore Video Streaming supports: - * Receiving live streams from [your server (PULL) or a dedicated publishing point (PUSH)](/streaming-platform/live-streaming/create-a-live-stream) using numerous protocols including RTMP(S) and SRT. All supported live protocols are listed in the table below. The stream is transcoded and sent with [adaptive streaming](/streaming-platform/live-streams-and-videos-protocols-and-codecs/output-parameters-after-transcoding-bitrate-frame-rate-and-codecs#output-parameters-after-transcoding) via CDN in HLS/MPEG-DASH (CMAF low latency) formats. + * Receiving live streams from [your server (PULL) or a dedicated publishing point (PUSH)](/streaming-platform/live-streaming/create-a-live-stream) using numerous protocols including RTMP(S) and SRT. All supported live protocols are listed in the table below. The stream is transcoded and sent with [adaptive streaming](/streaming-platform/live-streams-and-videos-protocols-and-codecs/output-parameters-after-transcoding-bitrate-frame-rate-and-codecs#output-parameters-after-transcoding) via CDN in HLS/MPEG-DASH (CMAF low latency) formats. * Videos uploaded in almost any format, from standard MP4 to 4K HDR Video, are first transcoded to get videos of lower quality. Then, they're sent with adaptive streaming via CDN in HLS format. @@ -80,8 +80,8 @@ We recommend the following parameters for streams: Container (VOD) - 3g2, 3gp, asf, avi, dif, dv, flv, f4v, m4v, mov, mp4, mpeg, mpg, - mts, m2t, m2ts, qt, wmv, vob, mkv, ogv, webm, vob, ogg, mxf, + 3g2, 3gp, asf, avi, dif, dv, flv, f4v, m4v, mov, mp4, mpeg, mpg, + mts, m2t, m2ts, qt, wmv, vob, mkv, ogv, webm, vob, ogg, mxf, quicktime, x-ms-wmv, mpeg-tts, vnd.dlna.mpeg-tts @@ -123,7 +123,7 @@ We recommend the following parameters for streams: - + If the recommended parameters do not suit your stream (codecs, custom FPS, ProRes, High 4:4:4, Enhanced RTMP, etc.), write to us in the chat, send an email to [support@gcore.com](mailto:support@gcore.com), or contact your manager to find the solution. ## Multiple ingesting points @@ -137,7 +137,7 @@ This feature is especially valuable if your streams originate from multiple loca ## RTMP, RTMPS, and SRT for live streaming * RTMP (Real-Time Messaging Protocol) is a protocol for transmitting audio, video, and data over the Internet between a player and a server, supporting low-latency communication for real-time streaming. - * RTMPS is a variation of RTMP but incorporates SSL usage. + * RTMPS is a variation of RTMP but incorporates SSL usage. * RTSP (Real Time Streaming Protocol) is a communication protocol used to control servers that stream media content. RTSP uses the Real-time Transport Protocol (RTP) with Real-time Control Protocol (RTCP) to deliver media streams. * SRT (Secure Reliable Transport) is an open-source video transport protocol for delivering high-quality, secure, low-latency video across unreliable networks. @@ -159,7 +159,7 @@ You can use Push or Pull methods where applicable. SSL issues You used rtmps:// but in the encoder rtmp:// is specified - Check the protocol in your encoder. Follow step 3 of the guide. + Check the protocol in your encoder. Follow step 3 of the guide.