Skip to content

Installation #20

Description

@Jayx239

PiDash Install

Requirements

In order to run PiDash you must have the following installed:

  1. MySQL.
    • PiDash has been tested with MySQL 5.7.x as well as MySQL 8.
    • Note: If using MySQL > 5.x you must enable 5.x legacy authentication to use with PiDash.
  2. NodeJS
    • Currently testing with node 10.16.0 and 10.13.0. Older versions should work though.
  3. Optional: Python - to use the configurator tool to make server/sql config files.
    • Alternatively you can modify the server.config and sql.config templates below and save them in the node/config directory.

Install

  1. Clone Repository

    git clone https://github.com/Jayx239/PiDash.git
  2. Navigate to project root directory

    cd ./PiDash/node/
  3. Build project

    make all
  4. Create configuration files by running configurator

    • Requires python, tested for v2.x.x or v3.x.x
    make configurator
    • File Formats

    sql.config -

    {
        "host": "<Db_Host_IP(ie:localhost)(optional)>",
        "password": "<database_user_password>",
        "user": "<database_username>",
        "database": "<database_name>"
    }

    server.config -

    {
        "ip":"<host_address(optional)>",
        "port":"<port_no>"
    }
  5. Create Database

    #Navigate to config directory
    cd config/
    #Run config file
    node ConfigureSql.js
  6. Create default admin

Running PiDash

In the project node directory run:

node index.js

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    InstallationInstructions on how to install PiDash

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions