Skip to content

Commit

Permalink
[DX-1437] customise --> customize (PR 1) (#5059)
Browse files Browse the repository at this point in the history
customise 1
  • Loading branch information
Roeegg2 authored Jul 11, 2024
1 parent 2c63502 commit 6f22538
Show file tree
Hide file tree
Showing 38 changed files with 67 additions and 67 deletions.
4 changes: 2 additions & 2 deletions tyk-docs/content/advanced-configuration/transform-traffic.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
Title: Request and response middleware
tags: ["middleware", "API request", "API response", "request processing", "response processing"]
description: "An overview of Tyk's customisable request and response processing chain"
description: "An overview of Tyk's customizable request and response processing chain"
aliases:
- /transform-traffic/endpoint-designer/
---
Expand All @@ -10,7 +10,7 @@ When you configure an API on Tyk, the Gateway will proxy all requests received a

Within that chain are a highly configurable set of optional middleware that can, on a per-endpint basis:
- apply processing to [API requests](#middleware-applied-to-the-api-request) before they are proxied to the upstream service
- apply customisation to the [API response](#middleware-applied-to-the-api-response) prior to it being proxied back to the client
- apply customization to the [API response](#middleware-applied-to-the-api-response) prior to it being proxied back to the client

Tyk also supports a powerful custom plugin feature that enables you to add custom processing at different stages in the processing chains. For more details on custom plugins please see the [dedicated guide]({{< ref "plugins" >}}).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ There are related [Request Header Transform]({{< ref "transform-traffic/request-

## When to use response header transformation

#### Customising responses for specific clients
#### Customizing responses for specific clients

A frequent use case for response header transformation is when a client requires specific headers for their application to function correctly. For example, a client may require a specific header to indicate the status of a request or to provide additional information about the response.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: "Using middleware with Tyk OAS APIs"

### Introduction

Tyk OAS APIs have access to an increasing range of Tyk middleware that you can configure to customise the handling of API requests and responses. In this guide we will show you how to enable some of these features in your Tyk OAS APIs.
Tyk OAS APIs have access to an increasing range of Tyk middleware that you can configure to customize the handling of API requests and responses. In this guide we will show you how to enable some of these features in your Tyk OAS APIs.

{{< note success >}}
**Note**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ aliases:

## Set up an Event Webhook with an API Definition

In order to add extensibility and interoperability to Tyk, a new webhook event handler has been added. This allows a fixed payload (which can be customised) to be delivered to any open endpoint.
In order to add extensibility and interoperability to Tyk, a new webhook event handler has been added. This allows a fixed payload (which can be customized) to be delivered to any open endpoint.

The webhook handler allows the configuration of the method, body, header values, and target URL and makes use of Go templates to expose the event metadata.

Expand Down
12 changes: 6 additions & 6 deletions tyk-docs/content/configure/outbound-email-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,16 +101,16 @@ If `SMTPUsername` or `SMTPPassword` is omitted, Tyk assumes that authentication
"SecretAccessKey": "KEY"
},
```
### Customise your Welcome Emails
### Customize your Welcome Emails

You can customise the welcome email that a developer recieves when they signup to your portal. You can use images and other HTML formatted content. The following video walks you through the process.
You can customize the welcome email that a developer recieves when they signup to your portal. You can use images and other HTML formatted content. The following video walks you through the process.

{{< youtube XNyKRAlTDVs >}}


1. Select **Settings** from your **Dashboard** > **Portal Management**
2. You can change the from email address and the from email name for your welcome emails.
3. To use customised email content, select **Enable custom welcome email**.
3. To use customized email content, select **Enable custom welcome email**.
4. You can then add the following custom content:
* Email Subject
* Email Body content
Expand All @@ -123,14 +123,14 @@ You can customise the welcome email that a developer recieves when they signup t
6. Click **Save** at the top of the Portal Settings screen.


### Customise your Key Approval Emails
### Customize your Key Approval Emails

#### Editing the Email Body

1. Select **Settings** from your **Dashboard** > **Portal Management**
2. From the "API Key approval email" section, select "Enable custom approval email", and edit the API Key email body.

{{< img src="/img/2.10/key_approval_email_config.png" alt="Email-Customisation" >}}
{{< img src="/img/2.10/key_approval_email_config.png" alt="Email-Customization" >}}

#### Add an image or logo to the Key Approval Email

Expand All @@ -145,7 +145,7 @@ You can customise the welcome email that a developer recieves when they signup t
The `LINK TO IMAGE` must be a publicly hosted resource.
{{< /note >}}

In an Self-Managed installation you have full access to the HTML template, allowing you further customisation.
In an Self-Managed installation you have full access to the HTML template, allowing you further customization.

#### Portal Manager Email Settings

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ weight: 0

Use case: What if your developer portal is not exactly what I need?

Sometimes our Tyk Gateway won't suit your exact needs. Maybe you want to combine multiple Tyk installations under the same portal, or use your existing portal and add our functionality, or maybe customise the portal's branding per organisation?
Sometimes our Tyk Gateway won't suit your exact needs. Maybe you want to combine multiple Tyk installations under the same portal, or use your existing portal and add our functionality, or maybe customize the portal's branding per organisation?

We have the ability to configure the portal to suit your needs. For details, including a video tutorial, see [Create a Custom Developer Portal]({{< ref "tyk-developer-portal/tyk-portal-classic/customise/custom-developer-portal" >}}).
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ The Multi-Cloud Redis container is ephemeral, it isn't configured for persistenc

If using Redis with Multi-Cloud we strongly recommend using an external Redis database.

There are no settings for Redis available via environment variable, you would need to mount a new `redis.conf` into the container to customise the configuration, but again, we don't recommend it.
There are no settings for Redis available via environment variable, you would need to mount a new `redis.conf` into the container to customize the configuration, but again, we don't recommend it.
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ In any system, a task or operation takes a certain period of time to complete. W

Tyk's Enforced Timeout middleware can be used to apply a maximum time that the Gateway will wait for a response before it terminates (or times out) the request. If the timeout expires, then Tyk will notify the client with an `HTTP 504 Gateway Timeout` error.

This feature helps to maintain system stability and prevents unresponsive or long-running tasks from affecting the overall performance of the system. The enforced timeout can be customised and configured to suit specific requirements, providing control over resource allocation and ensuring optimal system functionality.
This feature helps to maintain system stability and prevents unresponsive or long-running tasks from affecting the overall performance of the system. The enforced timeout can be customized and configured to suit specific requirements, providing control over resource allocation and ensuring optimal system functionality.

## When to use an enforced timeout

Expand Down
2 changes: 1 addition & 1 deletion tyk-docs/content/plugins/supported-languages.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ The JavaScript Virtual Machine provides pluggable middleware that can modify a r
* **TCP Access**: The JSVM has no socket access so working with DB drivers and directly with Redis is not possible.

### Rich Plugins
Rich Plugins can provide replacements for existing middleware functions (as opposed to augmentation) and are designed to be full-blown, optimized, highly capable services. They enable a full customised architecture to be built that integrates with a user's infrastructure.
Rich Plugins can provide replacements for existing middleware functions (as opposed to augmentation) and are designed to be full-blown, optimized, highly capable services. They enable a full customized architecture to be built that integrates with a user's infrastructure.

Rich Plugins bring about the following improvements:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ JavaScript functions are available globally in the same namespace. So, if you in

The JavaScript Virtual Machine (JSVM) provided in the Gateway is a traditional ECMAScript5 compatible environment.

Before you can use JavaScript customisation in any component you will need to enable the JSVM.
Before you can use JavaScript customization in any component you will need to enable the JSVM.

You do this by setting `enable_jsvm` to `true` in your `tyk.conf` [file]({{< ref "tyk-oss-gateway/configuration#enable_jsvm" >}}).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ aliases:
- /plugins/javascript-middleware/middleware-scripting-guide
---

Tyk's JavaScript Virtual Machine (JSVM) provides a serverless compute function that allows for the execution of custom logic directly within the gateway itself. This can be accessed from [multiple locations]({{< ref "plugins/supported-languages/javascript-middleware" >}}) in the API processing chain and allows significant customisation and optimization of your request handling.
Tyk's JavaScript Virtual Machine (JSVM) provides a serverless compute function that allows for the execution of custom logic directly within the gateway itself. This can be accessed from [multiple locations]({{< ref "plugins/supported-languages/javascript-middleware" >}}) in the API processing chain and allows significant customization and optimization of your request handling.

In this guide we will cover the features and resources available to you when creating custom functions, highlighting where there are limitations for the different middleware stages.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: "Create Custom Authentication Plugin With Python"

In the realm of API security, HMAC-signed authentication serves as a foundational concept. In this developer-focused blog post, we'll use HMAC-signed authentication as the basis for learning how to write gRPC custom authentication plugins with Tyk Gateway. Why learn how to write Custom Authentication Plugins?

- **Foundational knowledge**: Writing custom authentication plugins provides foundational knowledge of Tyk's extensibility and customisation capabilities.
- **Foundational knowledge**: Writing custom authentication plugins provides foundational knowledge of Tyk's extensibility and customization capabilities.
- **Practical experience**: Gain hands-on experience in implementing custom authentication logic tailored to specific use cases, starting with HMAC-signed authentication.
- **Enhanced control**: Exercise greater control over authentication flows and response handling, empowering developers to implement advanced authentication mechanisms beyond built-in features.

Expand Down Expand Up @@ -655,7 +655,7 @@ While Tyk Gateway already supports HMAC-signed authentication out of the box, th
It's important to note that the authentication mechanism implemented in this guide solely verifies the HMAC signature's validity and does not include access control checks against specific API resources. Developers should enhance this implementation by integrating access control logic to ensure authenticated requests have appropriate access permissions.
By mastering the techniques outlined in this guide, developers are better equipped to address complex authentication challenges and build robust API security architectures using Tyk Gateway's extensibility features. This guide serves as a foundation for further exploration and experimentation with custom authentication plugins, empowering developers to innovate and customise API authentication solutions according to their unique requirements.
By mastering the techniques outlined in this guide, developers are better equipped to address complex authentication challenges and build robust API security architectures using Tyk Gateway's extensibility features. This guide serves as a foundation for further exploration and experimentation with custom authentication plugins, empowering developers to innovate and customize API authentication solutions according to their unique requirements.
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ To generate the Protocol Buffers bindings we use the Gradle build task:
gradle build
```

If you need to customise any setting related to the bindings generation step, check the `build.gradle` file.
If you need to customize any setting related to the bindings generation step, check the `build.gradle` file.

### Implement Server

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ This document serves as a developer's guide for understanding the key concepts a

This comprehensive guide covers essential tasks, including:

1. **Developing a gRPC Server:** Learn how to develop a gRPC server using [Tyk protocol buffers](https://github.com/TykTechnologies/tyk/tree/master/coprocess/proto). The gRPC server facilitates the execution of Tyk plugins, which offer custom middleware for various phases of the API request lifecycle. By integrating these plugins, developers can enable Tyk Gateway with enhanced control and flexibility in managing API requests, allowing for fine-grained customisation and tailored processing at each stage of the request lifecycle.
1. **Developing a gRPC Server:** Learn how to develop a gRPC server using [Tyk protocol buffers](https://github.com/TykTechnologies/tyk/tree/master/coprocess/proto). The gRPC server facilitates the execution of Tyk plugins, which offer custom middleware for various phases of the API request lifecycle. By integrating these plugins, developers can enable Tyk Gateway with enhanced control and flexibility in managing API requests, allowing for fine-grained customization and tailored processing at each stage of the request lifecycle.

2. **Configuring Tyk Gateway:** Set up Tyk Gateway to communicate with your gRPC Server and, optionally, an external secured web server hosting the gRPC plugin bundle for API configurations. Configure Tyk Gateway to fetch the bundle configured for an API from the web server, enabling seamless integration with gRPC plugins. Specify connection settings for streamlined integration.

3. **API Configuration:** Customise API settings within Tyk Gateway to configure gRPC plugin utilization. Define plugin hooks directly within the API Definition or remotely via an external web server for seamless request orchestration. Tyk plugins provide custom middleware for different phases of the API request lifecycle, enhancing control and flexibility.
3. **API Configuration:** Customize API settings within Tyk Gateway to configure gRPC plugin utilization. Define plugin hooks directly within the API Definition or remotely via an external web server for seamless request orchestration. Tyk plugins provide custom middleware for different phases of the API request lifecycle, enhancing control and flexibility.

4. **API Testing:** Test that Tyk Gateway integrates with your gRPC server for the plugins configured for your API.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Additionally, all settings for the Portal are configured using an env-file.
{{< warning success >}}
**Note**

This document is just an example. Customise all fields, including the username, password, root password, database name and more.
This document is just an example. Customize all fields, including the username, password, root password, database name and more.
{{< /warning >}}


Expand Down Expand Up @@ -64,7 +64,7 @@ Once you have completed this step, you are ready to launch the portal applicatio

### Create a docker-compose file and launch the stack
#### Create a docker-compose file
Before launching the portal using docker-compose, you will need to create a `docker-compose.yaml` file. An example of the portal's docker-compose file is provided below, which you can use as a starting point and further customise to meet your specific requirements.
Before launching the portal using docker-compose, you will need to create a `docker-compose.yaml` file. An example of the portal's docker-compose file is provided below, which you can use as a starting point and further customize to meet your specific requirements.

Ensure that you replace `<tag>` with the specific version of the portal you intend to launch before executing the command, e.g. `tykio/portal:v1.7` for the portal v1.7. You can browse all available versions on [Docker Hub](https://hub.docker.com/r/tykio/portal/tags) and in the [release notes section]({{< ref "product-stack/tyk-enterprise-developer-portal/release-notes/portal-1.7.0.md" >}}).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Additionally, all settings for the Portal are configured using an env-file.
{{< warning success >}}
**Note**

This document is just an example. Customise all fields, including the username, password, root password, database name and more.
This document is just an example. Customize all fields, including the username, password, root password, database name and more.

Be sure to update the connection DSN in the env-file accordingly.
{{< /warning >}}
Expand Down Expand Up @@ -71,7 +71,7 @@ postgres:10-alpine
**Note**

{{< warning success >}}
The above PostgreSQL configuration is an example. You can customise deployment of your PostgreSQL instance. Please refer to [the PostgreSQL documentation](https://www.postgresql.org/docs/current/installation.html) for further guidance.
The above PostgreSQL configuration is an example. You can customize deployment of your PostgreSQL instance. Please refer to [the PostgreSQL documentation](https://www.postgresql.org/docs/current/installation.html) for further guidance.
{{< /warning >}}

#### Create an environment variables file
Expand Down Expand Up @@ -154,7 +154,7 @@ mysql:5.7 --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci -
{{< warning success >}}
**Note**

The above MySQL configuration is an example. You can customise deployment of your MySQL instance.
The above MySQL configuration is an example. You can customize deployment of your MySQL instance.

Please refer to the [MySQL documentation](https://dev.mysql.com/doc/refman/5.7/en/charset-applications.html) for further guidance.
{{< /warning >}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This guide provides a step-by-step recipe for launching the Tyk Enterprise Devel
{{< warning success >}}
**Note**

This document is just an example. Customise all fields, including the username, password, root password, database name and more.
This document is just an example. Customize all fields, including the username, password, root password, database name and more.

Be sure to update the connection DSN in the env-file accordingly.
{{< /warning >}}
Expand Down Expand Up @@ -51,7 +51,7 @@ sudo rpm -i portal-1.7.0-1.x86_64.rpm
Before starting the portal service, you need to configure the portal. Once the rpm package has been installed, the portal configuration file will be located in `/opt/portal/portal.conf`.
Initially, the config file is filled with the default values. The minimal configuration change to start the portal is to add the `LicenseKey` property to the config file.
The below sample configuration will start the portal on portal 3001 with SQLite as a database, no TLS enabled, and all CMS assets (images, theme files, etc.) are stored in the filesystem.
You can, however, customise the provided example and make more suitable for your need using the [configuration]({{< ref "product-stack/tyk-enterprise-developer-portal/deploy/configuration" >}}) reference.
You can, however, customize the provided example and make more suitable for your need using the [configuration]({{< ref "product-stack/tyk-enterprise-developer-portal/deploy/configuration" >}}) reference.
```json
{
"HostPort": 3001,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ tags: ["Tyk Developer Portal","Enterprise Portal","Webhooks","Customization","In
description: "Configure webhooks to react on events happening in the portal"
menu:
main:
parent: "Customise the portal"
parent: "Customize the portal"
weight: 3
---

Expand Down
Loading

0 comments on commit 6f22538

Please sign in to comment.