Skip to content

Commit

Permalink
Merge pull request #552 from G-Core/main
Browse files Browse the repository at this point in the history
main to dev
  • Loading branch information
slinkyslinky authored Nov 20, 2023
2 parents e389d5f + 3ca94ac commit f955adb
Show file tree
Hide file tree
Showing 38 changed files with 752 additions and 72 deletions.
4 changes: 2 additions & 2 deletions documentation/account-settings/account-deletion.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ After the **ten days** elapse, your account, data, and services will be permanen

## How to delete your account

Go to <a href="https://accounts.gcore.com/profile/delete-account" target="_blank">Delete account</a> and click **Got it, request the deletion**.
Go to the <a href="https://accounts.gcore.com/profile/delete-account" target="_blank">Delete account</a> page and click **Delete my account**.

<img src="https://assets.gcore.pro/docs/account-settings/account-deletion/deletion-10.png" alt="How to delete your account" width="80%">
<img src="https://assets.gcore.pro/docs/account-settings/account-deletion/delete-acc-10.png" alt="How to delete your account" width="80%">

In the pop-up that appears, please complete the short survey and click **Confirm**.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ For a quick search, use:

API token expiration notifications are displayed in your personal account and are sent by default to users who have issued a token and to users with the Administrators role.

You <a href=".documentation/account-settings/manage-service-notifications" target="_blank">can configure</a> notifications in the Notifications section of the Profile tab.
You <a href="https://gcore.com/docs/account-settings/manage-service-notifications" target="_blank">can configure</a> notifications in the Notifications section of the Profile tab.

<img src="https://assets.gcore.pro/docs/account-settings/api-tokens/expiration-notification-60.png" alt="API token expiration notifications" width="80%">

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
---
title: propose-changes-to-articles-on-github
displayName: Change articles on GitHub
published: true
order: 95
toc:
pageTitle: A guide on how to change articles on GitHub | Gcore
pageDescription: A comprehensive guide on how to propose changes to articles of the Gcore Product Documentation on GitHub.
---
# How to propose changes to Gcore Product Documentation articles on GitHub


1\. Open any article in the <a href="https://gcore.com/docs/" target="_blank">Product Documentation</a> section and scroll down to the footer. Click **Edit on GitHub**. In the example below we open the <a href="https://gcore.com/docs/account-settings/password/what-to-do-if-you-forget-your-password" target="_blank">What to do if you forget your password?</a> guide.

<img src="https://assets.gcore.pro/docs/edit-article-guide/edit-on-github-1.png" alt="Edit on GitHub" width="80%">

2\. The new page will open. Click **Edit on GitHub** again. Under the button, you will see a duplicate of this guide on how to propose changes.

<img src="https://assets.gcore.pro/docs/edit-article-guide/edit-on-gh-2.png" alt="Edit on GitHub" width="70%">

3\. <a href="https://github.com/login" target="_blank">Sign in</a> to your GitHub account.

4\. (First time only) Click **Fork this repository**. This will copy the Gcore ```product-documentation``` repository to your account. Next time you propose changes to our articles, this page will not be there.

<img src="https://assets.gcore.pro/docs/edit-article-guide/propose-changes-10.png" alt="Fork this repository function on GitHub" width="80%">

5\. Select the appropriate action from the options below, and follow the instructions.

<expandable-element title="Correct text: errors, typos, irrelevant product information">

1\. Make edits in the field, click **Commit changes...** and then click **Propose changes** in the pop-up.

<img src="https://assets.gcore.pro/docs/edit-article-guide/propose-changes-20.gif" alt="How to propose changes if you want to correct text" width="80%">

2\. Click **Create pull request**.

<img src="https://assets.gcore.pro/docs/edit-article-guide/propose-changes-30.png" alt="Create pull request function on GitHub" width="80%">

3\. Click **Create pull request** again.

<img src="https://assets.gcore.pro/docs/edit-article-guide/propose-changes-40.png" alt="Create pull request function on GitHub" width="80%">

That’s it. The Gcore technical writers will be notified of your request and will process it. You will receive a message to your GitHub account email about their decision.

</expandable-element>

<expandable-element title="Correct an invalid link">

1\. Remove the incorrect information from the <code>&lt;a href="https://wrong-link"&gt;</code> attribute. Insert the correct <code>&lt;a href="https://right-link"&gt;</code> link in its place, click <b>Commit changes…</b>, and then click <b>Propose changes</b> in the pop-up.

<img src="https://assets.gcore.pro/docs/edit-article-guide/propose-changes-v2-50.gif" alt="How to propose changes if you want to correct a link" width="80%">

2\. Click **Create pull request**.

<img src="https://assets.gcore.pro/docs/edit-article-guide/propose-changes-30.png" alt="Create pull request function on GitHub" width="80%">

3\. Click **Create pull request** again.

<img src="https://assets.gcore.pro/docs/edit-article-guide/propose-changes-40.png" alt="Create pull request function on GitHub" width="80%">

That’s it. The Gcore technical writers will be notified of your request and will process it. You will receive a message to your GitHub account email about their decision.

</expandable-element>

<expandable-element title="Report an incorrect screenshot or layout error">

**Note**: You cannot fix a screenshot or a layout error (button or content does not work, block is displayed incorrectly, etc.) in the product documentation yourself. If you find errors of this kind, let us know and we’ll fix it.

1\. To delete a screenshot or a fragment with an error, click **Commit changes** in the pop-up that appears, describe the error, and click **Propose changes**.

<img src="https://assets.gcore.pro/docs/edit-article-guide/propose-changes-60.gif" alt="How to propose changes if you want to correct a screenshot" width="80%">

2\. Click **Create pull request**.

<img src="https://assets.gcore.pro/docs/edit-article-guide/propose-changes-30.png" alt="Create pull request function on GitHub" width="80%">

3\. Click **Create pull request** again.

<img src="https://assets.gcore.pro/docs/edit-article-guide/propose-changes-40.png" alt="Create pull request function on GitHub" width="80%">

That’s it. The Gcore technical writers will be notified of your request and will process it. You will receive a message to your GitHub account email about their decision.

</expandable-element>

<expandable-element title="Leave a comment">

If you found an error in the text and do not want to correct it yourself, follow these steps:

1\. Highlight the text fragment with the error, delete it, or write a suggestion to enable comments. Click **Commit changes**, describe the error in the popup, and click **Propose changes**.

<img src="https://assets.gcore.pro/docs/edit-article-guide/propose-changes-70.gif" alt="How to propose changes if you want to let us know about corrections" width="80%">

2\. Click **Create pull request**.

<img src="https://assets.gcore.pro/docs/edit-article-guide/propose-changes-30.png" alt="Create pull request function on GitHub" width="80%">

3\. Click **Create pull request** again.

<img src="https://assets.gcore.pro/docs/edit-article-guide/propose-changes-40.png" alt="Create pull request function on GitHub" width="80%">

That’s it. The Gcore technical writers will be notified of your request and will process it. You will receive a message to your GitHub account email about their decision.

</expandable-element>
1 change: 1 addition & 0 deletions documentation/account-settings/users.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ published: true
toc:
pageTitle: Understanding user roles | Gcore
pageDescription: A detailed guide to user roles and permissions, covering how roles affect service management, personal data changes, etc.
customUrl: /account-settings/users/about-users
---

# About Users
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ In the article, you’ll learn how to manage users in the Control Panel. You can

## Invite a user

**Note**: Only the user with the <a href="https://gcore.com/docs/account-settings/users" target="_blank">Administrator role</a> can add new users to the account.
**Note**: Only the user with the <a href="https://gcore.com/docs/account-settings/users/about-users" target="_blank">Administrator role</a> can add new users to the account.

1\. Navigate to <a href="https://accounts.gcore.com/profile/users" target="_blank">Users</a>.

Expand All @@ -34,14 +34,15 @@ The following pop-up will appear, where you will perform the remaining steps.

You can invite both existing Gcore users and users who are not yet registered with Gcore:


- If a user isn’t yet in the Gcore system, when you try to add them, an email will be sent to their email address with a link to create a password. The invited user should accept the invitation and create a password. Then, they can log in to the account.
- If a user already exists in the Gcore system, a notification about the new account access will be sent to their email address. After accepting the invitation, users can log in to their account during authorization.

4\. Enter their email address. It will be used to send an invitation to become a user, and for other notifications.

5\. Specify the language of the interface: English, German, Chinese, or Russian.

6\. Select the CDN service and control panel (IAM) role. Learn more about <a href="https://gcore.com/docs/account-settings/users" target="_blank">which actions are available for each role</a>.
6\. Select the CDN service and control panel (IAM) role. Learn more about <a href="https://gcore.com/docs/account-settings/users/about-users" target="_blank">which actions are available for each role</a>.

**Note**: Depending on the role selected in IAM/CDN, the role for Cloud will be automatically selected. For example, if you want to create a user with the Administrator CDN role, the user will also have the most access to the Cloud service.

Expand Down Expand Up @@ -72,7 +73,7 @@ After the user has been sent an invitation, their user row will show whether the

<img src="https://assets.gcore.pro/docs/account-settings/users/add-edit-or-delete-an-invited-user/invite-users-40.png" alt="Edit a user from the Users page">

In the pop-up window, you can change your (Administrator) username, Role, and Language. As for other users, you can change only their <a href="https://gcore.com/docs/account-settings/users" target="_blank">Role</a>.
In the pop-up window, you can change your (Administrator) username, Role, and Language. As for other users, you can change only their <a href="https://gcore.com/docs/account-settings/users/about-users" target="_blank">Role</a>.

- If you are a user, edit your info in the General section of the <a href="https://accounts.gcore.com/profile/general" target="_blank">Account</a> page.

Expand Down
6 changes: 6 additions & 0 deletions documentation/cdn/cdn-resource-options/cdn-security/metada.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: metadata
displayName: Security
published: true
order: 35
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
title: protect-cdn-resources-with-basic-waf
displayName: Basic WAF (Beta)
published: true
order: 10
toc:
--1--Basic WAF: "what-is-basic-waf-beta"
--1--Enable: "how-to-enable-basic-waf"
--2--CDN resource: "cdn-resource"
--2--Specific URLs: "specific-urls"
--1--Basic WAF blocks some unwanted content: "what-to-do-if-basic-waf-blocks-some-content-that-should-not-be-blocked"
pageTitle: Protection from cyberthreads with Gcore Basic WAF | Gcore
pageDescription: A comprehensive guide on how to protect the entire CDN resource or specific urls.
---
# Protect CDN resources with Basic WAF

## What is Basic WAF (Beta)?

Basic WAF is the firewall that protects you against the most widespread cyberthreats. The feature is available in beta testing and is available for free. The volume of requests per resource that can be safeguarded by the firewall may be subject to limitations.

## How to enable Basic WAF

You can activate the firewall for the entire CDN resource or specific URLs.

### CDN resource

To enable Basic WAF for an entire CDN resource:

1. Go to the **Security** section in the Resource settings.
2. Toggle on the **Enable Basic WAF** feature.
3. Save changes.

<img src="https://assets.gcore.pro/docs/cdn/cdn-resource-options/cdn-security/protect-cdn-resources-with-basic-waf/basic-waf-10.png" alt="Enabling Basic WAF for the entire CDN resource">

### Specific URLs

To apply Basic WAF to particular files, in the CDN resource settings (“Rules” tab), create a rule where you specify URLs or regular expressions and enable the Basic WAF feature for them. To do that, <a href="https://gcore.com/docs/cdn/cdn-resource-options/rules-for-particular-files/create-a-rule-manually-or-from-a-template-to-configure-settings-for-particular-files" target="_blank">consult our dedicated guide</a>.

## What to do if Basic WAF blocks some content that should not be blocked?

If Basic WAF blocks content that you want to be allowed, you can set an exception with a rule rather than disabling the feature for the entire resource. To do so:

1. In the CDN resource settings (“Rules” tab), create a rule with the URLs or regular expression of files blocked by Basic WAF.
2. Add the Basic WAF option to the rule by clicking **Add option** and turn it off.

<img src="https://assets.gcore.pro/docs/cdn/cdn-resource-options/cdn-security/protect-cdn-resources-with-basic-waf/basic-waf-20.png" alt="disable WAF for specific URLs via rules" width="70%">

If you need more flexible settings, use <a href="https://gcore.com/web-security" target="_blank">Web Application Security</a>. It’s a paid product that allows you to install WAF, protect it from hacking, install protection against bots and DDoS attacks, and define blacklist and whitelists.
Original file line number Diff line number Diff line change
Expand Up @@ -55,10 +55,6 @@ To configure a private origin:

A new page will open. Complete the remaining steps of the manual in the "Origin" section on this page.

In the example below, we use the private bucket ```test-private``` in S3 Gcore storage with the Hostname ```s-ed1.cloud.gcore.lu``` and configure an origin group as follows:

<img src="https://assets.gcore.pro/docs/cdn/cdn-resource-options/general/use-a-private-bucket-as-an-origin/image-3406.png" alt="Origin section" width="80%">

2\. Select the **Specify content origin** option.

3\. Select **AWS signature V4** in the "Type of origin authentication" field.
Expand All @@ -70,11 +66,18 @@ In the example below, we use the private bucket ```test-private``` in S3 Gcore s
- **For Amazon storage**: Access Key ID, Secret access key, and AWS region
- **For Other**: Hostname (there's a bucket at the beginning), Access Key ID, Secret access key, and Region

**Note**: To determine the region of your Gcore S3 storage, use the <a href="https://gcore.com/docs/storage/manage-s3-storage/s3-service-urls-and-default-region-names" target="_blank">S3 service URLs and default region names</a> guide.

More information about where to find the keys can be found in the "<a href="https://gcore.com/docs/storage/create-an-s3-or-sftp-storage" target="_blank">Authentication data</a>" section.

6\. Enter the **Bucket name**.

7\. Continue the CDN resource creation according to the "<a href="https://gcore.com/docs/cdn/getting-started/create-a-cdn-resource/create-a-cdn-resource-for-only-static-files" target="_blank">Create CDN resource for only static files</a>" guide (steps #3–6).
In the example below, we use the private bucket ```test-private``` in S3 Gcore storage with the endpoint (service URL) ```s-ed1.cloud.gcore.lu```. Configure an origin group as follows:

<img src="https://assets.gcore.pro/docs/cdn/cdn-resource-options/general/use-a-private-bucket-as-an-origin/private-bucket-conf.png" alt="Origin section" width="70%">


7\. Continue the CDN resource creation according to the "<a href="https://gcore.com/docs/cdn/getting-started/create-a-cdn-resource/create-a-cdn-resource-for-only-static-files" target="_blank">Create CDN resource for only static files</a>" guide.

8\. Go to the resource settings and open the Host header option in the "HTTP headers" section. Specify the URL of your storage Hostname (the URL depends on your S3 provider) in the following format:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,8 @@ To adjust the headers that are being passed:

<img src="https://assets.gcore.pro/docs/cdn/cdn-resource-options/http-headers/add-or-hide-response-headers/11595288042385.png" alt="Hide only" width="50%">

Headers to hide that can be chosen in the customer portal: *accept, accept-charset, accept-encoding, accept-language, accept-ranges, age, allow, alternates, authorization, cache-control, content-disposition, content-encoding, content-language, content-location, content-md5, content-range, content-version, derived-from, etag, expect, expires, from, host, if-match, if-modified-since, if-none-match, if-range, if-unmodified-since, last-modified, link, location, max-forwards, mime-version, pragma, proxy-authenticate, proxy-authorization, public, range, referer, retry-after, title, te, trailer, transfer-encoding, upgrade, user-agent, vary, via, warning, www-authenticate, keep-alive*.

**Note**: There are some mandatory headers: *connection, content-length, content-type, server, and date*. These cannot be hidden from responses.

4\. Save changes.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: metadata
displayName: Security
displayName: Access
published: true
order: 30
---
Loading

0 comments on commit f955adb

Please sign in to comment.