Step One - Clone the Repo

Clone the repo above to a location on your machine.

Step Two - Edit your hosts file

You need to add the following to your Windows hosts file:

127.0.0.1 www.tyk-portal-test.com
127.0.0.1 www.tyk-test.com

Step Three - Add your Developer License

You should have received your free developer license via email. Copy the license key in the following location from your \confs\tyk_analytics.conf file:

Step Four - Run the Docker Compose File

From PowerShell, run the following command from your installation folder:

docker-compose up

This will will download and setup the five Docker containers. This may take some time and will display all output.

Step Five - Test the Tyk Dashboard URL

Go to:

127.0.0.1:3000

You should get to the Tyk Dashboard Setup screen:

For a password, we recommend a combination of alphanumeric characters, with both upper and lower case letters.

Click Bootstrap to save the details.

You can now log in to the Tyk Dashboard from 127.0.0.1:3000 , using the username and password created in the Dashboard Setup screen.

Step Seven - Set up a Portal Catalog

This creates a portal catalog for your developer portal. For the Authorization Header, the Value you need to enter is the access_key value from the create user request. In the body add the org_id value created in Step One .

Sample Request

{ "org_id": "5d07b4b0661ea80001b3d40d" }

Sample Response

Step Eight - Create your default Portal Pages

This creates the default home page for your developer portal. For the Authorization Header, the Value you need to enter is the access_key value from the create user request.

Sample Request

Sample Response

Step Nine - Setup the Portal URL

This creates the developer portal URL. For the Authorization Header, the Value you need to enter is the secret value from your /confs/tyk_analytics.conf .

Sample Request

{SECRET_VALUE}

Sample Response