​
1. Clone the project

From github clone or fork the project on your local machine.

​
2. Change user Credentials

Go to docker-compose.yaml file and change this two fields to create your admin user

  # Credentials to login in NO_AUTH mode
  NUXT_NOAUTH_USER_EMAIL: 'default@user.com'
  NUXT_NOAUTH_USER_PASS: "litlyx123"

​
3. Run A Docker Container

Run the following command in the terminal.

This command automatically pulls all the necessary images for Litlyx.

docker
docker-compose up

​
4.a Forward data to your local instance with script tag

Add data-host, add data-port, add data-secure and set up at true if is https, false if is http. On the server, you need to open port 3000 for the dashboard instance and port 3099 (default) for forwarding visits and events.

<script defer data-project="project_id_here" 
              data-host="your-host-name" 
              data-port="your-producer-port" 
              data-secure="false"
        src="https://cdn.jsdelivr.net/gh/litlyx/litlyx-js/browser/litlyx.js">
</script>
The Producer service collects data and adds it to a queue for storage. By default, it uses port 3099, but you can choose a different port if needed.

​
4.b Forward data to your local instance using npm

Add data-host, add data-port, add data-secure and set up at true if is https, false if is http. On the server, you need to open port 3000 for the dashboard instance and port 3099 (default) for forwarding visits and events.

Lit.init('project_id', {
  server: {
    host: "your-host-name",
    port: 3099,
    secure: true
  }
})
The Producer service collects data and adds it to a queue for storage. By default, it uses port 3099, but you can choose a different port if needed.

​
5. Now is your turn.

Now you are up to go. You can use your own instance of Litlyx. Track analytics, easy way.