Tyk v2.2 Documentation Components

HomeTyk v2.2 Documentation ComponentsConfigure Tyk Dashboard

Configure Tyk Dashboard

We can set the dashboard up with a helper setup command script, the below will get the dashboard set up for the local instance, make sure to use the actual DNS hostname or the public IP of your instance as the last parameter:

sudo /opt/tyk-dashboard/install/setup.sh --listenport=3000 --redishost=localhost --redisport=6379 --mongo=mongodb:// --tyk_api_hostname=$HOSTNAME --tyk_node_hostname=http://localhost --tyk_node_port=8080 --portal_root=/portal --domain="XXX.XXX.XXX.XXX"

What we have done here is:

  • --listenport=3000 Told Tyk Dashboard (and Portal) to listen on port 3000
  • --redishost=localhost Tyk Dashboard should use the local redis instance
  • --redisport=6379 Tyk Dashboard should use the default port
  • --domain="XXX.XXX.XXX.XXX" Bind the dashboard to the IP or DNS hostname of this instance (required)
  • --mongo=mongodb:// Use the local MongoDB (should always be the same as the gateway)
  • --tyk_api_hostname=$HOSTNAME – Tyk Dashboard has no idea what hostname has been given to Tyk, so we need to tell it, in this instance we are just using the local HOSTNAME env variable, but you could set this to the public-hostname/IP of the instance
  • --tyk_node_hostname=http://localhost – Tyk Dashboard needs to see a Tyk node in order to create new tokens, so we need to tell it where we can find one, in this case, use the one installed locally
  • --tyk_node_port=8080 Tell the dashboard that the Tyk node it should communicate with is on port 8080
  • --portal_root=/portal – We want the portal to be shown on /portal of whichever domain we set for the portal

Start Tyk Dashboard:

    sudo service tyk-dashboard start

Notice how we haven’t actually started the gateway yet, because this is a Pro install, we need to enter a license first.

Enter your dashboard license

Go to http://your-host-name:3000/

And you will see a screen asking for a license, enter it in the section marked “Already have a license?” and click Use this license

That’s it, your Dashboard is now ready to be bootstrapped.

Note: You can bypass this step by adding your license manually to the /var/opt/tyk-dashboard/tyk_analytics.conf file directly in the field marked license.

If all is going well, you will be taken to a log in screen – we’ll get to that soon.

Restart the dashboard and start the gateway process

Because we’ve just entered a license via the UI, we need to make sure that these changes get picked up, so to make sure things run smoothly, we restart the dashboard process (you only ned to do this once) and then start the gateway:

sudo service tyk-dashboard restart 
sudo service tyk-gateway start

Bootstrap the dashboard with an initial user and organisation:

When Tyk Dashboard is created for the first time, it has no initial user base or organisation to add data to, so we need to add this.

The best way to add this data is with the Admin API, to make it really easy we’ve supplied a bootstrap script that will set you up. If you want to customise it, take a look at the file in /opt/tyk-dashboard/install/bootstrap.sh

Pre-requisites for this command

  • This command assumes you are running on a linux shell such as bash
  • This command assumes you have python2.6 or 2.7 installed

To bootstrap your instance:

sudo /opt/tyk-dashboard/install/bootstrap.sh XXX.XXX.XXX.XXX

This command tells the bootstrap script to use the localhost as the base for the API calls, you can run the bootstrap remotely and change the first command line parameter to the DNS hostname of your instance.

You will now be able to log into and test your Tyk instance with the values given to you by the bootstrap script.

Was this article helpful to you? Yes No