Skip to content
hammy275 edited this page Nov 14, 2023 · 4 revisions

comp-status consists of 3 parts, central-server, the server that processes all computer resource information and distributes it, servers, the computers that send their resource information to central-server, and clients that access the data.

central-server Setup:

NOTE: This should be done before the setup of either server or client

  1. Download the repository using git clone https://github.com/hammy275/comp-status inside the folder where you want to store the central-server files
  2. Port forward the port you would like to host the server on.
  3. If using Let's Encrypt, follow the instructions using Certbot to get a certificate.
  4. Install Node.js, enter the comp-status/client/react-ui directory, and run npm install followed by npm run build.
  5. Run run_server.py if using a Let's Encrypt certificate or app.py if you're not.
  6. Follow the instructions printed in the console to use the web-based first time setup.

server Setup:

  1. Download the repository using git clone https://github.com/hammy275/comp-status inside the folder where you want to store the server files
  2. Run main.py inside of comp-status/server and follow the instructions
  3. Configure main.py to run from its directory at boot through whatever means your operating system provides

client Setup:

  1. Visit the URL of the central server (including the port if not using port 80) in your browser
  2. Enter the IP address and port of the central server, along with a registered username and password.
Clone this wiki locally