Techboard

Techboard is a service status and incident report all-in-one web server. Visitors will be shown a web page containing the status of all services and recent incidents. Administrators will be able to sign-in to the admin panel where they will have the tools to customize and configure the website.

Features

• Services
• Incidents
• Scheduled Maintenance
• Subscribers and notifications
• Automations
  • Automated webscraping service status and incidents from external websites.
• Home page customization
• Logging

Getting started

Before installing Techboard, be sure you have both Docker and Docker compose installed.

Download the latest Techboard release or clone this repository with

git clone https://github.com/ninthworld/techboard.git

Install the project using install.bat for Windows or install.sh for Linux and wait for the script to complete.

Rename .env.sample to .env and enter the information for the following:

• SESSION_SECRET
  • Any random string of numbers and character
• PASSPORT_GOOGLE_ID and PASSPORT_GOOGLE_SECRET
  • Goto https://console.developers.google.com/
  • Click credentials > Create credentials > Oauth client ID.
  • Choose Web application and input a name.
  • Click Add URI under Authorized redirect URIs and input the website url.
  • Finally, click create and copy the Client ID and Client Secret to the .env.
• RECAPTCHA_SITE and RECAPTCHA_SECRET
  • Goto https://www.google.com/recaptcha/admin
  • Click the + at the top-right, input a name, and select reCAPTCHA v3.
  • Under domains, input the website's URL and click the + to the left.
  • Accept the terms of service and click Save.
  • Copy the Site Key and Secret Key to the .env.
• SITE_URL and SITE_HTTPS

Start and stop the webserver with the following commands:

# Start the webserver
npm run start

# Stop the webserver
npm run stop

In order to get into the admin panel for the first time, add your google email as an administrator with the following command AFTER starting the webserver.

node tools/add-user.js [YOUR_NAME] [YOUR_EMAIL]

The webserver will be running on http://localhost:3000/

License

Code released under the MIT License