Skip to main content

Documentation Index

Fetch the complete documentation index at: https://tyk.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

These are some common settings that you need before proceeding with other parts of our tutorials.

​
Tyk Config

​
Path to Tyk API Definitions configurations directory

You may need to explicitly define the path in your Tyk config to the directory where you will add the API definitions for Tyk to serve. 
...
"app_path": "/opt/tyk-gateway/apps",
...

​
Path to Policies file

You need to explicitly set the path to your Policies JSON file in your Tyk config. 
...
  "policies": {
    "policy_source": "file",
    "policy_record_name": "policies/policies.json"
  },
...
Some config options for the Community Edition are not compatible with the Dashboard version, which requires a license. So, remove any section in your Tyk config which starts with: 
...
"db_app_conf_options" {
  ...
},
...

​
Hot reload is critical in Tyk CE

Each time you add an API definition in Tyk CE, you need to make a hot reload API call as follows: 
curl -H "x-tyk-authorization: {your-secret}" -s https://{your-tyk-host}:{port}/tyk/reload/group | python -mjson.tool