Getting Started

Prerequisites

Install nodejs by downloading it from nodejs.org. (https://nodejs.org/en/download/). After installing nodejs, run following commands:

$ node -v
$ npm -v

Note: Please make sure node version is above 5.10.1.

Installation

There are 3 different ways you can install wizzy:

  1. Using docker. Pull the latest docker image wizzy-docker

    $ docker run --rm -it grafana-wizzy/wizzy wizzy version
    
  2. Using npm (Stable release):

    $ npm install -g wizzy
    

    Node: - Use sudo if needed or permission was denied

  3. Using Github (from source):

    $ git clone https://github.com/grafana-wizzy/wizzy.git
    $ cd wizzy
    $ npm install
    $ npm link
    

Initialization

Once wizzy is installed, it needs to be initialized to serve you with the awesome commands it has. These are the most important steps to setup wizzy.

  1. Check wizzy version

    $ wizzy version
    
  2. Create a local directory for storing Grafana entities.

    $ mkdir DIRECTORY_NAME
    $ cd DIRECTORY_NAME
    

    For example:

    $ mkdir grafana-entities
    $ cd grafana-entities
    
  3. Best practice - Initialize git repo in your grafana-entities directory. Its an optional step and should be used if you need version control for your Grafana entities such as dashboards, datasources, etc.

    $ git init
    
  4. Initialize wizzy

    $ wizzy init
    
  5. Connect to Grafana by setting Grafana properties in wizzy’s config. Please set your Grafana username and password if anonymous access to Grafana is disabled.

    $ wizzy set grafana url GRAFANA_URL
    $ wizzy set grafana username YOUR_USERNAME
    $ wizzy set grafana password YOUR_PASSWORD
    

    For example:

    $ wizzy set grafana url http://localhost:3000
    $ wizzy set grafana username admin
    $ wizzy set grafana password admin
    

    Note: Add conf directory to .gitignore to avoid checking in your credentials into git repo.

  6. Test wizzy setup

    $ wizzy status
    

You are ready to use wizzy. Check out examples!