Skip to content

Getting started tutorial

To setup and start using ShimmerCat to serve a website, first check the below requirements.

Preliminary requirements
  • You should be be familiar with moving around in a Linux environment, including checking and changing file permissions.
  • You should be familiar with curl.
  • You should have an idea of how a website works, including basics of the HTTP Protocol.

Note that you can copy commands to your clipboard, by clicking the icon that appears to the right of the code snippets.

1. Create an authentication token

Use the curl command below to create a user with the username provided in the request data field <your_username>. The token enables you to use ShimmerCat's cloud service for automatic website optimisations.

$ curl -X POST -H 'Content-type: application/json' -d '{"username": "<your_username>", "email": "<your_email>"}'

The command creates an authentication token linked to your username. Write down your username and authentication token as you will use it later.

Three possible approaches

To install and setup ShimmerCat, there are three possible approaches:

Setup with Ansible

Install ShimmerCat by using ansible recipes from your local PC.

  • Recommended if you use Linux with Ubuntu 16.04 or 18.04, or if you install a virtual machine with Linux.

Just follow the instructions in setup with Ansible.

Setup using a Docker container with Ansible

Install docker on your local PC and create a Docker container that runs the ansible recipes to install ShimmerCat.

  • Recommended if you use Windows or macOS.

Just follow the instructions in setup using a Docker container with Ansible.

Setup the programs manually with sc_pack

To manage the servers where ShimmerCat is running, you need to install a "pack" of programs called sc_pack.

  • Recommended if you use Linux with Ubuntu 16.04 or 18.04 and want to do manual setup

Just follow the instructions in setup sc_pack in three steps.